From: Ævar Arnfjörð Bjarmason Date: Fri, 4 Feb 2022 23:48:28 +0000 (+0100) Subject: object API docs: move check_object_signature() docs to cache.h X-Git-Tag: v2.36.0-rc0~66^2~6 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=cdcaaec9a6028f53f9b44efb6dce9f15bb394b45;p=thirdparty%2Fgit.git object API docs: move check_object_signature() docs to cache.h Move the API documentation for check_object_signature() to cache.h, where its prototype is declared. This is in preparation for adding a companion function. Signed-off-by: Ævar Arnfjörð Bjarmason Signed-off-by: Junio C Hamano --- diff --git a/cache.h b/cache.h index 281f00ab1b..98d1ef0857 100644 --- a/cache.h +++ b/cache.h @@ -1319,6 +1319,12 @@ enum unpack_loose_header_result unpack_loose_header(git_zstream *stream, struct object_info; int parse_loose_header(const char *hdr, struct object_info *oi); +/** + * With in-core object data in "buf", rehash it to make sure the + * object name actually matches "oid" to detect object corruption. + * With "buf" == NULL, try reading the object named with "oid" using + * the streaming interface and rehash it to do the same. + */ int check_object_signature(struct repository *r, const struct object_id *oid, void *buf, unsigned long size, const char *type, struct object_id *real_oidp); diff --git a/object-file.c b/object-file.c index 271acf4dd1..44e0b32d71 100644 --- a/object-file.c +++ b/object-file.c @@ -1066,12 +1066,6 @@ int format_object_header(char *str, size_t size, enum object_type type, return format_object_header_literally(str, size, name, objsize); } -/* - * With in-core object data in "buf", rehash it to make sure the - * object name actually matches "oid" to detect object corruption. - * With "buf" == NULL, try reading the object named with "oid" using - * the streaming interface and rehash it to do the same. - */ int check_object_signature(struct repository *r, const struct object_id *oid, void *buf, unsigned long size, const char *type, struct object_id *real_oidp)