[PATCH v2 0/2] More object-related docstrings

[Michael Haggerty <mhagger@alum.mit.edu>]

This patch series applies on top of mh/replace-refs-variable-rename,
simply because one of the comments refers to the global variable
check_replace_refs by its new name.

This is a re-roll of patches 1/6 and 6/6 of the series
"mh/object-code-cleanup" that I submitted earlier [1].  Patches 2-5 of
that series have already been queued.

The first patch emphasizes that do_lookup_replace_object() is only
meant for internal use, and moves the real docstring for that function
from the header file to the implementation file.

The second patch changes the docstring for hash_obj() to mention that
its return value is not consistent across architectures, and adds a
comment within the function explaining some points about the
implementation that were suggested in the discussion about v1.

Thanks to Junio, Christian, Nicolas, Jakub, and Jonathan for their
comments on v1.

Michael

[1] http://thread.gmane.org/gmane.comp.version-control.git/242469

Michael Haggerty (2):
  Add docstrings for lookup_replace_object() and
    do_lookup_replace_object()
  Document some functions defined in object.c

 cache.h          | 13 +++++++++++++
 object.c         | 29 ++++++++++++++++++++++++++++-
 object.h         |  7 +++++++
 replace_object.c |  7 +++++++
 4 files changed, 55 insertions(+), 1 deletion(-)

-- 
1.8.5.3