From 8b361551900be9bedd946386362f2d0e2a506845 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Fri, 10 Aug 2018 19:11:14 -0400 Subject: 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 Signed-off-by: Junio C Hamano --- cache.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'cache.h') diff --git a/cache.h b/cache.h index 9e02fc494e..f438540f9b 100644 --- a/cache.h +++ b/cache.h @@ -1636,9 +1636,11 @@ enum for_each_object_flags { }; /* - * Iterate over loose objects in both the local - * repository and any alternates repositories (unless the - * LOCAL_ONLY flag is set). + * Iterate over all accessible loose objects without respect to + * reachability. By default, this includes both local and alternate objects. + * The order in which objects are visited is unspecified. + * + * Any flags specific to packs are ignored. */ int for_each_loose_object(each_loose_object_fn, void *, enum for_each_object_flags flags); -- cgit v1.2.3