summaryrefslogtreecommitdiff
path: root/pack-write.c
diff options
context:
space:
mode:
authorJohannes Berg <johannes@sipsolutions.net>2020-07-22 23:40:31 +0200
committerJunio C Hamano <gitster@pobox.com>2020-07-22 15:38:22 -0700
commite2bfa50ac3bfc697f3caa623213acbf591cdfa8e (patch)
tree234558ce867aff17c69ea8d5bb24aee2255cbee7 /pack-write.c
parent1190a1acf800acdcfd7569f87ac1560e2d077414 (diff)
downloadgit-e2bfa50ac3bfc697f3caa623213acbf591cdfa8e.tar.gz
pack-write/docs: update regarding pack naming
The index-pack documentation explicitly states that the pack name is derived from the sorted list of object names, but since commit 1190a1acf800 ("pack-objects: name pack files after trailer hash") that isn't true anymore. Be less explicit in the docs as to what the exact output is, and just say that it's whatever goes into the pack name. Also update a comment on write_idx_file() since it no longer modifies the sha1 variable (it's const now anyway), as noted by Junio. Fixes: 1190a1acf800 ("pack-objects: name pack files after trailer hash") Signed-off-by: Johannes Berg <johannes@sipsolutions.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'pack-write.c')
-rw-r--r--pack-write.c5
1 files changed, 2 insertions, 3 deletions
diff --git a/pack-write.c b/pack-write.c
index ddc174e1ad..7297fd7b37 100644
--- a/pack-write.c
+++ b/pack-write.c
@@ -38,9 +38,8 @@ static int need_large_offset(off_t offset, const struct pack_idx_option *opts)
}
/*
- * On entry *sha1 contains the pack content SHA1 hash, on exit it is
- * the SHA1 hash of sorted object names. The objects array passed in
- * will be sorted by SHA1 on exit.
+ * The *sha1 contains the pack content SHA1 hash.
+ * The objects array passed in will be sorted by SHA1 on exit.
*/
const char *write_idx_file(const char *index_name, struct pack_idx_entry **objects,
int nr_objects, const struct pack_idx_option *opts,