bundle API: start writing API documentation
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. The "/**" comment (as opposed to "/*") signifies the start of API documentation. See [1] and bdfdaa4978d (strbuf.h: integrate api-strbuf.txt documentation, 2015-01-16) and 6afbbdda333 (strbuf.h: unify documentation comments beginnings, 2015-01-16) for a discussion of that convention. 1. https://lore.kernel.org/git/874kbeecfu.fsf@evledraar.gmail.com/ Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Aug 26, 2021 at 16:05 UTC
08342573792e9af79bf41b32c45ac471d25303bc
1 file changed
+7
bundle.h
+7
@@ -27,6 +27,13 @@ int create_bundle(struct repository *r, const char *path,
27
int version);
28
int verify_bundle(struct repository *r, struct bundle_header *header, int verbose);
29
#define BUNDLE_VERBOSE 1
30
+
31
+/**
32
+ * Unbundle after reading the header with read_bundle_header().
33
+ *
34
+ * We'll invoke "git index-pack --stdin --fix-thin" for you on the
35
+ * provided `bundle_fd` from read_bundle_header().
36
+ */
37
int unbundle(struct repository *r, struct bundle_header *header,
38
int bundle_fd, int flags);
39
int list_bundle_refs(struct bundle_header *header,