rugged 1.6.3 → 1.9.0

data/vendor/libgit2/include/git2/odb.h

@@ -15,7 +15,7 @@
 
 /**
  * @file git2/odb.h
- * @brief Git object database routines
+ * @brief An object database manages the storage of git objects
  * @defgroup git_odb Git object database routines
  * @ingroup Git
  * @{
@@ -35,6 +35,10 @@ typedef enum {
 
 /**
  * Function type for callbacks from git_odb_foreach.
+ *
+ * @param id an id of an object in the object database
+ * @param payload the payload from the initial call to git_odb_foreach
+ * @return 0 on success, or an error code
  */
 typedef int GIT_CALLBACK(git_odb_foreach_cb)(const git_oid *id, void *payload);
 
@@ -49,30 +53,53 @@ typedef struct {
 	git_oid_t oid_type;
 } git_odb_options;
 
-/* The current version of the diff options structure */
+/** The current version of the diff options structure */
 #define GIT_ODB_OPTIONS_VERSION 1
 
-/* Stack initializer for odb options.  Alternatively use
+/**
+ * Stack initializer for odb options.  Alternatively use
  * `git_odb_options_init` programmatic initialization.
  */
 #define GIT_ODB_OPTIONS_INIT { GIT_ODB_OPTIONS_VERSION }
 
+#ifdef GIT_EXPERIMENTAL_SHA256
+
 /**
  * Create a new object database with no backends.
  *
- * Before the ODB can be used for read/writing, a custom database
- * backend must be manually added using `git_odb_add_backend()`
+ * @param[out] odb location to store the database pointer, if opened.
+ * @param opts the options for this object database or NULL for defaults
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_new(git_odb **odb, const git_odb_options *opts);
+
+/**
+ * Create a new object database and automatically add loose and packed
+ * backends.
  *
- * @param out location to store the database pointer, if opened.
+ * @param[out] odb_out location to store the database pointer, if opened.
  *			Set to NULL if the open failed.
+ * @param objects_dir path of the backends' "objects" directory.
  * @param opts the options for this object database or NULL for defaults
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_odb_new(git_odb **out, const git_odb_options *opts);
+GIT_EXTERN(int) git_odb_open(
+	git_odb **odb_out,
+	const char *objects_dir,
+	const git_odb_options *opts);
+
 #else
-GIT_EXTERN(int) git_odb_new(git_odb **out);
-#endif
+
+/**
+ * Create a new object database with no backends.
+ *
+ * Before the ODB can be used for read/writing, a custom database
+ * backend must be manually added using `git_odb_add_backend()`
+ *
+ * @param[out] odb location to store the database pointer, if opened.
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_new(git_odb **odb);
 
 /**
  * Create a new object database and automatically add
@@ -85,19 +112,12 @@ GIT_EXTERN(int) git_odb_new(git_odb **out);
  *		assuming `objects_dir` as the Objects folder which
  *		contains a 'pack/' folder with the corresponding data
  *
- * @param out location to store the database pointer, if opened.
+ * @param[out] odb_out location to store the database pointer, if opened.
  *			Set to NULL if the open failed.
  * @param objects_dir path of the backends' "objects" directory.
- * @param opts the options for this object database or NULL for defaults
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_odb_open(
-	git_odb **out,
-	const char *objects_dir,
-	const git_odb_options *opts);
-#else
-GIT_EXTERN(int) git_odb_open(git_odb **out, const char *objects_dir);
+GIT_EXTERN(int) git_odb_open(git_odb **odb_out, const char *objects_dir);
 #endif
 
 /**
@@ -134,13 +154,13 @@ GIT_EXTERN(void) git_odb_free(git_odb *db);
  * internally cached, so it should be closed
  * by the user once it's no longer in use.
  *
- * @param out pointer where to store the read object
+ * @param[out] obj pointer where to store the read object
  * @param db database to search for the object in.
  * @param id identity of the object to read.
  * @return 0 if the object was read, GIT_ENOTFOUND if the object is
  *         not in the database.
  */
-GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *id);
+GIT_EXTERN(int) git_odb_read(git_odb_object **obj, git_odb *db, const git_oid *id);
 
 /**
  * Read an object from the database, given a prefix
@@ -160,7 +180,7 @@ GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *i
  * internally cached, so it should be closed
  * by the user once it's no longer in use.
  *
- * @param out pointer where to store the read object
+ * @param[out] obj pointer where to store the read object
  * @param db database to search for the object in.
  * @param short_id a prefix of the id of the object to read.
  * @param len the length of the prefix
@@ -168,7 +188,7 @@ GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *i
  *         database. GIT_EAMBIGUOUS if the prefix is ambiguous
  *         (several objects match the prefix)
  */
-GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **out, git_odb *db, const git_oid *short_id, size_t len);
+GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **obj, git_odb *db, const git_oid *short_id, size_t len);
 
 /**
  * Read the header of an object from the database, without
@@ -180,8 +200,8 @@ GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **out, git_odb *db, const git
  * of an object, so the whole object will be read and then the
  * header will be returned.
  *
- * @param len_out pointer where to store the length
- * @param type_out pointer where to store the type
+ * @param[out] len_out pointer where to store the length
+ * @param[out] type_out pointer where to store the type
  * @param db database to search for the object in.
  * @param id identity of the object to read.
  * @return 0 if the object was read, GIT_ENOTFOUND if the object is not
@@ -286,7 +306,7 @@ GIT_EXTERN(int) git_odb_expand_ids(
  * @param db database to refresh
  * @return 0 on success, error code otherwise
  */
-GIT_EXTERN(int) git_odb_refresh(struct git_odb *db);
+GIT_EXTERN(int) git_odb_refresh(git_odb *db);
 
 /**
  * List all objects available in the database
@@ -301,7 +321,10 @@ GIT_EXTERN(int) git_odb_refresh(struct git_odb *db);
  * @param payload data to pass to the callback
  * @return 0 on success, non-zero callback return value, or error code
  */
-GIT_EXTERN(int) git_odb_foreach(git_odb *db, git_odb_foreach_cb cb, void *payload);
+GIT_EXTERN(int) git_odb_foreach(
+	git_odb *db,
+	git_odb_foreach_cb cb,
+	void *payload);
 
 /**
  * Write an object directly into the ODB
@@ -316,7 +339,7 @@ GIT_EXTERN(int) git_odb_foreach(git_odb *db, git_odb_foreach_cb cb, void *payloa
  *
  * @param out pointer to store the OID result of the write
  * @param odb object database where to store the object
- * @param data buffer with the data to store
+ * @param data @type `const unsigned char *` buffer with the data to store
  * @param len size of the buffer
  * @param type type of the data to store
  * @return 0 or an error code
@@ -382,7 +405,7 @@ GIT_EXTERN(int) git_odb_stream_finalize_write(git_oid *out, git_odb_stream *stre
  * @param stream the stream
  * @param buffer a user-allocated buffer to store the data in.
  * @param len the buffer's length
- * @return 0 if the read succeeded, error code otherwise
+ * @return the number of bytes read if succeeded, error code otherwise
  */
 GIT_EXTERN(int) git_odb_stream_read(git_odb_stream *stream, char *buffer, size_t len);
 
