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

[PATCH 0/6] Add a bunch of docstrings and make a few minor cleanups

From
Michael Haggerty <mhagger@alum.mit.edu>
Date
Feb 21, 2014, 16:32 UTC
Message-ID
<1393000327-11402-1-git-send-email-mhagger@alum.mit.edu>

I was reading around in the neighborhood of fsck, objects, and packs and I had the familiar and discouraging experience of having to read code all the way up and down the callstack to understand *anything*. Please let's all make more of an effort to document functions, especially things that are not obvious from the name and signature, like who owns the memory that is being referred to.

This is my attempt to document a number of the functions that I was looking at based on what I inferred from my reading. It is also a selfish trick to get other people to double-check my understanding.

I also fixed up a couple of small things that I noticed along the way: "refactoring for understanding".

Michael Haggerty (6):
  Add docstrings for lookup_replace_object() and
    do_lookup_replace_object()
  replace_object: use struct members instead of an array
  find_pack_entry(): document last_found_pack
  sha1_file_name(): declare to return a const string
  Document a bunch of functions defined in sha1_file.c
  Document some functions defined in object.c
 cache.h          | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++---
 http.c           |  2 +-
 object.c         | 23 +++++++++++++++-
 object.h         |  7 +++++
 replace_object.c | 17 ++++++++----
 sha1_file.c      | 66 ++++++++++++++++++++++++--------------------
 6 files changed, 157 insertions(+), 42 deletions(-)
-- 
1.8.5.3
Next: Michael Haggerty
Message 1 of 23 in “Add a bunch of docstrings and make a few minor cleanups”
  1. 0/6 Add a bunch of docstrings and make a few minor cleanupsMichael Haggerty, Feb 21, 2014
  2. 1/6 Add docstrings for lookup_replace_object() and do_lookup_replace_object()Michael Haggerty, Feb 21, 2014
  3. Junio C HamanoFeb 21, 2014
  4. Michael HaggertyFeb 24, 2014
  5. Christian CouderFeb 24, 2014
  6. Michael HaggertyFeb 24, 2014
  7. Junio C HamanoFeb 24, 2014
  8. 2/6 replace_object: use struct members instead of an arrayMichael Haggerty, Feb 21, 2014
  9. Junio C HamanoFeb 21, 2014
  10. 3/6 find_pack_entry(): document last_found_packMichael Haggerty, Feb 21, 2014
  11. Nicolas PitreFeb 21, 2014
  12. 4/6 sha1_file_name(): declare to return a const stringMichael Haggerty, Feb 21, 2014
  13. 5/6 Document a bunch of functions defined in sha1_file.cMichael Haggerty, Feb 21, 2014
  14. Nicolas PitreFeb 21, 2014
  15. Jakub NarębskiFeb 24, 2014
  16. Michael HaggertyFeb 24, 2014
  17. Jonathan NiederFeb 24, 2014
  18. Michael HaggertyFeb 25, 2014
  19. 6/6 Document some functions defined in object.cMichael Haggerty, Feb 21, 2014
  20. Nicolas PitreFeb 21, 2014
  21. Michael HaggertyFeb 24, 2014
  22. Junio C HamanoFeb 24, 2014
  23. Junio C HamanoFeb 24, 2014

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.