New upstream version 1.4.3+dfsg.1

[libgit2.git] / include / git2 / clone.h

diff --git a/include/git2/clone.h b/include/git2/clone.h
index fa2e25b601d4d46c06ef7ad218acffe00fce2f28..3481f254c9d5321df45e781e48bba7eab96ee3c5 100644 (file)
--- a/include/git2/clone.h
+++ b/include/git2/clone.h
@@ -49,7 +49,7 @@ typedef enum {
         * Bypass the git-aware transport, but do not try to use
         * hardlinks.
         */
-       GIT_CLONE_LOCAL_NO_LINKS,
+       GIT_CLONE_LOCAL_NO_LINKS
 } git_clone_local_t;
 
 /**
@@ -66,7 +66,7 @@ typedef enum {
  * @param payload an opaque payload
  * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
  */
-typedef int (*git_remote_create_cb)(
+typedef int GIT_CALLBACK(git_remote_create_cb)(
        git_remote **out,
        git_repository *repo,
        const char *name,
@@ -74,8 +74,8 @@ typedef int (*git_remote_create_cb)(
        void *payload);
 
 /**
- * The signature of a function matchin git_repository_init, with an
- * aditional void * as callback payload.
+ * The signature of a function matching git_repository_init, with an
+ * additional void * as callback payload.
  *
  * Callers of git_clone my provide a function matching this signature
  * to override the repository creation and customization process
@@ -87,7 +87,7 @@ typedef int (*git_remote_create_cb)(
  * @param payload payload specified by the options
  * @return 0, or a negative value to indicate error
  */
-typedef int (*git_repository_create_cb)(
+typedef int GIT_CALLBACK(git_repository_create_cb)(
        git_repository **out,
        const char *path,
        int bare,
@@ -96,31 +96,27 @@ typedef int (*git_repository_create_cb)(
 /**
  * Clone options structure
  *
- * Use the GIT_CLONE_OPTIONS_INIT to get the default settings, like this:
+ * Initialize with `GIT_CLONE_OPTIONS_INIT`. Alternatively, you can
+ * use `git_clone_options_init`.
  *
- *             git_clone_options opts = GIT_CLONE_OPTIONS_INIT;
  */
-
 typedef struct git_clone_options {
        unsigned int version;
 
        /**
         * These options are passed to the checkout step. To disable
         * checkout, set the `checkout_strategy` to
-        * `GIT_CHECKOUT_NONE`. Generally you will want the use
-        * GIT_CHECKOUT_SAFE_CREATE to create all files in the working
-        * directory for the newly cloned repository.
+        * `GIT_CHECKOUT_NONE`.
         */
        git_checkout_options checkout_opts;
 
        /**
-        * Callbacks to use for reporting fetch progress, and for acquiring
-        * credentials in the event they are needed. This parameter is ignored if
-        * the remote_cb parameter is set; if you provide a remote creation
-        * callback, then you have the opportunity to configure remote callbacks in
-        * provided function.
+        * Options which control the fetch, including callbacks.
+        *
+        * The callbacks are used for reporting fetch progress, and for acquiring
+        * credentials in the event they are needed.
         */
-       git_remote_callbacks remote_callbacks;
+       git_fetch_options fetch_opts;
 
        /**
         * Set to zero (false) to create a standard repo, or non-zero
@@ -137,13 +133,7 @@ typedef struct git_clone_options {
         * The name of the branch to checkout. NULL means use the
         * remote's default branch.
         */
-       const char* checkout_branch;
-
-       /**
-        * The identity used when updating the reflog. NULL means to
-        * use the default signature using the config.
-        */
-       git_signature *signature;
+       const char *checkout_branch;
 
        /**
         * A callback used to create the new repository into which to
@@ -174,17 +164,21 @@ typedef struct git_clone_options {
 } git_clone_options;
 
 #define GIT_CLONE_OPTIONS_VERSION 1
-#define GIT_CLONE_OPTIONS_INIT {GIT_CLONE_OPTIONS_VERSION, {GIT_CHECKOUT_OPTIONS_VERSION, GIT_CHECKOUT_SAFE_CREATE}, GIT_REMOTE_CALLBACKS_INIT}
+#define GIT_CLONE_OPTIONS_INIT { GIT_CLONE_OPTIONS_VERSION, \
+       { GIT_CHECKOUT_OPTIONS_VERSION, GIT_CHECKOUT_SAFE }, \
+       GIT_FETCH_OPTIONS_INIT }
 
 /**
- * Initializes a `git_clone_options` with default values. Equivalent to
- * creating an instance with GIT_CLONE_OPTIONS_INIT.
+ * Initialize git_clone_options structure
+ *
+ * Initializes a `git_clone_options` with default values. Equivalent to creating
+ * an instance with GIT_CLONE_OPTIONS_INIT.
  *
- * @param opts The `git_clone_options` struct to initialize
- * @param version Version of struct; pass `GIT_CLONE_OPTIONS_VERSION`
+ * @param opts The `git_clone_options` struct to initialize.
+ * @param version The struct version; pass `GIT_CLONE_OPTIONS_VERSION`.
  * @return Zero on success; -1 on failure.
  */
-GIT_EXTERN(int) git_clone_init_options(
+GIT_EXTERN(int) git_clone_options_init(
        git_clone_options *opts,
        unsigned int version);
 
@@ -202,7 +196,7 @@ GIT_EXTERN(int) git_clone_init_options(
  *        function works as though GIT_OPTIONS_INIT were passed.
  * @return 0 on success, any non-zero return value from a callback
  *         function, or a negative value to indicate an error (use
- *         `giterr_last` for a detailed error message)
+ *         `git_error_last` for a detailed error message)
  */
 GIT_EXTERN(int) git_clone(
        git_repository **out,