rugged 1.3.1 → 1.9.0

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
  * @{
  */
@@ -36,7 +36,7 @@ struct git_odb_backend {
 		void **, size_t *, git_object_t *, git_odb_backend *, const git_oid *);
 
 	/* To find a unique object given a prefix of its oid.  The oid given
-	 * must be so that the remaining (GIT_OID_HEXSZ - len)*4 bits are 0s.
+	 * must be so that the remaining (GIT_OID_SHA1_HEXSIZE - len)*4 bits are 0s.
 	 */
 	int GIT_CALLBACK(read_prefix)(
 		git_oid *, void **, size_t *, git_object_t *,
@@ -69,11 +69,8 @@ struct git_odb_backend {
 	 * If the backend implements a refreshing mechanism, it should be exposed
 	 * through this endpoint. Each call to `git_odb_refresh()` will invoke it.
 	 *
-	 * However, the backend implementation should try to stay up-to-date as much
-	 * as possible by itself as libgit2 will not automatically invoke
-	 * `git_odb_refresh()`. For instance, a potential strategy for the backend
-	 * implementation to achieve this could be to internally invoke this
-	 * endpoint on failed lookups (ie. `exists()`, `read()`, `read_header()`).
+	 * The odb layer will automatically call this when needed on failed
+	 * lookups (ie. `exists()`, `read()`, `read_header()`).
 	 */
 	int GIT_CALLBACK(refresh)(git_odb_backend *);
 
@@ -109,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}
 
 /**
@@ -170,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

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

@@ -12,9 +12,9 @@
 #include "git2/oid.h"
 
 /**
- * @file git2/refdb_backend.h
- * @brief Git custom refs backend functions
- * @defgroup git_refdb_backend Git custom refs backend API
+ * @file git2/sys/refdb_backend.h
+ * @brief Custom reference database backends for refs storage
+ * @defgroup git_refdb_backend Custom reference database backends for refs storage
  * @ingroup Git
  * @{
  */
@@ -65,9 +65,9 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg exists The implementation shall set this to `0` if a ref does
+	 * @param exists The implementation shall set this to `0` if a ref does
 	 *             not exist, otherwise to `1`.
-	 * @arg ref_name The reference's name that should be checked for
+	 * @param ref_name The reference's name that should be checked for
 	 *               existence.
 	 * @return `0` on success, a negative error value code.
 	 */
@@ -81,9 +81,9 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg out The implementation shall set this to the allocated
+	 * @param out The implementation shall set this to the allocated
 	 *          reference, if it could be found, otherwise to `NULL`.
-	 * @arg ref_name The reference's name that should be checked for
+	 * @param ref_name The reference's name that should be checked for
 	 *               existence.
 	 * @return `0` on success, `GIT_ENOTFOUND` if the reference does
 	 *         exist, otherwise a negative error code.
@@ -98,12 +98,12 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg out The implementation shall set this to the allocated
+	 * @param out The implementation shall set this to the allocated
 	 *          reference iterator. A custom structure may be used with an
 	 *          embedded `git_reference_iterator` structure. Both `next`
 	 *          and `next_name` functions of `git_reference_iterator` need
 	 *          to be populated.
-	 * @arg glob A pattern to filter references by. If given, the iterator
+	 * @param glob A pattern to filter references by. If given, the iterator
 	 *           shall only return references that match the glob when
 	 *           passed to `wildmatch`.
 	 * @return `0` on success, otherwise a negative error code.
@@ -118,20 +118,20 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg ref The reference to persist. May either be a symbolic or
+	 * @param ref The reference to persist. May either be a symbolic or
 	 *          direct reference.
-	 * @arg force Whether to write the reference if a reference with the
+	 * @param force Whether to write the reference if a reference with the
 	 *            same name already exists.
-	 * @arg who The person updating the reference. Shall be used to create
+	 * @param who The person updating the reference. Shall be used to create
 	 *          a reflog entry.
-	 * @arg message The message detailing what kind of reference update is
+	 * @param message The message detailing what kind of reference update is
 	 *              performed. Shall be used to create a reflog entry.
-	 * @arg old If not `NULL` and `force` is not set, then the
+	 * @param old If not `NULL` and `force` is not set, then the
 	 *          implementation needs to ensure that the reference is currently at
 	 *          the given OID before writing the new value. If both `old`
 	 *          and `old_target` are `NULL`, then the reference should not
 	 *          exist at the point of writing.
-	 * @arg old_target If not `NULL` and `force` is not set, then the
+	 * @param old_target If not `NULL` and `force` is not set, then the
 	 *                 implementation needs to ensure that the symbolic
 	 *                 reference is currently at the given target before
 	 *                 writing the new value. If both `old` and
@@ -149,15 +149,15 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg out The implementation shall set this to the newly created
+	 * @param out The implementation shall set this to the newly created
 	 *          reference or `NULL` on error.
-	 * @arg old_name The current name of the reference that is to be renamed.
-	 * @arg new_name The new name that the old reference shall be renamed to.
-	 * @arg force Whether to write the reference if a reference with the
+	 * @param old_name The current name of the reference that is to be renamed.
+	 * @param new_name The new name that the old reference shall be renamed to.
+	 * @param force Whether to write the reference if a reference with the
 	 *            target name already exists.
-	 * @arg who The person updating the reference. Shall be used to create
+	 * @param who The person updating the reference. Shall be used to create
 	 *          a reflog entry.
-	 * @arg message The message detailing what kind of reference update is
+	 * @param message The message detailing what kind of reference update is
 	 *              performed. Shall be used to create a reflog entry.
 	 * @return `0` on success, otherwise a negative error code.
 	 */
@@ -173,11 +173,11 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg ref_name The name of the reference name that shall be deleted.
-	 * @arg old_id If not `NULL` and `force` is not set, then the
+	 * @param ref_name The name of the reference name that shall be deleted.
+	 * @param old_id If not `NULL` and `force` is not set, then the
 	 *             implementation needs to ensure that the reference is currently at
 	 *             the given OID before writing the new value.
-	 * @arg old_target If not `NULL` and `force` is not set, then the
+	 * @param old_target If not `NULL` and `force` is not set, then the
 	 *                 implementation needs to ensure that the symbolic
 	 *                 reference is currently at the given target before
 	 *                 writing the new value.
@@ -243,7 +243,7 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg reflog The complete reference log for a given reference. Note
+	 * @param reflog The complete reference log for a given reference. Note
 	 *             that this may contain entries that have already been
 	 *             written to disk.
 	 * @return `0` on success, a negative error code otherwise
@@ -255,8 +255,8 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg old_name The name of old reference whose reflog shall be renamed from.
-	 * @arg new_name The name of new reference whose reflog shall be renamed to.
+	 * @param old_name The name of old reference whose reflog shall be renamed from.
+	 * @param new_name The name of new reference whose reflog shall be renamed to.
 	 * @return `0` on success, a negative error code otherwise
 	 */
 	int GIT_CALLBACK(reflog_rename)(git_refdb_backend *_backend, const char *old_name, const char *new_name);
@@ -266,7 +266,7 @@ struct git_refdb_backend {
 	 *
 	 * A refdb implementation must provide this function.
 	 *
-	 * @arg name The name of the reference whose reflog shall be deleted.
+	 * @param name The name of the reference whose reflog shall be deleted.
 	 * @return `0` on success, a negative error code otherwise
 	 */
 	int GIT_CALLBACK(reflog_delete)(git_refdb_backend *backend, const char *name);
@@ -277,9 +277,9 @@ struct git_refdb_backend {
 	 * A refdb implementation may provide this function; if it is not
 	 * provided, the transaction API will fail to work.
 	 *
-	 * @arg payload_out Opaque parameter that will be passed verbosely to
+	 * @param payload_out Opaque parameter that will be passed verbosely to
 	 *                  `unlock`.
-	 * @arg refname Reference that shall be locked.
+	 * @param refname Reference that shall be locked.
 	 * @return `0` on success, a negative error code otherwise
 	 */
 	int GIT_CALLBACK(lock)(void **payload_out, git_refdb_backend *backend, const char *refname);
@@ -294,16 +294,16 @@ struct git_refdb_backend {
 	 * A refdb implementation must provide this function if a `lock`
 	 * implementation is provided.
 	 *
-	 * @arg payload The payload returned by `lock`.
-	 * @arg success `1` if a reference should be updated, `2` if
+	 * @param payload The payload returned by `lock`.
+	 * @param success `1` if a reference should be updated, `2` if
 	 *              a reference should be deleted, `0` if the lock must be
 	 *              discarded.
-	 * @arg update_reflog `1` in case the reflog should be updated, `0`
+	 * @param update_reflog `1` in case the reflog should be updated, `0`
 	 *                    otherwise.
-	 * @arg ref The reference which should be unlocked.
-	 * @arg who The person updating the reference. Shall be used to create
+	 * @param ref The reference which should be unlocked.
+	 * @param who The person updating the reference. Shall be used to create
 	 *          a reflog entry in case `update_reflog` is set.
-	 * @arg message The message detailing what kind of reference update is
+	 * @param message The message detailing what kind of reference update is
 	 *              performed. Shall be used to create a reflog entry in
 	 *              case `update_reflog` is set.
 	 * @return `0` on success, a negative error code otherwise
@@ -312,7 +312,10 @@ struct git_refdb_backend {
 		      const git_reference *ref, const git_signature *sig, const char *message);
 };
 
+/** Current version for the `git_refdb_backend_options` structure */
 #define GIT_REFDB_BACKEND_VERSION 1
+
+/** Static constructor for `git_refdb_backend_options` */
 #define GIT_REFDB_BACKEND_INIT {GIT_REFDB_BACKEND_VERSION}
 
 /**
@@ -356,6 +359,7 @@ GIT_EXTERN(int) git_refdb_set_backend(
 	git_refdb *refdb,
 	git_refdb_backend *backend);
 
+/** @} */
 GIT_END_DECL
 
 #endif

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

@@ -13,8 +13,8 @@
 
 /**
  * @file git2/sys/refs.h
- * @brief Low-level Git ref creation
- * @defgroup git_backend Git custom backend APIs
+ * @brief Low-level git reference creation
+ * @defgroup git_backend Low-level git reference creation
  * @ingroup Git
  * @{
  */
@@ -46,4 +46,5 @@ GIT_EXTERN(git_reference *) git_reference__alloc_symbolic(
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -0,0 +1,53 @@
+/*
+ * 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_remote_h
+#define INCLUDE_sys_git_remote_h
+
+#include "git2/remote.h"
+
+/**
+ * @file git2/sys/remote.h
+ * @brief Low-level remote functionality for custom transports
+ * @defgroup git_remote Low-level remote functionality for custom transports
+ * @ingroup Git
+ * @{
+*/
+
+GIT_BEGIN_DECL
+
+/**
+ * A remote's capabilities.
+ */
+typedef enum {
+	/** Remote supports fetching an advertised object by ID. */
+	GIT_REMOTE_CAPABILITY_TIP_OID = (1 << 0),
+
+	/** Remote supports fetching an individual reachable object. */
+	GIT_REMOTE_CAPABILITY_REACHABLE_OID = (1 << 1),
+
+	/** Remote supports push options. */
+	GIT_REMOTE_CAPABILITY_PUSH_OPTIONS = (1 << 2),
+} git_remote_capability_t;
+
+/**
+ * Disposes libgit2-initialized fields from a git_remote_connect_options.
+ * This should only be used for git_remote_connect_options returned by
+ * git_transport_remote_connect_options.
+ *
+ * Note that this does not free the `git_remote_connect_options` itself, just
+ * the memory pointed to by it.
+ *
+ * @param opts The `git_remote_connect_options` struct to dispose.
+ */
+GIT_EXTERN(void) git_remote_connect_options_dispose(
+		git_remote_connect_options *opts);
+
+/** @} */
+GIT_END_DECL
+
+#endif

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

@@ -9,16 +9,71 @@
 
 #include "git2/common.h"
 #include "git2/types.h"
+#include "git2/oid.h"
 
 /**
  * @file git2/sys/repository.h
- * @brief Git repository custom implementation routines
- * @defgroup git_backend Git custom backend APIs
+ * @brief Custom repository handling
+ * @defgroup git_repository Custom repository handling
  * @ingroup Git
  * @{
  */
 GIT_BEGIN_DECL
 
+#ifdef GIT_EXPERIMENTAL_SHA256
+
+/**
+ * The options for creating an repository from scratch.
+ *
+ * Initialize with `GIT_REPOSITORY_NEW_OPTIONS_INIT`. Alternatively,
+ * you can use `git_repository_new_options_init`.
+ *
+ * @options[version] GIT_REPOSITORY_NEW_OPTIONS_VERSION
+ * @options[init_macro] GIT_REPOSITORY_NEW_OPTIONS_INIT
+ * @options[init_function] git_repository_new_options_init
+ */
+typedef struct git_repository_new_options {
+	unsigned int version; /**< The version */
+
+	/**
+	 * The object ID type for the object IDs that exist in the index.
+	 *
+	 * If this is not specified, this defaults to `GIT_OID_SHA1`.
+	 */
+	git_oid_t oid_type;
+} git_repository_new_options;
+
+/** Current version for the `git_repository_new_options` structure */
+#define GIT_REPOSITORY_NEW_OPTIONS_VERSION 1
+
+/** Static constructor for `git_repository_new_options` */
+#define GIT_REPOSITORY_NEW_OPTIONS_INIT { GIT_REPOSITORY_NEW_OPTIONS_VERSION }
+
+/**
+ * Initialize git_repository_new_options structure
+ *
+ * Initializes a `git_repository_new_options` with default values.
+ * Equivalent to creating an instance with
+ * `GIT_REPOSITORY_NEW_OPTIONS_INIT`.
+ *
+ * @param opts The `git_repository_new_options` struct to initialize.
+ * @param version The struct version; pass `GIT_REPOSITORY_NEW_OPTIONS_VERSION`.
+ * @return Zero on success; -1 on failure.
+ */
+GIT_EXTERN(int) git_repository_new_options_init(
+	git_repository_new_options *opts,
+	unsigned int version);
+
+/**
+ * Create a new repository with no backends.
+ *
+ * @param[out] out The blank repository
+ * @param opts the options for repository creation, or NULL for defaults
+ * @return 0 on success, or an error code
+ */
+GIT_EXTERN(int) git_repository_new(git_repository **out, git_repository_new_options *opts);
+#else
+
 /**
  * Create a new repository with neither backends nor config object
  *
@@ -29,11 +84,13 @@ GIT_BEGIN_DECL
  * can fail to function properly: locations under $GIT_DIR, $GIT_COMMON_DIR,
  * or $GIT_INFO_DIR are impacted.
  *
- * @param out The blank repository
+ * @param[out] out The blank repository
  * @return 0 on success, or an error code
  */
 GIT_EXTERN(int) git_repository_new(git_repository **out);
 
+#endif
+
 /**
  * Reset all the internal state in a repository.
  *
@@ -156,6 +213,7 @@ GIT_EXTERN(int) git_repository_set_bare(git_repository *repo);
  * and caches them so that subsequent calls to `git_submodule_lookup` are O(1).
  *
  * @param repo the repository whose submodules will be cached.
+ * @return 0 on success, or an error code
  */
 GIT_EXTERN(int) git_repository_submodule_cache_all(
 	git_repository *repo);
@@ -171,10 +229,12 @@ GIT_EXTERN(int) git_repository_submodule_cache_all(
  * of these has changed, the cache might become invalid.
  *
  * @param repo the repository whose submodule cache will be cleared
+ * @return 0 on success, or an error code
  */
 GIT_EXTERN(int) git_repository_submodule_cache_clear(
 	git_repository *repo);
 
 /** @} */
 GIT_END_DECL
+
 #endif

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

@@ -11,8 +11,16 @@
 #include "git2/types.h"
 #include "git2/proxy.h"
 
+/**
+ * @file git2/sys/stream.h
+ * @brief Streaming file I/O functionality
+ * @defgroup git_stream Streaming file I/O functionality
+ * @ingroup Git
+ * @{
+ */
 GIT_BEGIN_DECL
 
+/** Current version for the `git_stream` structures */
 #define GIT_STREAM_VERSION 1
 
 /**
@@ -29,8 +37,22 @@ GIT_BEGIN_DECL
 typedef struct git_stream {
 	int version;
 
-	int encrypted;
-	int proxy_support;
+	unsigned int encrypted : 1,
+	             proxy_support : 1;
+
+	/**
+	 * Timeout for read and write operations; can be set to `0` to
+	 * block indefinitely.
+	 */
+	int timeout;
+
+	/**
+	 * Timeout to connect to the remote server; can be set to `0`
+	 * to use the system defaults. This can be shorter than the
+	 * system default - often 75 seconds - but cannot be longer.
+	 */
+	int connect_timeout;
+
 	int GIT_CALLBACK(connect)(struct git_stream *);
 	int GIT_CALLBACK(certificate)(git_cert **, struct git_stream *);
 	int GIT_CALLBACK(set_proxy)(struct git_stream *, const git_proxy_options *proxy_opts);
@@ -79,7 +101,7 @@ typedef enum {
 	GIT_STREAM_STANDARD = 1,
 
 	/** A TLS-encrypted socket. */
-	GIT_STREAM_TLS = 2,
+	GIT_STREAM_TLS = 2
 } git_stream_t;
 
 /**
@@ -133,6 +155,7 @@ GIT_EXTERN(int) git_stream_register_tls(git_stream_cb ctor);
 
 #endif
 
+/**@}*/
 GIT_END_DECL
 
 #endif