rugged 1.6.3 → 1.9.0

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

@@ -15,7 +15,7 @@
 
 /**
  * @file git2/diff.h
- * @brief Git tree and file differencing routines.
+ * @brief Indicate the differences between two versions of the repository
  * @ingroup Git
  * @{
  */
@@ -342,6 +342,12 @@ typedef struct {
  *		diff process continues.
  * - returns 0, the delta is inserted into the diff, and the diff process
  *		continues.
+ *
+ * @param diff_so_far the diff structure as it currently exists
+ * @param delta_to_add the delta that is to be added
+ * @param matched_pathspec the pathspec
+ * @param payload the user-specified callback payload
+ * @return 0 on success, 1 to skip this delta, or an error code
  */
 typedef int GIT_CALLBACK(git_diff_notify_cb)(
 	const git_diff *diff_so_far,
@@ -357,7 +363,8 @@ typedef int GIT_CALLBACK(git_diff_notify_cb)(
  * @param diff_so_far The diff being generated.
  * @param old_path The path to the old file or NULL.
  * @param new_path The path to the new file or NULL.
- * @return Non-zero to abort the diff.
+ * @param payload the user-specified callback payload
+ * @return 0 or an error code
  */
 typedef int GIT_CALLBACK(git_diff_progress_cb)(
 	const git_diff *diff_so_far,
@@ -421,6 +428,22 @@ typedef struct {
 	 */
 	uint32_t    interhunk_lines;
 
+	/**
+	 * The object ID type to emit in diffs; this is used by functions
+	 * that operate without a repository - namely `git_diff_buffers`,
+	 * or `git_diff_blobs` and `git_diff_blob_to_buffer` when one blob
+	 * is `NULL`.
+	 *
+	 * This may be omitted (set to `0`). If a repository is available,
+	 * the object ID format of the repository will be used. If no
+	 * repository is available then the default is `GIT_OID_SHA`.
+	 *
+	 * If this is specified and a repository is available, then the
+	 * specified `oid_type` must match the repository's object ID
+	 * format.
+	 */
+	git_oid_t   oid_type;
+
 	/**
 	 * The abbreviation length to use when formatting object ids.
 	 * Defaults to the value of 'core.abbrev' from the config, or 7 if unset.
@@ -447,10 +470,10 @@ typedef struct {
 	const char *new_prefix;
 } git_diff_options;
 
-/* The current version of the diff options structure */
+/** The current version of the diff options structure */
 #define GIT_DIFF_OPTIONS_VERSION 1
 
-/* Stack initializer for diff options.  Alternatively use
+/** Stack initializer for diff options.  Alternatively use
  * `git_diff_options_init` programmatic initialization.
  */
 #define GIT_DIFF_OPTIONS_INIT \
@@ -476,12 +499,14 @@ GIT_EXTERN(int) git_diff_options_init(
  * @param delta A pointer to the delta data for the file
  * @param progress Goes from 0 to 1 over the diff
  * @param payload User-specified pointer from foreach function
+ * @return 0 or an error code
  */
 typedef int GIT_CALLBACK(git_diff_file_cb)(
 	const git_diff_delta *delta,
 	float progress,
 	void *payload);
 
+/** Maximum size of the hunk header */
 #define GIT_DIFF_HUNK_HEADER_SIZE	128
 
 /**
@@ -542,6 +567,11 @@ typedef struct {
 /**
  * When iterating over a diff, callback that will be made for
  * binary content within the diff.
+ *
+ * @param delta the delta
+ * @param binary the binary content
+ * @param payload the user-specified callback payload
+ * @return 0 or an error code
  */
 typedef int GIT_CALLBACK(git_diff_binary_cb)(
 	const git_diff_delta *delta,
@@ -568,6 +598,11 @@ typedef struct {
 
 /**
  * When iterating over a diff, callback that will be made per hunk.
+ *
+ * @param delta the delta
+ * @param hunk the hunk
+ * @param payload the user-specified callback payload
+ * @return 0 or an error code
  */
 typedef int GIT_CALLBACK(git_diff_hunk_cb)(
 	const git_diff_delta *delta,
@@ -629,6 +664,12 @@ typedef struct {
  * When printing a diff, callback that will be made to output each line
  * of text.  This uses some extra GIT_DIFF_LINE_... constants for output
  * of lines of file and hunk headers.
+ *
+ * @param delta the delta that contains the line
+ * @param hunk the hunk that contains the line
+ * @param line the line in the diff
+ * @param payload the user-specified callback payload
+ * @return 0 or an error code
  */
 typedef int GIT_CALLBACK(git_diff_line_cb)(
 	const git_diff_delta *delta, /**< delta that contains this data */
@@ -786,7 +827,10 @@ typedef struct {
 	git_diff_similarity_metric *metric;
 } git_diff_find_options;
 
+/** Current version for the `git_diff_find_options` structure */
 #define GIT_DIFF_FIND_OPTIONS_VERSION 1
+
+/** Static constructor for `git_diff_find_options` */
 #define GIT_DIFF_FIND_OPTIONS_INIT {GIT_DIFF_FIND_OPTIONS_VERSION}
 
 /**
@@ -1153,9 +1197,8 @@ GIT_EXTERN(int) git_diff_to_buf(
 
 /**@}*/
 
-
 /*
- * Misc
+ * Low-level file comparison, invoking callbacks per difference.
  */
 
 /**
@@ -1271,6 +1314,25 @@ GIT_EXTERN(int) git_diff_buffers(
 	git_diff_line_cb line_cb,
 	void *payload);
 
+/* Patch file parsing. */
+
+/**
+ * Options for parsing a diff / patch file.
+ */
+typedef struct {
+	unsigned int version;
+	git_oid_t oid_type;
+} git_diff_parse_options;
+
+/** The current version of the diff parse options structure */
+#define GIT_DIFF_PARSE_OPTIONS_VERSION 1
+
+/** Stack initializer for diff parse options.  Alternatively use
+ * `git_diff_parse_options_init` programmatic initialization.
+ */
+#define GIT_DIFF_PARSE_OPTIONS_INIT \
+	{ GIT_DIFF_PARSE_OPTIONS_VERSION, GIT_OID_DEFAULT }
+
 /**
  * Read the contents of a git patch file into a `git_diff` object.
  *
@@ -1293,7 +1355,11 @@ GIT_EXTERN(int) git_diff_buffers(
 GIT_EXTERN(int) git_diff_from_buffer(
 	git_diff **out,
 	const char *content,
-	size_t content_len);
+	size_t content_len
+#ifdef GIT_EXPERIMENTAL_SHA256
+	, git_diff_parse_options *opts
+#endif
+	);
 
 /**
  * This is an opaque structure which is allocated by `git_diff_get_stats`.
@@ -1394,7 +1460,10 @@ typedef struct git_diff_patchid_options {
 	unsigned int version;
 } git_diff_patchid_options;
 
+/** Current version for the `git_diff_patchid_options` structure */
 #define GIT_DIFF_PATCHID_OPTIONS_VERSION 1
+
+/** Static constructor for `git_diff_patchid_options` */
 #define GIT_DIFF_PATCHID_OPTIONS_INIT { GIT_DIFF_PATCHID_OPTIONS_VERSION }
 
 /**
@@ -1432,8 +1501,7 @@ GIT_EXTERN(int) git_diff_patchid_options_init(
  */
 GIT_EXTERN(int) git_diff_patchid(git_oid *out, git_diff *diff, git_diff_patchid_options *opts);
 
-GIT_END_DECL
-
 /** @} */
+GIT_END_DECL
 
 #endif

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

@@ -8,10 +8,11 @@
 #define INCLUDE_git_email_h__
 
 #include "common.h"
+#include "diff.h"
 
 /**
  * @file git2/email.h
- * @brief Git email formatting and application routines.
+ * @brief Produce email-ready patches
  * @ingroup Git
  * @{
  */
@@ -70,11 +71,14 @@ typedef struct {
 	size_t reroll_number;
 } git_email_create_options;
 
-/*
+/** Current version for the `git_email_create_options` structure */
+#define GIT_EMAIL_CREATE_OPTIONS_VERSION 1
+
+/** Static constructor for `git_email_create_options`
+ *
  * By default, our options include rename detection and binary
  * diffs to match `git format-patch`.
  */
-#define GIT_EMAIL_CREATE_OPTIONS_VERSION 1
 #define GIT_EMAIL_CREATE_OPTIONS_INIT \
 { \
 	GIT_EMAIL_CREATE_OPTIONS_VERSION, \
@@ -83,30 +87,6 @@ typedef struct {
 	GIT_DIFF_FIND_OPTIONS_INIT \
 }
 
-/**
- * Create a diff for a commit in mbox format for sending via email.
- *
- * @param out buffer to store the e-mail patch in
- * @param diff the changes to include in the email
- * @param patch_idx the patch index
- * @param patch_count the total number of patches that will be included
- * @param commit_id the commit id for this change
- * @param summary the commit message for this change
- * @param body optional text to include above the diffstat
- * @param author the person who authored this commit
- * @param opts email creation options
- */
-GIT_EXTERN(int) git_email_create_from_diff(
-	git_buf *out,
-	git_diff *diff,
-	size_t patch_idx,
-	size_t patch_count,
-	const git_oid *commit_id,
-	const char *summary,
-	const char *body,
-	const git_signature *author,
-	const git_email_create_options *opts);
-
 /**
  * Create a diff for a commit in mbox format for sending via email.
  * The commit must not be a merge commit.
@@ -114,14 +94,14 @@ GIT_EXTERN(int) git_email_create_from_diff(
  * @param out buffer to store the e-mail patch in
  * @param commit commit to create a patch for
  * @param opts email creation options
+ * @return 0 or an error code
  */
 GIT_EXTERN(int) git_email_create_from_commit(
 	git_buf *out,
 	git_commit *commit,
 	const git_email_create_options *opts);
 
-GIT_END_DECL
-
 /** @} */
+GIT_END_DECL
 
 #endif

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

@@ -11,7 +11,7 @@
 
 /**
  * @file git2/errors.h
- * @brief Git error handling routines and variables
+ * @brief Error handling routines and variables
  * @ingroup Git
  * @{
  */
@@ -19,25 +19,32 @@ GIT_BEGIN_DECL
 
 /** Generic return codes */
 typedef enum {
-	GIT_OK         =  0,		/**< No error */
+	/**
+	 * No error occurred; the call was successful.
+	 */
+	GIT_OK              =  0,
+
+	/**
+	 * An error occurred; call `git_error_last` for more information.
+	 */
+	GIT_ERROR           = -1,
 
-	GIT_ERROR      = -1,		/**< Generic error */
-	GIT_ENOTFOUND  = -3,		/**< Requested object could not be found */
-	GIT_EEXISTS    = -4,		/**< Object exists preventing operation */
-	GIT_EAMBIGUOUS = -5,		/**< More than one object matches */
-	GIT_EBUFS      = -6,		/**< Output buffer too short to hold data */
+	GIT_ENOTFOUND       = -3,   /**< Requested object could not be found. */
+	GIT_EEXISTS         = -4,   /**< Object exists preventing operation. */
+	GIT_EAMBIGUOUS      = -5,   /**< More than one object matches. */
+	GIT_EBUFS           = -6,   /**< Output buffer too short to hold data. */
 
 	/**
 	 * GIT_EUSER is a special error that is never generated by libgit2
 	 * code.  You can return it from a callback (e.g to stop an iteration)
 	 * to know that it was generated by the callback and not by libgit2.
 	 */
-	GIT_EUSER      = -7,
+	GIT_EUSER           = -7,
 
-	GIT_EBAREREPO       =  -8,	/**< Operation not allowed on bare repository */
-	GIT_EUNBORNBRANCH   =  -9,	/**< HEAD refers to branch with no commits */
-	GIT_EUNMERGED       = -10,	/**< Merge in progress prevented operation */
-	GIT_ENONFASTFORWARD = -11,	/**< Reference was not fast-forwardable */
+	GIT_EBAREREPO       = -8,   /**< Operation not allowed on bare repository. */
+	GIT_EUNBORNBRANCH   = -9,   /**< HEAD refers to branch with no commits. */
+	GIT_EUNMERGED       = -10,  /**< Merge in progress prevented operation */
+	GIT_ENONFASTFORWARD = -11,  /**< Reference was not fast-forwardable */
 	GIT_EINVALIDSPEC    = -12,	/**< Name/ref spec was not in a valid format */
 	GIT_ECONFLICT       = -13,	/**< Checkout conflicts prevented operation */
 	GIT_ELOCKED         = -14,	/**< Lock file prevented operation */
@@ -58,21 +65,17 @@ typedef enum {
 	GIT_EMISMATCH       = -33,	/**< Hashsum mismatch in object */
 	GIT_EINDEXDIRTY     = -34,	/**< Unsaved changes in the index would be overwritten */
 	GIT_EAPPLYFAIL      = -35,	/**< Patch application failed */
-	GIT_EOWNER          = -36	/**< The object is not owned by the current user */
+	GIT_EOWNER          = -36,	/**< The object is not owned by the current user */
+	GIT_TIMEOUT         = -37,	/**< The operation timed out */
+	GIT_EUNCHANGED      = -38,	/**< There were no changes */
+	GIT_ENOTSUPPORTED   = -39,	/**< An option is not supported */
+	GIT_EREADONLY       = -40	/**< The subject is read-only */
 } git_error_code;
 
 /**
- * Structure to store extra details of the last error that occurred.
- *
- * This is kept on a per-thread basis if GIT_THREADS was defined when the
- * library was build, otherwise one is kept globally for the library
+ * Error classes are the category of error. They reflect the area of the
+ * code where an error occurred.
  */
-typedef struct {
-	char *message;
-	int klass;
-} git_error;
-
-/** Error classes */
 typedef enum {
 	GIT_ERROR_NONE = 0,
 	GIT_ERROR_NOMEMORY,
@@ -109,71 +112,43 @@ typedef enum {
 	GIT_ERROR_WORKTREE,
 	GIT_ERROR_SHA,
 	GIT_ERROR_HTTP,
-	GIT_ERROR_INTERNAL
+	GIT_ERROR_INTERNAL,
+	GIT_ERROR_GRAFTS
 } git_error_t;
 
 /**
- * Return the last `git_error` object that was generated for the
- * current thread.
- *
- * The default behaviour of this function is to return NULL if no previous error has occurred.
- * However, libgit2's error strings are not cleared aggressively, so a prior
- * (unrelated) error may be returned. This can be avoided by only calling
- * this function if the prior call to a libgit2 API returned an error.
+ * Structure to store extra details of the last error that occurred.
  *
- * @return A git_error object.
- */
-GIT_EXTERN(const git_error *) git_error_last(void);
-
-/**
- * Clear the last library error that occurred for this thread.
+ * This is kept on a per-thread basis if GIT_THREADS was defined when the
+ * library was build, otherwise one is kept globally for the library
  */
-GIT_EXTERN(void) git_error_clear(void);
+typedef struct {
+	char *message;  /**< The error message for the last error. */
+	int klass;      /**< The category of the last error. @type git_error_t */
+} git_error;
 
 /**
- * Set the error message string for this thread, using `printf`-style
- * formatting.
+ * Return the last `git_error` object that was generated for the
+ * current thread.
  *
- * 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 function will never return NULL.
  *
- * This error message is stored in thread-local storage and only applies
- * to the particular thread that this libgit2 call is made from.
+ * Callers should not rely on this to determine whether an error has
+ * occurred. For error checking, callers should examine the return
+ * codes of libgit2 functions.
  *
- * @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.
+ * This call can only reliably report error messages when an error
+ * has occurred. (It may contain stale information if it is called
+ * after a different function that succeeds.)
  *
- * @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 memory for this object is managed by libgit2. It should not
+ * be freed.
  *
- * 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.
+ * @return A pointer to a `git_error` object that describes the error.
  */
-GIT_EXTERN(void) git_error_set_oom(void);
+GIT_EXTERN(const git_error *) git_error_last(void);
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -14,9 +14,15 @@
 
 /**
  * @file git2/filter.h
- * @brief Git filter APIs
- *
+ * @brief Filters modify files during checkout or commit
  * @ingroup Git
+ *
+ * During checkout, filters update a file from a "canonical" state to
+ * a format appropriate for the local filesystem; during commit, filters
+ * produce the canonical state. For example, on Windows, the line ending
+ * filters _may_ take a canonical state (with Unix-style newlines) in
+ * the repository, and place the contents on-disk with Windows-style
+ * `\r\n` line endings.
  * @{
  */
 GIT_BEGIN_DECL
@@ -79,8 +85,11 @@ typedef struct {
 	git_oid attr_commit_id;
 } git_filter_options;
 
- #define GIT_FILTER_OPTIONS_VERSION 1
- #define GIT_FILTER_OPTIONS_INIT {GIT_FILTER_OPTIONS_VERSION}
+/** Current version for the `git_filter_options` structure */
+#define GIT_FILTER_OPTIONS_VERSION 1
+
+/** Static constructor for `git_filter_options` */
+#define GIT_FILTER_OPTIONS_INIT {GIT_FILTER_OPTIONS_VERSION}
 
 /**
  * A filter that can transform file data
@@ -268,9 +277,7 @@ GIT_EXTERN(int) git_filter_list_stream_blob(
  */
 GIT_EXTERN(void) git_filter_list_free(git_filter_list *filters);
 
-
-GIT_END_DECL
-
 /** @} */
+GIT_END_DECL
 
 #endif

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

@@ -9,6 +9,12 @@
 
 #include "common.h"
 
+/**
+ * @file git2/global.h
+ * @brief libgit2 library initializer and shutdown functionality
+ * @ingroup Git
+ * @{
+ */
 GIT_BEGIN_DECL
 
 /**
@@ -32,7 +38,7 @@ GIT_EXTERN(int) git_libgit2_init(void);
  * many times as `git_libgit2_init()` was called - it will return the
  * number of remainining initializations that have not been shutdown
  * (after this one).
- * 
+ *
  * @return the number of remaining initializations of the library, or an
  * error code.
  */
@@ -40,5 +46,6 @@ GIT_EXTERN(int) git_libgit2_shutdown(void);
 
 /** @} */
 GIT_END_DECL
+
 #endif
 

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

@@ -13,7 +13,7 @@
 
 /**
  * @file git2/graph.h
- * @brief Git graph traversal routines
+ * @brief Graph traversal routines
  * @defgroup git_revwalk Git graph traversal routines
  * @ingroup Git
  * @{
@@ -61,8 +61,8 @@ GIT_EXTERN(int) git_graph_descendant_of(
  *
  * @param repo the repository where the commits exist
  * @param commit a previously loaded commit
- * @param length the number of commits in the provided `descendant_array`
  * @param descendant_array oids of the commits
+ * @param length the number of commits in the provided `descendant_array`
  * @return 1 if the given commit is an ancestor of any of the given potential
  * descendants, 0 if not, error code otherwise.
  */
@@ -74,4 +74,5 @@ GIT_EXTERN(int) git_graph_reachable_from_any(
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -10,6 +10,15 @@
 #include "common.h"
 #include "types.h"
 
+/**
+ * @file git2/ignore.h
+ * @brief Ignore particular untracked files
+ * @ingroup Git
+ * @{
+ *
+ * When examining the repository status, git can optionally ignore
+ * specified untracked files.
+ */
 GIT_BEGIN_DECL
 
 /**
@@ -73,6 +82,7 @@ GIT_EXTERN(int) git_ignore_path_is_ignored(
 	git_repository *repo,
 	const char *path);
 
+/** @} */
 GIT_END_DECL
 
 #endif