rugged 1.3.1 → 1.9.0

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

@@ -15,7 +15,7 @@
 
 /**
  * @file git2/sys/diff.h
- * @brief Low-level Git diff utilities
+ * @brief Low-level diff utilities
  * @ingroup Git
  * @{
  */
@@ -33,6 +33,12 @@ GIT_BEGIN_DECL
  * must pass a `git_buf *` value as the payload to the `git_diff_print`
  * and/or `git_patch_print` function.  The data will be appended to the
  * buffer (after any existing content).
+ *
+ * @param delta the delta being processed
+ * @param hunk the hunk being processed
+ * @param line the line being processed
+ * @param payload the payload provided by the diff generator
+ * @return 0 on success or an error code
  */
 GIT_EXTERN(int) git_diff_print_callback__to_buf(
 	const git_diff_delta *delta,
@@ -53,6 +59,12 @@ GIT_EXTERN(int) git_diff_print_callback__to_buf(
  * value from `fopen()`) as the payload to the `git_diff_print`
  * and/or `git_patch_print` function.  If you pass NULL, this will write
  * data to `stdout`.
+ *
+ * @param delta the delta being processed
+ * @param hunk the hunk being processed
+ * @param line the line being processed
+ * @param payload the payload provided by the diff generator
+ * @return 0 on success or an error code
  */
 GIT_EXTERN(int) git_diff_print_callback__to_file_handle(
 	const git_diff_delta *delta,
@@ -70,7 +82,10 @@ typedef struct {
 	size_t oid_calculations; /**< Number of ID calculations */
 } git_diff_perfdata;
 
+/** Current version for the `git_diff_perfdata_options` structure */
 #define GIT_DIFF_PERFDATA_VERSION 1
+
+/** Static constructor for `git_diff_perfdata_options` */
 #define GIT_DIFF_PERFDATA_INIT {GIT_DIFF_PERFDATA_VERSION,0,0}
 
 /**
@@ -85,10 +100,15 @@ GIT_EXTERN(int) git_diff_get_perfdata(
 
 /**
  * Get performance data for diffs from a git_status_list
+ *
+ * @param out Structure to be filled with diff performance data
+ * @param status Diff to read performance data from
+ * @return 0 for success, <0 for error
  */
 GIT_EXTERN(int) git_status_list_get_perfdata(
 	git_diff_perfdata *out, const git_status_list *status);
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -7,6 +7,11 @@
 #ifndef INCLUDE_sys_git_email_h__
 #define INCLUDE_sys_git_email_h__
 
+#include "git2/common.h"
+#include "git2/diff.h"
+#include "git2/email.h"
+#include "git2/types.h"
+
 /**
  * @file git2/sys/email.h
  * @brief Advanced git email creation routines
@@ -28,6 +33,7 @@ GIT_BEGIN_DECL
  * @param body optional text to include above the diffstat
  * @param author the person who authored this commit
  * @param opts email creation options
+ * @return 0 on success or an error code
  */
 GIT_EXTERN(int) git_email_create_from_diff(
 	git_buf *out,
@@ -42,4 +48,5 @@ GIT_EXTERN(int) git_email_create_from_diff(
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) the libgit2 contributors. All rights reserved.
+ *
+ * This file is part of libgit2, distributed under the GNU GPL v2 with
+ * a Linking Exception. For full terms see the included COPYING file.
+ */
+
+#ifndef INCLUDE_sys_git_errors_h__
+#define INCLUDE_sys_git_errors_h__
+
+#include "git2/common.h"
+
+/**
+ * @file git2/sys/errors.h
+ * @brief Advanced error handling
+ * @ingroup Git
+ *
+ * Error handling for advanced consumers; those who use callbacks
+ * or those who create custom databases.
+ * @{
+ */
+GIT_BEGIN_DECL
+
+/**
+ * Clear the last library error that occurred for this thread.
+ */
+GIT_EXTERN(void) git_error_clear(void);
+
+/**
+ * Set the error message string for this thread, using `printf`-style
+ * formatting.
+ *
+ * This function is public so that custom ODB backends and the like can
+ * relay an error message through libgit2.  Most regular users of libgit2
+ * will never need to call this function -- actually, calling it in most
+ * circumstances (for example, calling from within a callback function)
+ * will just end up having the value overwritten by libgit2 internals.
+ *
+ * This error message is stored in thread-local storage and only applies
+ * to the particular thread that this libgit2 call is made from.
+ *
+ * @param error_class One of the `git_error_t` enum above describing the
+ *                    general subsystem that is responsible for the error.
+ * @param fmt The `printf`-style format string; subsequent arguments must
+ *            be the arguments for the format string.
+ */
+GIT_EXTERN(void) git_error_set(int error_class, const char *fmt, ...)
+                 GIT_FORMAT_PRINTF(2, 3);
+
+/**
+ * Set the error message string for this thread.  This function is like
+ * `git_error_set` but takes a static string instead of a `printf`-style
+ * format.
+ *
+ * @param error_class One of the `git_error_t` enum above describing the
+ *                    general subsystem that is responsible for the error.
+ * @param string The error message to keep
+ * @return 0 on success or -1 on failure
+ */
+GIT_EXTERN(int) git_error_set_str(int error_class, const char *string);
+
+/**
+ * Set the error message to a special value for memory allocation failure.
+ *
+ * The normal `git_error_set_str()` function attempts to `strdup()` the
+ * string that is passed in.  This is not a good idea when the error in
+ * question is a memory allocation failure.  That circumstance has a
+ * special setter function that sets the error string to a known and
+ * statically allocated internal value.
+ */
+GIT_EXTERN(void) git_error_set_oom(void);
+
+/** @} */
+GIT_END_DECL
+
+#endif

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.
  *
@@ -29,7 +67,11 @@ GIT_BEGIN_DECL
  */
 GIT_EXTERN(int) git_midx_writer_new(
 		git_midx_writer **out,
-		const char *pack_dir);
+		const char *pack_dir
+#ifdef GIT_EXPERIMENTAL_SHA256
+		, git_midx_writer_options *options
+#endif
+		);
 
 /**
  * Free the multi-pack-index writer and its resources.
@@ -71,4 +113,5 @@ GIT_EXTERN(int) git_midx_writer_dump(
 
 /** @} */
 GIT_END_DECL
+
 #endif