Imported Upstream version 2.9.3
[platform/upstream/git.git] / Documentation / gitremote-helpers.txt
index 8edf72c..a4de50a 100644 (file)
@@ -43,7 +43,7 @@ arguments. The first argument specifies a remote repository as in Git;
 it is either the name of a configured remote or a URL. The second
 argument specifies a URL; it is usually of the form
 '<transport>://<address>', but any arbitrary string is possible.
-The 'GIT_DIR' environment variable is set up for the remote helper
+The `GIT_DIR` environment variable is set up for the remote helper
 and can be used to determine where to store additional data or from
 which directory to invoke auxiliary Git commands.
 
@@ -61,10 +61,10 @@ argument. If such a URL is encountered directly on the command line,
 the first argument is '<address>', and if it is encountered in a
 configured remote, the first argument is the name of that remote.
 
-Additionally, when a configured remote has 'remote.<name>.vcs' set to
+Additionally, when a configured remote has `remote.<name>.vcs` set to
 '<transport>', Git explicitly invokes 'git remote-<transport>' with
 '<name>' as the first argument. If set, the second argument is
-'remote.<name>.url'; otherwise, the second argument is omitted.
+`remote.<name>.url`; otherwise, the second argument is omitted.
 
 INPUT FORMAT
 ------------
@@ -210,17 +210,17 @@ the remote repository.
 'export-marks' <file>::
        This modifies the 'export' capability, instructing Git to dump the
        internal marks table to <file> when complete. For details,
-       read up on '--export-marks=<file>' in linkgit:git-fast-export[1].
+       read up on `--export-marks=<file>` in linkgit:git-fast-export[1].
 
 'import-marks' <file>::
        This modifies the 'export' capability, instructing Git to load the
        marks specified in <file> before processing any input. For details,
-       read up on '--import-marks=<file>' in linkgit:git-fast-export[1].
+       read up on `--import-marks=<file>` in linkgit:git-fast-export[1].
 
 'signed-tags'::
        This modifies the 'export' capability, instructing Git to pass
-       '--signed-tags=verbatim' to linkgit:git-fast-export[1].  In the
-       absence of this capability, Git will use '--signed-tags=warn-strip'.
+       `--signed-tags=verbatim` to linkgit:git-fast-export[1].  In the
+       absence of this capability, Git will use `--signed-tags=warn-strip`.
 
 
 
@@ -298,7 +298,7 @@ Supported if the helper has the "fetch" capability.
        is followed by a blank line). For example, the following would
        be two batches of 'push', the first asking the remote-helper
        to push the local ref 'master' to the remote ref 'master' and
-       the local 'HEAD' to the remote 'branch', and the second
+       the local `HEAD` to the remote 'branch', and the second
        asking to push ref 'foo' to ref 'bar' (forced update requested
        by the '+').
 +
@@ -408,14 +408,14 @@ set by Git if the remote helper has the 'option' capability.
        of <n> correspond to the number of -v flags passed on the
        command line.
 
-'option progress' \{'true'|'false'\}::
+'option progress' {'true'|'false'}::
        Enables (or disables) progress messages displayed by the
        transport helper during a command.
 
 'option depth' <depth>::
        Deepens the history of a shallow repository.
 
-'option followtags' \{'true'|'false'\}::
+'option followtags' {'true'|'false'}::
        If enabled the helper should automatically fetch annotated
        tag objects if the object the tag points at was transferred
        during the fetch command.  If the tag is not fetched by
@@ -423,7 +423,7 @@ set by Git if the remote helper has the 'option' capability.
        ask for the tag specifically.  Some helpers may be able to
        use this option to avoid a second network connection.
 
-'option dry-run' \{'true'|'false'\}:
+'option dry-run' {'true'|'false'}:
        If true, pretend the operation completed successfully,
        but don't actually change any repository data.  For most
        helpers this only applies to the 'push', if supported.
@@ -434,20 +434,23 @@ set by Git if the remote helper has the 'option' capability.
        must not rely on this option being set before
        connect request occurs.
 
-'option check-connectivity' \{'true'|'false'\}::
+'option check-connectivity' {'true'|'false'}::
        Request the helper to check connectivity of a clone.
 
-'option force' \{'true'|'false'\}::
+'option force' {'true'|'false'}::
        Request the helper to perform a force update.  Defaults to
        'false'.
 
-'option cloning \{'true'|'false'\}::
+'option cloning {'true'|'false'}::
        Notify the helper this is a clone request (i.e. the current
        repository is guaranteed empty).
 
-'option update-shallow \{'true'|'false'\}::
+'option update-shallow {'true'|'false'}::
        Allow to extend .git/shallow if the new refs require it.
 
+'option pushcert {'true'|'false'}::
+       GPG sign pushes.
+
 SEE ALSO
 --------
 linkgit:git-remote[1]