diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-08-26 14:05:47 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-08-28 01:07:27 (GMT) |
| commit | 08342573792e9af79bf41b32c45ac471d25303bc (patch) | |
| tree | 2265252b85aae67666dec02966b8106aca92dedd /bundle.h | |
| parent | c4203212e360b25a1c69467b5a8437d45a373cac (diff) | |
| download | git-08342573792e9af79bf41b32c45ac471d25303bc.zip git-08342573792e9af79bf41b32c45ac471d25303bc.tar.gz git-08342573792e9af79bf41b32c45ac471d25303bc.tar.bz2 | |
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>
Diffstat (limited to 'bundle.h')
| -rw-r--r-- | bundle.h | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -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, |