git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 00/14] Tidying up references code

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 17, 2011, 19:12 UTC
Message-ID
<7v1uubmnye.fsf@alter.siamese.dyndns.org>
In-Reply-To
<1318837163-27112-1-git-send-email-mhagger@alum.mit.edu>
mhagger@alum.mit.edu writes:
> From: Michael Haggerty <mhagger@alum.mit.edu>
>
> Patch series re-rolled against v4 of "Provide API to invalidate refs
> cache"...
Thanks; queued (but not pushed out yet).
> BTW, whenever I add comments to existing code, it is just an attempt
> to record information that I have inferred from reverse-engineering.

Thanks again. I often find me scratching head while reading other people's code, long after I reviewed (or read other's reviews) and accepted their patches. It often is not the lack of review that caused undercommented code to get in my tree. During the review process, the issue the code is trying to solve is so fresh in everybody's mind, that certain things do not need to be explained to be understood. But that kind of memory eventually fades and only the code remains.

It is a rather unfortunate result of the human nature that the next person who touches that code is in the best position to find out what aspect of the code is hard to understand and deserves comment.

Previous: mhagger@alum.mit.edu
Message 16 of 16 in “Tidying up references code”
  1. 00/14 Tidying up references codemhagger@alum.mit.edu, Oct 17, 2011
  2. 01/14 cache.h: add comments for git_path() and git_path_submodule()mhagger@alum.mit.edu, Oct 17, 2011
  3. 02/14 struct ref_entry: document name membermhagger@alum.mit.edu, Oct 17, 2011
  4. 03/14 refs: rename "refname" variablesmhagger@alum.mit.edu, Oct 17, 2011
  5. 04/14 refs: rename parameters result -> sha1mhagger@alum.mit.edu, Oct 17, 2011
  6. 05/14 clear_ref_array(): rename from free_ref_array()mhagger@alum.mit.edu, Oct 17, 2011
  7. 06/14 is_refname_available(): remove the "quiet" argumentmhagger@alum.mit.edu, Oct 17, 2011
  8. 07/14 parse_ref_line(): add docstringmhagger@alum.mit.edu, Oct 17, 2011
  9. 08/14 add_ref(): add docstringmhagger@alum.mit.edu, Oct 17, 2011
  10. 09/14 is_dup_ref(): extract function from sort_ref_array()mhagger@alum.mit.edu, Oct 17, 2011
  11. 10/14 refs: change signatures of get_packed_refs() and get_loose_refs()mhagger@alum.mit.edu, Oct 17, 2011
  12. 11/14 get_ref_dir(): change signaturemhagger@alum.mit.edu, Oct 17, 2011
  13. 12/14 resolve_gitlink_ref(): improve docstringmhagger@alum.mit.edu, Oct 17, 2011
  14. 13/14 Pass a (ref_cache *) to the resolve_gitlink_*() helper functionsmhagger@alum.mit.edu, Oct 17, 2011
  15. 14/14 resolve_gitlink_ref_recursive(): change to work with struct ref_cachemhagger@alum.mit.edu, Oct 17, 2011
  16. Junio C HamanoOct 17, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.