for_each_*_object: give more comprehensive docstrings
commit8b361551900be9bedd946386362f2d0e2a506845
authorJeff King <peff@peff.net>
Fri, 10 Aug 2018 23:11:14 +0000 (10 19:11 -0400)
committerJunio C Hamano <gitster@pobox.com>
Mon, 13 Aug 2018 20:48:26 +0000 (13 13:48 -0700)
tree466544783d5190b6804d6a2da8bff1bceafefa04
parenta7ff6f5a0f310406aa4973e8d7ec25815554bcb5
for_each_*_object: give more comprehensive docstrings

We already mention the local/alternate behavior of these
functions, but we can help clarify a few other behaviors:

 - there's no need to mention LOCAL_ONLY specifically, since
   we already reference the flags by type (and as we add
   more flags, we don't want to have to mention each)

 - clarify that reachability doesn't matter here; this is
   all accessible objects

 - what ordering/uniqueness guarantees we give

 - how pack-specific flags are handled for the loose case

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
cache.h
packfile.h