[PATCH v3 06/12] object API docs: move check_object_signature() docs to cache.h

From

Ævar Arnfjörð Bjarmason <avarab@gmail.com>

Date

Feb 4, 2022, 23:48 UTC

Message-ID

<patch-v3-06.12-bdddaa3648f-20220204T234435Z-avarab@gmail.com>

In-Reply-To

<cover-v3-00.12-00000000000-20220204T234435Z-avarab@gmail.com>

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 cache.h       | 6 ++++++
 object-file.c | 6 ------
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/cache.h b/cache.h
index 281f00ab1b1..98d1ef08579 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 271acf4dd15..44e0b32d71a 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)

-- 
2.35.1.940.ge7a5b4b05f2