diff options
| author |  Jeff King <peff@peff.net> | 2018-08-10 19:11:14 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2018-08-13 13:48:26 -0700 |
| commit | 8b361551900be9bedd946386362f2d0e2a506845 (patch) | |
| tree | 466544783d5190b6804d6a2da8bff1bceafefa04 /packfile.h | |
| parent | for_each_*_object: take flag arguments as enum (diff) | |
| download | tgif-8b361551900be9bedd946386362f2d0e2a506845.tar.xz | |
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>
Diffstat (limited to 'packfile.h')
| -rw-r--r-- | packfile.h | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/packfile.h b/packfile.h index 9861728514..c86a8c2716 100644 --- a/packfile.h +++ b/packfile.h @@ -149,10 +149,14 @@ extern int has_object_pack(const struct object_id *oid); extern int has_pack_index(const unsigned char *sha1); /* - * Iterate over packed objects in both the local - * repository and any alternates repositories (unless the - * FOR_EACH_OBJECT_LOCAL_ONLY flag is set). See cache.h for the complete list - * of flags. + * Iterate over all accessible packed objects without respect to reachability. + * By default, this includes both local and alternate packs. + * + * Note that some objects may appear twice if they are found in multiple packs. + * Each pack is visited in an unspecified order. Objects within a pack are + * visited in pack-idx order (i.e., sorted by oid). + * + * The list of flags can be found in cache.h. */ typedef int each_packed_object_fn(const struct object_id *oid, struct packed_git *pack, |