[PATCH 1/4] bundle API: start writing API documentation
From: Ævar Arnfjörð Bjarmason <hidden>
Date: 2021-07-27 00:42:03
Subsystem:
the rest · Maintainer:
Linus Torvalds
There are no other API docs in bundle.h, but this is at least a start. We'll add a parameter to this function in a subsequent commit, but let's start by documenting it. Signed-off-by: Ævar Arnfjörð Bjarmason <redacted> --- bundle.h | 7 +++++++ 1 file changed, 7 insertions(+)
diff --git a/bundle.h b/bundle.h
index 1927d8cd6a..84a6df1b65 100644
--- a/bundle.h
+++ b/bundle.h@@ -27,6 +27,13 @@ int create_bundle(struct repository *r, const char *path, int version); int verify_bundle(struct repository *r, struct bundle_header *header, int verbose); #define BUNDLE_VERBOSE 1 + +/** + * Unbundle after reading the header with read_bundle_header(). + * + * We'll invoke "git index-pack --stdin --fix-thin" for you on the + * provided `bundle_fd` from read_bundle_header(). + */ int unbundle(struct repository *r, struct bundle_header *header, int bundle_fd, int flags); int list_bundle_refs(struct bundle_header *header,
--
2.32.0.988.g189fd9ae38