rugged 1.7.2 → 1.9.0

data/vendor/libgit2/include/git2/sys/filter.h

@@ -11,8 +11,8 @@
 
 /**
  * @file git2/sys/filter.h
- * @brief Git filter backend and plugin routines
- * @defgroup git_backend Git custom backend APIs
+ * @brief Custom filter backends and plugins
+ * @defgroup git_backend Custom filter backends and plugins
  * @ingroup Git
  * @{
  */
@@ -26,7 +26,10 @@ GIT_BEGIN_DECL
  */
 GIT_EXTERN(git_filter *) git_filter_lookup(const char *name);
 
+/** The "crlf" filter */
 #define GIT_FILTER_CRLF  "crlf"
+
+/** The "ident" filter */
 #define GIT_FILTER_IDENT "ident"
 
 /**
@@ -53,6 +56,12 @@ GIT_EXTERN(git_filter *) git_filter_lookup(const char *name);
  * the filter list for you, but you can use this in combination with the
  * `git_filter_lookup` and `git_filter_list_push` functions to assemble
  * your own chains of filters.
+ *
+ * @param out the filter list
+ * @param repo the repository to use for configuration
+ * @param mode the filter mode (direction)
+ * @param options the options
+ * @return 0 on success or an error code
  */
 GIT_EXTERN(int) git_filter_list_new(
 	git_filter_list **out,
@@ -72,6 +81,11 @@ GIT_EXTERN(int) git_filter_list_new(
  * filter.  Using this function, you can either pass in a payload if you
  * know the expected payload format, or you can pass NULL.  Some filters
  * may fail with a NULL payload.  Good luck!
+ *
+ * @param fl the filter list
+ * @param filter the filter to push
+ * @param payload the payload for the filter
+ * @return 0 on success or an error code
  */
 GIT_EXTERN(int) git_filter_list_push(
 	git_filter_list *fl, git_filter *filter, void *payload);
@@ -96,17 +110,26 @@ typedef struct git_filter_source git_filter_source;
 
 /**
  * Get the repository that the source data is coming from.
+ *
+ * @param src the filter source
+ * @return the repository for the filter information
  */
 GIT_EXTERN(git_repository *) git_filter_source_repo(const git_filter_source *src);
 
 /**
  * Get the path that the source data is coming from.
+ *
+ * @param src the filter source
+ * @return the path that is being filtered
  */
 GIT_EXTERN(const char *) git_filter_source_path(const git_filter_source *src);
 
 /**
  * Get the file mode of the source file
  * If the mode is unknown, this will return 0
+ *
+ * @param src the filter source
+ * @return the file mode for the file being filtered
  */
 GIT_EXTERN(uint16_t) git_filter_source_filemode(const git_filter_source *src);
 
@@ -114,16 +137,25 @@ GIT_EXTERN(uint16_t) git_filter_source_filemode(const git_filter_source *src);
  * Get the OID of the source
  * If the OID is unknown (often the case with GIT_FILTER_CLEAN) then
  * this will return NULL.
+ *
+ * @param src the filter source
+ * @return the object id of the file being filtered
  */
 GIT_EXTERN(const git_oid *) git_filter_source_id(const git_filter_source *src);
 
 /**
  * Get the git_filter_mode_t to be used
+ *
+ * @param src the filter source
+ * @return the mode (direction) of the filter
  */
 GIT_EXTERN(git_filter_mode_t) git_filter_source_mode(const git_filter_source *src);
 
 /**
  * Get the combination git_filter_flag_t options to be applied
+ *
+ * @param src the filter source
+ * @return the flags of the filter
  */
 GIT_EXTERN(uint32_t) git_filter_source_flags(const git_filter_source *src);
 
@@ -137,6 +169,9 @@ GIT_EXTERN(uint32_t) git_filter_source_flags(const git_filter_source *src);
  * before the first use of the filter, so you can defer expensive
  * initialization operations (in case libgit2 is being used in a way that
  * doesn't need the filter).
+ *
+ * @param self the filter to initialize
+ * @return 0 on success, negative number on failure
  */
 typedef int GIT_CALLBACK(git_filter_init_fn)(git_filter *self);
 
@@ -149,6 +184,8 @@ typedef int GIT_CALLBACK(git_filter_init_fn)(git_filter *self);
  * This may be called even if the `initialize` callback was not made.
  *
  * Typically this function will free the `git_filter` object itself.
+ *
+ * @param self the filter to shutdown
  */
 typedef void GIT_CALLBACK(git_filter_shutdown_fn)(git_filter *self);
 
@@ -171,6 +208,12 @@ typedef void GIT_CALLBACK(git_filter_shutdown_fn)(git_filter *self);
  * allocated (not stack), so that it doesn't go away before the `stream`
  * callback can use it.  If a filter allocates and assigns a value to the
  * `payload`, it will need a `cleanup` callback to free the payload.
+ *
+ * @param self the filter check
+ * @param payload a data for future filter functions
+ * @param src the filter source
+ * @param attr_values the attribute values
+ * @return 0 on success or a negative value on error
  */
 typedef int GIT_CALLBACK(git_filter_check_fn)(
 	git_filter              *self,
@@ -191,6 +234,12 @@ typedef int GIT_CALLBACK(git_filter_check_fn)(
  * The `payload` value will refer to any payload that was set by the
  * `check` callback.  It may be read from or written to as needed.
  *
+ * @param self the filter check
+ * @param payload a data for future filter functions
+ * @param to the input buffer
+ * @param from the output buffer
+ * @param src the filter source
+ * @return 0 on success or a negative value on error
  * @deprecated use git_filter_stream_fn
  */
 typedef int GIT_CALLBACK(git_filter_apply_fn)(
@@ -209,6 +258,13 @@ typedef int GIT_CALLBACK(git_filter_apply_fn)(
  * `git_writestream` that will the original data will be written to;
  * with that data, the `git_writestream` will then perform the filter
  * translation and stream the filtered data out to the `next` location.
+ *
+ * @param out the write stream
+ * @param self the filter
+ * @param payload a data for future filter functions
+ * @param src the filter source
+ * @param next the output stream
+ * @return 0 on success or a negative value on error
  */
 typedef int GIT_CALLBACK(git_filter_stream_fn)(
 	git_writestream        **out,
@@ -225,6 +281,9 @@ typedef int GIT_CALLBACK(git_filter_stream_fn)(
  * `stream` callbacks allocated a `payload` to keep per-source filter
  * state, use this callback to free that payload and release resources
  * as required.
+ *
+ * @param self the filter
+ * @param payload a data for future filter functions
  */
 typedef void GIT_CALLBACK(git_filter_cleanup_fn)(
 	git_filter              *self,
@@ -291,7 +350,10 @@ struct git_filter {
 	git_filter_cleanup_fn  cleanup;
 };
 
+/** Current version for the `git_filter_options` structure */
 #define GIT_FILTER_VERSION 1
+
+/** Static constructor for `git_filter_options` */
 #define GIT_FILTER_INIT {GIT_FILTER_VERSION}
 
 /**
@@ -300,7 +362,7 @@ struct git_filter {
  *
  * @param filter the `git_filter` struct to initialize.
  * @param version Version the struct; pass `GIT_FILTER_VERSION`
- * @return Zero on success; -1 on failure.
+ * @return 0 on success; -1 on failure.
  */
 GIT_EXTERN(int) git_filter_init(git_filter *filter, unsigned int version);
 
@@ -350,4 +412,5 @@ GIT_EXTERN(int) git_filter_unregister(const char *name);
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/sys/hashsig.h

@@ -9,6 +9,16 @@
 
 #include "git2/common.h"
 
+/**
+ * @file git2/sys/hashsig.h
+ * @brief Signatures for file similarity comparison
+ * @defgroup git_hashsig Git merge routines
+ * @ingroup Git
+ *
+ * Hash signatures are used for file similary comparison; this is
+ * used for git's rename handling.
+ * @{
+ */
 GIT_BEGIN_DECL
 
 /**
@@ -101,6 +111,7 @@ GIT_EXTERN(int) git_hashsig_compare(
 	const git_hashsig *a,
 	const git_hashsig *b);
 
+/** @} */
 GIT_END_DECL
 
 #endif

data/vendor/libgit2/include/git2/sys/index.h

@@ -12,8 +12,8 @@
 
 /**
  * @file git2/sys/index.h
- * @brief Low-level Git index manipulation routines
- * @defgroup git_backend Git custom backend APIs
+ * @brief Low-level index manipulation routines
+ * @defgroup git_index Low-level index manipulation routines
  * @ingroup Git
  * @{
  */
@@ -67,6 +67,7 @@ GIT_EXTERN(const git_index_name_entry *) git_index_name_get_byindex(
  * @param ancestor the path of the file as it existed in the ancestor
  * @param ours the path of the file as it existed in our tree
  * @param theirs the path of the file as it existed in their tree
+ * @return 0 on success, or an error code
  */
 GIT_EXTERN(int) git_index_name_add(git_index *index,
 	const char *ancestor, const char *ours, const char *theirs);

data/vendor/libgit2/include/git2/sys/mempack.h

@@ -15,8 +15,8 @@
 
 /**
  * @file git2/sys/mempack.h
- * @brief Custom ODB backend that permits packing objects in-memory
- * @defgroup git_backend Git custom backend APIs
+ * @brief A custom object database backend for storing objects in-memory
+ * @defgroup git_mempack A custom object database backend for storing objects in-memory
  * @ingroup Git
  * @{
  */
@@ -44,6 +44,26 @@ GIT_BEGIN_DECL
  */
 GIT_EXTERN(int) git_mempack_new(git_odb_backend **out);
 
+/**
+ * Write a thin packfile with the objects in the memory store.
+ *
+ * A thin packfile is a packfile that does not contain its transitive closure of
+ * references. This is useful for efficiently distributing additions to a
+ * repository over the network, but also finds use in the efficient bulk
+ * addition of objects to a repository, locally.
+ *
+ * This operation performs the (shallow) insert operations into the
+ * `git_packbuilder`, but does not write the packfile to disk;
+ * see `git_packbuilder_write_buf`.
+ *
+ * It also does not reset the in-memory object database; see `git_mempack_reset`.
+ *
+ * @param backend The mempack backend
+ * @param pb The packbuilder to use to write the packfile
+ * @return 0 on success or an error code
+ */
+GIT_EXTERN(int) git_mempack_write_thin_pack(git_odb_backend *backend, git_packbuilder *pb);
+
 /**
  * Dump all the queued in-memory writes to a packfile.
  *
@@ -82,6 +102,16 @@ GIT_EXTERN(int) git_mempack_dump(git_buf *pack, git_repository *repo, git_odb_ba
  */
 GIT_EXTERN(int) git_mempack_reset(git_odb_backend *backend);
 
+/**
+ * Get the total number of objects in mempack
+ *
+ * @param count The count of objects in the mempack
+ * @param backend The mempack backend
+ * @return 0 on success, or -1 on error
+ */
+GIT_EXTERN(int) git_mempack_object_count(size_t *count, git_odb_backend *backend);
+
+/** @} */
 GIT_END_DECL
 
 #endif

data/vendor/libgit2/include/git2/sys/merge.h

@@ -14,13 +14,18 @@
 
 /**
  * @file git2/sys/merge.h
- * @brief Git merge driver backend and plugin routines
- * @defgroup git_merge Git merge driver APIs
+ * @brief Custom merge drivers
+ * @defgroup git_merge Custom merge drivers
  * @ingroup Git
  * @{
  */
 GIT_BEGIN_DECL
 
+/**
+ * A "merge driver" is a mechanism that can be configured to handle
+ * conflict resolution for files changed in both the "ours" and "theirs"
+ * side of a merge.
+ */
 typedef struct git_merge_driver git_merge_driver;
 
 /**
@@ -31,8 +36,11 @@ typedef struct git_merge_driver git_merge_driver;
  */
 GIT_EXTERN(git_merge_driver *) git_merge_driver_lookup(const char *name);
 
+/** The "text" merge driver */
 #define GIT_MERGE_DRIVER_TEXT   "text"
+/** The "binary" merge driver */
 #define GIT_MERGE_DRIVER_BINARY "binary"
+/** The "union" merge driver */
 #define GIT_MERGE_DRIVER_UNION  "union"
 
 /**
@@ -40,23 +48,48 @@ GIT_EXTERN(git_merge_driver *) git_merge_driver_lookup(const char *name);
  */
 typedef struct git_merge_driver_source git_merge_driver_source;
 
-/** Get the repository that the source data is coming from. */
+/**
+ * Get the repository that the source data is coming from.
+ *
+ * @param src the merge driver source
+ * @return the repository
+ */
 GIT_EXTERN(git_repository *) git_merge_driver_source_repo(
 	const git_merge_driver_source *src);
 
-/** Gets the ancestor of the file to merge. */
+/**
+ * Gets the ancestor of the file to merge.
+ *
+ * @param src the merge driver source
+ * @return the ancestor or NULL if there was no ancestor
+ */
 GIT_EXTERN(const git_index_entry *) git_merge_driver_source_ancestor(
 	const git_merge_driver_source *src);
 
-/** Gets the ours side of the file to merge. */
+/**
+ * Gets the ours side of the file to merge.
+ *
+ * @param src the merge driver source
+ * @return the ours side or NULL if there was no ours side
+ */
 GIT_EXTERN(const git_index_entry *) git_merge_driver_source_ours(
 	const git_merge_driver_source *src);
 
-/** Gets the theirs side of the file to merge. */
+/**
+ * Gets the theirs side of the file to merge.
+ *
+ * @param src the merge driver source
+ * @return the theirs side or NULL if there was no theirs side
+ */
 GIT_EXTERN(const git_index_entry *) git_merge_driver_source_theirs(
 	const git_merge_driver_source *src);
 
-/** Gets the merge file options that the merge was invoked with */
+/**
+ * Gets the merge file options that the merge was invoked with.
+ *
+ * @param src the merge driver source
+ * @return the options
+ */
 GIT_EXTERN(const git_merge_file_options *) git_merge_driver_source_file_options(
 	const git_merge_driver_source *src);
 
@@ -72,6 +105,9 @@ GIT_EXTERN(const git_merge_file_options *) git_merge_driver_source_file_options(
  * right before the first use of the driver, so you can defer expensive
  * initialization operations (in case libgit2 is being used in a way that
  * doesn't need the merge driver).
+ *
+ * @param self the merge driver to initialize
+ * @return 0 on success, or a negative number on failure
  */
 typedef int GIT_CALLBACK(git_merge_driver_init_fn)(git_merge_driver *self);
 
@@ -84,6 +120,8 @@ typedef int GIT_CALLBACK(git_merge_driver_init_fn)(git_merge_driver *self);
  * This may be called even if the `initialize` callback was not made.
  *
  * Typically this function will free the `git_merge_driver` object itself.
+ *
+ * @param self the merge driver to shutdown
  */
 typedef void GIT_CALLBACK(git_merge_driver_shutdown_fn)(git_merge_driver *self);
 
@@ -104,6 +142,14 @@ typedef void GIT_CALLBACK(git_merge_driver_shutdown_fn)(git_merge_driver *self);
  * specified by the file's attributes.
  *
  * The `src` contains the data about the file to be merged.
+ *
+ * @param self the merge driver
+ * @param path_out the resolved path
+ * @param mode_out the resolved mode
+ * @param merged_out the merged output contents
+ * @param filter_name the filter that was invoked
+ * @param src the data about the unmerged file
+ * @return 0 on success, or an error code
  */
 typedef int GIT_CALLBACK(git_merge_driver_apply_fn)(
 	git_merge_driver *self,
@@ -139,6 +185,7 @@ struct git_merge_driver {
 	git_merge_driver_apply_fn    apply;
 };
 
+/** The version for the `git_merge_driver` */
 #define GIT_MERGE_DRIVER_VERSION 1
 
 /**
@@ -179,4 +226,5 @@ GIT_EXTERN(int) git_merge_driver_unregister(const char *name);
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/sys/midx.h

@@ -11,14 +11,52 @@
 #include "git2/types.h"
 
 /**
- * @file git2/midx.h
- * @brief Git multi-pack-index routines
- * @defgroup git_midx Git multi-pack-index routines
+ * @file git2/sys/midx.h
+ * @brief Incremental multi-pack indexes
+ * @defgroup git_midx Incremental multi-pack indexes
  * @ingroup Git
  * @{
  */
 GIT_BEGIN_DECL
 
+/**
+ * Options structure for `git_midx_writer_options`.
+ *
+ * Initialize with `GIT_MIDX_WRITER_OPTIONS_INIT`. Alternatively,
+ * you can use `git_midx_writer_options_init`.
+ */
+typedef struct {
+	unsigned int version;
+
+#ifdef GIT_EXPERIMENTAL_SHA256
+	/** The object ID type that this commit graph contains. */
+	git_oid_t oid_type;
+#endif
+} git_midx_writer_options;
+
+/** Current version for the `git_midx_writer_options` structure */
+#define GIT_MIDX_WRITER_OPTIONS_VERSION 1
+
+/** Static constructor for `git_midx_writer_options` */
+#define GIT_MIDX_WRITER_OPTIONS_INIT { \
+		GIT_MIDX_WRITER_OPTIONS_VERSION \
+	}
+
+/**
+ * Initialize git_midx_writer_options structure
+ *
+ * Initializes a `git_midx_writer_options` with default values.
+ * Equivalent to creating an instance with
+ * `GIT_MIDX_WRITER_OPTIONS_INIT`.
+ *
+ * @param opts The `git_midx_writer_options` struct to initialize.
+ * @param version The struct version; pass `GIT_MIDX_WRITER_OPTIONS_VERSION`.
+ * @return Zero on success; -1 on failure.
+ */
+GIT_EXTERN(int) git_midx_writer_options_init(
+	git_midx_writer_options *opts,
+	unsigned int version);
+
 /**
  * Create a new writer for `multi-pack-index` files.
  *
@@ -31,7 +69,7 @@ GIT_EXTERN(int) git_midx_writer_new(
 		git_midx_writer **out,
 		const char *pack_dir
 #ifdef GIT_EXPERIMENTAL_SHA256
-		, git_oid_t oid_type
+		, git_midx_writer_options *options
 #endif
 		);
 
@@ -75,4 +113,5 @@ GIT_EXTERN(int) git_midx_writer_dump(
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -13,9 +13,9 @@
 #include "git2/odb.h"
 
 /**
- * @file git2/sys/backend.h
- * @brief Git custom backend implementors functions
- * @defgroup git_backend Git custom backend APIs
+ * @file git2/sys/odb_backend.h
+ * @brief Object database backends for custom object storage
+ * @defgroup git_backend Object database backends for custom object storage
  * @ingroup Git
  * @{
  */
@@ -106,7 +106,10 @@ struct git_odb_backend {
 	void GIT_CALLBACK(free)(git_odb_backend *);
 };
 
+/** Current version for the `git_odb_backend_options` structure */
 #define GIT_ODB_BACKEND_VERSION 1
+
+/** Static constructor for `git_odb_backend_options` */
 #define GIT_ODB_BACKEND_INIT {GIT_ODB_BACKEND_VERSION}
 
 /**
@@ -167,6 +170,7 @@ GIT_EXTERN(void *) git_odb_backend_malloc(git_odb_backend *backend, size_t len);
 
 #endif
 
+/** @} */
 GIT_END_DECL
 
 #endif

data/vendor/libgit2/include/git2/sys/openssl.h

@@ -9,6 +9,12 @@
 
 #include "git2/common.h"
 
+/**
+ * @file git2/sys/openssl.h
+ * @brief Custom OpenSSL functionality
+ * @defgroup git_openssl Custom OpenSSL functionality
+ * @{
+ */
 GIT_BEGIN_DECL
 
 /**
@@ -33,6 +39,7 @@ GIT_BEGIN_DECL
  */
 GIT_EXTERN(int) git_openssl_set_locking(void);
 
+/** @} */
 GIT_END_DECL
-#endif
 
+#endif

data/vendor/libgit2/include/git2/sys/path.h

@@ -10,6 +10,16 @@
 
 #include "git2/common.h"
 
+/**
+ * @file git2/sys/path.h
+ * @brief Custom path handling
+ * @defgroup git_path Custom path handling
+ * @ingroup Git
+ *
+ * Merge will take two commits and attempt to produce a commit that
+ * includes the changes that were made in both branches.
+ * @{
+ */
 GIT_BEGIN_DECL
 
 /**
@@ -59,6 +69,7 @@ typedef enum {
  */
 GIT_EXTERN(int) git_path_is_gitfile(const char *path, size_t pathlen, git_path_gitfile gitfile, git_path_fs fs);
 
+/** @} */
 GIT_END_DECL
 
-#endif	/* INCLUDE_sys_git_path */
+#endif