@@ -466,29 +489,54 @@ GIT_EXTERN(int) git_odb_write_pack(
 GIT_EXTERN(int) git_odb_write_multi_pack_index(
 	git_odb *db);
 
+#ifdef GIT_EXPERIMENTAL_SHA256
+
 /**
- * Determine the object-ID (sha1 or sha256 hash) of a data buffer
+ * Generate the object ID (in SHA1 or SHA256 format) for a given data buffer.
  *
- * The resulting OID will be the identifier for the data buffer as if
- * the data buffer it were to written to the ODB.
- *
- * @param out the resulting object-ID.
+ * @param[out] oid the resulting object ID.
  * @param data data to hash
  * @param len size of the data
  * @param object_type of the data to hash
  * @param oid_type the oid type to hash to
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
 GIT_EXTERN(int) git_odb_hash(
-	git_oid *out,
+	git_oid *oid,
 	const void *data,
 	size_t len,
 	git_object_t object_type,
 	git_oid_t oid_type);
+
+/**
+ * Determine the object ID of a file on disk.
+ *
+ * @param[out] oid oid structure the result is written into.
+ * @param path file to read and determine object id for
+ * @param object_type of the data to hash
+ * @param oid_type the oid type to hash to
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_hashfile(
+	git_oid *oid,
+	const char *path,
+	git_object_t object_type,
+	git_oid_t oid_type);
 #else
-GIT_EXTERN(int) git_odb_hash(git_oid *out, const void *data, size_t len, git_object_t type);
-#endif
+
+/**
+ * Determine the object-ID (sha1 or sha256 hash) of a data buffer
+ *
+ * The resulting OID will be the identifier for the data buffer as if
+ * the data buffer it were to written to the ODB.
+ *
+ * @param[out] oid the resulting object-ID.
+ * @param data data to hash
+ * @param len size of the data
+ * @param object_type of the data to hash
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_hash(git_oid *oid, const void *data, size_t len, git_object_t object_type);
 
 /**
  * Read a file from disk and fill a git_oid with the object id
@@ -498,20 +546,13 @@ GIT_EXTERN(int) git_odb_hash(git_oid *out, const void *data, size_t len, git_obj
  * the `-w` flag, however, with the --no-filters flag.
  * If you need filters, see git_repository_hashfile.
  *
- * @param out oid structure the result is written into.
+ * @param[out] oid oid structure the result is written into.
  * @param path file to read and determine object id for
  * @param object_type of the data to hash
- * @param oid_type the oid type to hash to
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_odb_hashfile(
-	git_oid *out,
-	const char *path,
-	git_object_t object_type,
-	git_oid_t oid_type);
-#else
-GIT_EXTERN(int) git_odb_hashfile(git_oid *out, const char *path, git_object_t type);
+GIT_EXTERN(int) git_odb_hashfile(git_oid *oid, const char *path, git_object_t object_type);
+
 #endif
 
 /**
@@ -557,7 +598,7 @@ GIT_EXTERN(const git_oid *) git_odb_object_id(git_odb_object *object);
  * This pointer is owned by the object and shall not be free'd.
  *
  * @param object the object
- * @return a pointer to the data
+ * @return @type `const unsigned char *` a pointer to the data
  */
 GIT_EXTERN(const void *) git_odb_object_data(git_odb_object *object);
 
@@ -651,4 +692,5 @@ GIT_EXTERN(int) git_odb_set_commit_graph(git_odb *odb, git_commit_graph *cgraph)
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/odb_backend.h

@@ -13,17 +13,13 @@
 
 /**
  * @file git2/backend.h
- * @brief Git custom backend functions
+ * @brief Object database backends manage the storage of git objects
  * @defgroup git_odb Git object database routines
  * @ingroup Git
  * @{
  */
 GIT_BEGIN_DECL
 
-/*
- * Constructors for in-box ODB backends.
- */
-
 /** Options for configuring a packfile object backend. */
 typedef struct {
 	unsigned int version; /**< version for the struct */
@@ -35,56 +31,16 @@ typedef struct {
 	git_oid_t oid_type;
 } git_odb_backend_pack_options;
 
-/* The current version of the diff options structure */
+/** The current version of the diff options structure */
 #define GIT_ODB_BACKEND_PACK_OPTIONS_VERSION 1
 
-/* Stack initializer for odb pack backend options.  Alternatively use
+/**
+ * Stack initializer for odb pack backend options.  Alternatively use
  * `git_odb_backend_pack_options_init` programmatic initialization.
  */
 #define GIT_ODB_BACKEND_PACK_OPTIONS_INIT \
 	{ GIT_ODB_BACKEND_PACK_OPTIONS_VERSION }
 
-/**
- * Create a backend for the packfiles.
- *
- * @param out location to store the odb backend pointer
- * @param objects_dir the Git repository's objects directory
- *
- * @return 0 or an error code
- */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_odb_backend_pack(
-	git_odb_backend **out,
-	const char *objects_dir,
-	const git_odb_backend_pack_options *opts);
-#else
-GIT_EXTERN(int) git_odb_backend_pack(
-	git_odb_backend **out,
-	const char *objects_dir);
-#endif
-
-/**
- * Create a backend out of a single packfile
- *
- * This can be useful for inspecting the contents of a single
- * packfile.
- *
- * @param out location to store the odb backend pointer
- * @param index_file path to the packfile's .idx file
- *
- * @return 0 or an error code
- */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_odb_backend_one_pack(
-	git_odb_backend **out,
-	const char *index_file,
-	const git_odb_backend_pack_options *opts);
-#else
-GIT_EXTERN(int) git_odb_backend_one_pack(
-	git_odb_backend **out,
-	const char *index_file);
-#endif
-
 typedef enum {
 	GIT_ODB_BACKEND_LOOSE_FSYNC = (1 << 0)
 } git_odb_backend_loose_flag_t;
@@ -118,30 +74,100 @@ typedef struct {
 	git_oid_t oid_type;
 } git_odb_backend_loose_options;
 
-/* The current version of the diff options structure */
+/** The current version of the diff options structure */
 #define GIT_ODB_BACKEND_LOOSE_OPTIONS_VERSION 1
 
-/* Stack initializer for odb loose backend options.  Alternatively use
+/**
+ * Stack initializer for odb loose backend options.  Alternatively use
  * `git_odb_backend_loose_options_init` programmatic initialization.
  */
 #define GIT_ODB_BACKEND_LOOSE_OPTIONS_INIT \
 	{ GIT_ODB_BACKEND_LOOSE_OPTIONS_VERSION, 0, -1 }
 
+/*
+ * Constructors for in-box ODB backends.
+ */
+
+#ifdef GIT_EXPERIMENTAL_SHA256
+
+/**
+ * Create a backend for a directory containing packfiles.
+ *
+ * @param[out] out location to store the odb backend pointer
+ * @param objects_dir the Git repository's objects directory
+ * @param opts the options to use when creating the pack backend
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_backend_pack(
+	git_odb_backend **out,
+	const char *objects_dir,
+	const git_odb_backend_pack_options *opts);
+
+/**
+ * Create a backend for a single packfile.
+ *
+ * @param[out] out location to store the odb backend pointer
+ * @param index_file path to the packfile's .idx file
+ * @param opts the options to use when creating the pack backend
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_backend_one_pack(
+	git_odb_backend **out,
+	const char *index_file,
+	const git_odb_backend_pack_options *opts);
+
 /**
  * Create a backend for loose objects
  *
- * @param out location to store the odb backend pointer
+ * @param[out] out location to store the odb backend pointer
  * @param objects_dir the Git repository's objects directory
  * @param opts options for the loose object backend or NULL
  *
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
 GIT_EXTERN(int) git_odb_backend_loose(
 	git_odb_backend **out,
 	const char *objects_dir,
 	git_odb_backend_loose_options *opts);
+
 #else
+
+/**
+ * Create a backend for a directory containing packfiles.
+ *
+ * @param[out] out location to store the odb backend pointer
+ * @param objects_dir the Git repository's objects directory
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_backend_pack(
+	git_odb_backend **out,
+	const char *objects_dir);
+
+/**
+ * Create a backend out of a single packfile
+ *
+ * This can be useful for inspecting the contents of a single
+ * packfile.
+ *
+ * @param[out] out location to store the odb backend pointer
+ * @param index_file path to the packfile's .idx file
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_odb_backend_one_pack(
+	git_odb_backend **out,
+	const char *index_file);
+
+/**
+ * Create a backend for loose objects
+ *
+ * @param[out] out location to store the odb backend pointer
+ * @param objects_dir the Git repository's objects directory
+ * @param compression_level zlib compression level (0-9), or -1 for the default
+ * @param do_fsync if non-zero, perform an fsync on write
+ * @param dir_mode permission to use when creating directories, or 0 for default
+ * @param file_mode permission to use when creating directories, or 0 for default
+ * @return 0 or an error code
+ */
 GIT_EXTERN(int) git_odb_backend_loose(
 	git_odb_backend **out,
 	const char *objects_dir,
@@ -149,6 +175,7 @@ GIT_EXTERN(int) git_odb_backend_loose(
 	int do_fsync,
 	unsigned int dir_mode,
 	unsigned int file_mode);
+
 #endif
 
 /** Streaming mode */
@@ -218,6 +245,7 @@ struct git_odb_writepack {
 	void GIT_CALLBACK(free)(git_odb_writepack *writepack);
 };
 
+/** @} */
 GIT_END_DECL
 
 #endif

data/vendor/libgit2/include/git2/oid.h

@@ -13,7 +13,7 @@
 
 /**
  * @file git2/oid.h
- * @brief Git object id routines
+ * @brief Object IDs
  * @defgroup git_oid Git object id routines
  * @ingroup Git
  * @{
@@ -82,13 +82,18 @@ typedef enum {
 
 #endif
 
-/* Maximum possible object ID size in raw / hex string format. */
-#ifndef GIT_EXPERIMENTAL_SHA256
-# define GIT_OID_MAX_SIZE        GIT_OID_SHA1_SIZE
-# define GIT_OID_MAX_HEXSIZE     GIT_OID_SHA1_HEXSIZE
-#else
+/** Maximum possible object ID size in raw format */
+#ifdef GIT_EXPERIMENTAL_SHA256
 # define GIT_OID_MAX_SIZE        GIT_OID_SHA256_SIZE
+#else
+# define GIT_OID_MAX_SIZE        GIT_OID_SHA1_SIZE
+#endif
+
+/** Maximum possible object ID size in hex format */
+#ifdef GIT_EXPERIMENTAL_SHA256
 # define GIT_OID_MAX_HEXSIZE     GIT_OID_SHA256_HEXSIZE
+#else
+# define GIT_OID_MAX_HEXSIZE     GIT_OID_SHA1_HEXSIZE
 #endif
 
 /** Minimum length (in number of hex characters,
@@ -107,6 +112,15 @@ typedef struct git_oid {
 	unsigned char id[GIT_OID_MAX_SIZE];
 } git_oid;
 
+#ifdef GIT_EXPERIMENTAL_SHA256
+
+GIT_EXTERN(int) git_oid_fromstr(git_oid *out, const char *str, git_oid_t type);
+GIT_EXTERN(int) git_oid_fromstrp(git_oid *out, const char *str, git_oid_t type);
+GIT_EXTERN(int) git_oid_fromstrn(git_oid *out, const char *str, size_t length, git_oid_t type);
+GIT_EXTERN(int) git_oid_fromraw(git_oid *out, const unsigned char *raw, git_oid_t type);
+
+#else
+
 /**
  * Parse a hex formatted object id into a git_oid.
  *
@@ -119,28 +133,18 @@ typedef struct git_oid {
  *		the hex sequence and have at least the number of bytes
  *		needed for an oid encoded in hex (40 bytes for sha1,
  *		256 bytes for sha256).
- * @param type the type of object id
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_oid_fromstr(git_oid *out, const char *str, git_oid_t type);
-#else
 GIT_EXTERN(int) git_oid_fromstr(git_oid *out, const char *str);
-#endif
 
 /**
  * Parse a hex formatted NUL-terminated string into a git_oid.
  *
  * @param out oid structure the result is written into.
  * @param str input hex string; must be null-terminated.
- * @param type the type of object id
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_oid_fromstrp(git_oid *out, const char *str, git_oid_t type);
-#else
 GIT_EXTERN(int) git_oid_fromstrp(git_oid *out, const char *str);
-#endif
 
 /**
  * Parse N characters of a hex formatted object id into a git_oid.
@@ -151,14 +155,9 @@ GIT_EXTERN(int) git_oid_fromstrp(git_oid *out, const char *str);
  * @param out oid structure the result is written into.
  * @param str input hex string of at least size `length`
  * @param length length of the input string
- * @param type the type of object id
  * @return 0 or an error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_oid_fromstrn(git_oid *out, const char *str, size_t length, git_oid_t type);
-#else
 GIT_EXTERN(int) git_oid_fromstrn(git_oid *out, const char *str, size_t length);
-#endif
 
 /**
  * Copy an already raw oid into a git_oid structure.
@@ -167,10 +166,8 @@ GIT_EXTERN(int) git_oid_fromstrn(git_oid *out, const char *str, size_t length);
  * @param raw the raw input bytes to be copied.
  * @return 0 on success or error code
  */
-#ifdef GIT_EXPERIMENTAL_SHA256
-GIT_EXTERN(int) git_oid_fromraw(git_oid *out, const unsigned char *raw, git_oid_t type);
-#else
 GIT_EXTERN(int) git_oid_fromraw(git_oid *out, const unsigned char *raw);
+
 #endif
 
 /**
@@ -225,7 +222,7 @@ GIT_EXTERN(int) git_oid_pathfmt(char *out, const git_oid *id);
  * concurrent calls of the function.
  *
  * @param oid The oid structure to format
- * @return the c-string
+ * @return the c-string or NULL on failure
  */
 GIT_EXTERN(char *) git_oid_tostr_s(const git_oid *oid);
 
@@ -310,6 +307,7 @@ GIT_EXTERN(int) git_oid_strcmp(const git_oid *id, const char *str);
 /**
  * Check is an oid is all zeros.
  *
+ * @param id the object ID to check
  * @return 1 if all zeros, 0 otherwise.
  */
 GIT_EXTERN(int) git_oid_is_zero(const git_oid *id);
@@ -370,4 +368,5 @@ GIT_EXTERN(void) git_oid_shorten_free(git_oid_shorten *os);
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/oidarray.h

@@ -10,6 +10,13 @@
 #include "common.h"
 #include "oid.h"
 
+/**
+ * @file git2/oidarray.h
+ * @brief An array of object IDs
+ * @defgroup git_oidarray Arrays of object IDs
+ * @ingroup Git
+ * @{
+ */
 GIT_BEGIN_DECL
 
 /** Array of object ids */
@@ -34,4 +41,3 @@ GIT_EXTERN(void) git_oidarray_dispose(git_oidarray *array);
 GIT_END_DECL
 
 #endif
-

data/vendor/libgit2/include/git2/pack.h

@@ -233,7 +233,15 @@ GIT_EXTERN(size_t) git_packbuilder_object_count(git_packbuilder *pb);
  */
 GIT_EXTERN(size_t) git_packbuilder_written(git_packbuilder *pb);
 
-/** Packbuilder progress notification function */
+/**
+ * Packbuilder progress notification function.
+ *
+ * @param stage the stage of the packbuilder
+ * @param current the current object
+ * @param total the total number of objects
+ * @param payload the callback payload
+ * @return 0 on success or an error code
+ */
 typedef int GIT_CALLBACK(git_packbuilder_progress)(
 	int stage,
 	uint32_t current,
@@ -247,6 +255,9 @@ typedef int GIT_CALLBACK(git_packbuilder_progress)(
  * @param progress_cb Function to call with progress information during
  * pack building. Be aware that this is called inline with pack building
  * operations, so performance may be affected.
+ * When progress_cb returns an error, the pack building process will be
+ * aborted and the error will be returned from the invoked function.
+ * `pb` must then be freed.
  * @param progress_cb_payload Payload for progress callback.
  * @return 0 or an error code
  */
@@ -264,4 +275,5 @@ GIT_EXTERN(void) git_packbuilder_free(git_packbuilder *pb);
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/patch.h

@@ -14,7 +14,7 @@
 
 /**
  * @file git2/patch.h
- * @brief Patch handling routines.
+ * @brief Patches store the textual diffs in a delta
  * @ingroup Git
  * @{
  */
@@ -283,8 +283,7 @@ GIT_EXTERN(int) git_patch_to_buf(
 	git_buf *out,
 	git_patch *patch);
 
-GIT_END_DECL
-
 /**@}*/
+GIT_END_DECL
 
 #endif