mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
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] andbdfdaa4978
(strbuf.h: integrate api-strbuf.txt documentation, 2015-01-16) and6afbbdda33
(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>
This commit is contained in:
parent
c4203212e3
commit
0834257379
7
bundle.h
7
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,
|
||||
|
|
Loading…
Reference in a new issue