2019-03-25 22:41:36 +01:00
|
|
|
gitremote-helpers(7)
|
2013-01-31 22:59:50 +01:00
|
|
|
====================
|
2009-08-05 07:01:53 +02:00
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2013-01-31 22:59:50 +01:00
|
|
|
gitremote-helpers - Helper programs to interact with remote repositories
|
2009-08-05 07:01:53 +02:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2011-07-02 04:38:26 +02:00
|
|
|
[verse]
|
2010-04-07 07:44:41 +02:00
|
|
|
'git remote-<transport>' <repository> [<URL>]
|
2009-08-05 07:01:53 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
2010-03-28 20:03:50 +02:00
|
|
|
Remote helper programs are normally not used directly by end users,
|
2013-01-21 20:17:53 +01:00
|
|
|
but they are invoked by Git when it needs to interact with remote
|
|
|
|
|
repositories Git does not support natively. A given helper will
|
|
|
|
|
implement a subset of the capabilities documented here. When Git
|
2010-03-28 20:03:50 +02:00
|
|
|
needs to interact with a repository using a remote helper, it spawns
|
|
|
|
|
the helper as an independent process, sends commands to the helper's
|
|
|
|
|
standard input, and expects results from the helper's standard
|
|
|
|
|
output. Because a remote helper runs as an independent process from
|
2013-01-21 20:17:53 +01:00
|
|
|
Git, there is no need to re-link Git to add a new helper, nor any
|
|
|
|
|
need to link the helper with the implementation of Git.
|
2010-03-28 20:03:50 +02:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
Every helper must support the "capabilities" command, which Git
|
2011-08-30 05:56:08 +02:00
|
|
|
uses to determine what other commands the helper will accept. Those
|
|
|
|
|
other commands can be used to discover and update remote refs,
|
|
|
|
|
transport objects between the object database and the remote repository,
|
|
|
|
|
and update the local object store.
|
2010-03-28 20:03:50 +02:00
|
|
|
|
|
|
|
|
Git comes with a "curl" family of remote helpers, that handle various
|
|
|
|
|
transport protocols, such as 'git-remote-http', 'git-remote-https',
|
|
|
|
|
'git-remote-ftp' and 'git-remote-ftps'. They implement the capabilities
|
|
|
|
|
'fetch', 'option', and 'push'.
|
2009-08-05 07:01:53 +02:00
|
|
|
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
INVOCATION
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Remote helper programs are invoked with one or (optionally) two
|
2013-01-21 20:17:53 +01:00
|
|
|
arguments. The first argument specifies a remote repository as in Git;
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
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.
|
2016-06-08 00:35:06 +02:00
|
|
|
The `GIT_DIR` environment variable is set up for the remote helper
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
and can be used to determine where to store additional data or from
|
2013-01-21 20:17:53 +01:00
|
|
|
which directory to invoke auxiliary Git commands.
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
When Git encounters a URL of the form '<transport>://<address>', where
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
'<transport>' is a protocol that it cannot handle natively, it
|
|
|
|
|
automatically invokes 'git remote-<transport>' with the full URL as
|
|
|
|
|
the second argument. If such a URL is encountered directly on the
|
|
|
|
|
command line, the first argument is the same as the second, and if it
|
|
|
|
|
is encountered in a configured remote, the first argument is the name
|
|
|
|
|
of that remote.
|
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
A URL of the form '<transport>::<address>' explicitly instructs Git to
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
invoke 'git remote-<transport>' with '<address>' as the second
|
|
|
|
|
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.
|
|
|
|
|
|
2016-06-08 19:23:16 +02:00
|
|
|
Additionally, when a configured remote has `remote.<name>.vcs` set to
|
2013-01-21 20:17:53 +01:00
|
|
|
'<transport>', Git explicitly invokes 'git remote-<transport>' with
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
'<name>' as the first argument. If set, the second argument is
|
2016-06-08 19:23:16 +02:00
|
|
|
`remote.<name>.url`; otherwise, the second argument is omitted.
|
git-remote-helpers.txt: document invocation before input format
In the distant past, the order things were documented was
'Invocation', 'Commands', 'Capabilities', ...
Then it was decided that before giving a list of Commands, there
should be an overall description of the 'Input format', which was
a wise decision. However, this description was put as the very
first thing, with the rationale that any implementor would want
to know that first.
However, it seems an implementor would actually first need to
know how the remote helper will be invoked, so moving
'Invocation' to the front again seems logical. Moreover, we now
don't switch from discussing the input format to the invocation
style and then back to input related stuff.
Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-28 00:03:21 +01:00
|
|
|
|
2011-08-30 05:56:08 +02:00
|
|
|
INPUT FORMAT
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Git sends the remote helper a list of commands on standard input, one
|
|
|
|
|
per line. The first command is always the 'capabilities' command, in
|
|
|
|
|
response to which the remote helper must print a list of the
|
|
|
|
|
capabilities it supports (see below) followed by a blank line. The
|
|
|
|
|
response to the capabilities command determines what commands Git uses
|
|
|
|
|
in the remainder of the command stream.
|
|
|
|
|
|
|
|
|
|
The command stream is terminated by a blank line. In some cases
|
|
|
|
|
(indicated in the documentation of the relevant commands), this blank
|
|
|
|
|
line is followed by a payload in some other protocol (e.g., the pack
|
|
|
|
|
protocol), while in others it indicates the end of input.
|
|
|
|
|
|
|
|
|
|
Capabilities
|
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Each remote helper is expected to support only a subset of commands.
|
2013-01-21 20:17:53 +01:00
|
|
|
The operations a helper supports are declared to Git in the response
|
2011-08-30 05:56:08 +02:00
|
|
|
to the `capabilities` command (see COMMANDS, below).
|
|
|
|
|
|
2012-11-28 00:03:24 +01:00
|
|
|
In the following, we list all defined capabilities and for
|
|
|
|
|
each we list which commands a helper with that capability
|
|
|
|
|
must provide.
|
2012-11-28 00:03:22 +01:00
|
|
|
|
2011-08-30 05:56:08 +02:00
|
|
|
Capabilities for Pushing
|
2012-11-28 00:03:24 +01:00
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-08-30 05:56:08 +02:00
|
|
|
'connect'::
|
|
|
|
|
Can attempt to connect to 'git receive-pack' (for pushing),
|
2012-11-28 00:03:24 +01:00
|
|
|
'git upload-pack', etc for communication using
|
|
|
|
|
git's native packfile protocol. This
|
|
|
|
|
requires a bidirectional, full-duplex connection.
|
2011-08-30 05:56:08 +02:00
|
|
|
+
|
|
|
|
|
Supported commands: 'connect'.
|
|
|
|
|
|
2018-03-15 18:31:34 +01:00
|
|
|
'stateless-connect'::
|
|
|
|
|
Experimental; for internal use only.
|
|
|
|
|
Can attempt to connect to a remote server for communication
|
|
|
|
|
using git's wire-protocol version 2. See the documentation
|
|
|
|
|
for the stateless-connect command for more information.
|
|
|
|
|
+
|
|
|
|
|
Supported commands: 'stateless-connect'.
|
|
|
|
|
|
2011-08-30 05:56:08 +02:00
|
|
|
'push'::
|
|
|
|
|
Can discover remote refs and push local commits and the
|
|
|
|
|
history leading up to them to new or existing remote refs.
|
|
|
|
|
+
|
|
|
|
|
Supported commands: 'list for-push', 'push'.
|
|
|
|
|
|
2012-11-28 00:03:22 +01:00
|
|
|
'export'::
|
|
|
|
|
Can discover remote refs and push specified objects from a
|
|
|
|
|
fast-import stream to remote refs.
|
|
|
|
|
+
|
|
|
|
|
Supported commands: 'list for-push', 'export'.
|
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
If a helper advertises 'connect', Git will use it if possible and
|
2012-11-28 00:03:22 +01:00
|
|
|
fall back to another capability if the helper requests so when
|
|
|
|
|
connecting (see the 'connect' command under COMMANDS).
|
2013-01-21 20:17:53 +01:00
|
|
|
When choosing between 'push' and 'export', Git prefers 'push'.
|
2012-11-28 00:03:22 +01:00
|
|
|
Other frontends may have some other order of preference.
|
|
|
|
|
|
2013-09-03 17:45:14 +02:00
|
|
|
'no-private-update'::
|
|
|
|
|
When using the 'refspec' capability, git normally updates the
|
|
|
|
|
private ref on successful push. This update is disabled when
|
|
|
|
|
the remote-helper declares the capability 'no-private-update'.
|
|
|
|
|
|
2011-08-30 05:56:08 +02:00
|
|
|
|
|
|
|
|
Capabilities for Fetching
|
2012-11-28 00:03:24 +01:00
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-08-30 05:56:08 +02:00
|
|
|
'connect'::
|
|
|
|
|
Can try to connect to 'git upload-pack' (for fetching),
|
|
|
|
|
'git receive-pack', etc for communication using the
|
2013-01-21 20:17:53 +01:00
|
|
|
Git's native packfile protocol. This
|
2012-11-28 00:03:24 +01:00
|
|
|
requires a bidirectional, full-duplex connection.
|
2011-08-30 05:56:08 +02:00
|
|
|
+
|
|
|
|
|
Supported commands: 'connect'.
|
|
|
|
|
|
2018-03-15 18:31:34 +01:00
|
|
|
'stateless-connect'::
|
|
|
|
|
Experimental; for internal use only.
|
|
|
|
|
Can attempt to connect to a remote server for communication
|
|
|
|
|
using git's wire-protocol version 2. See the documentation
|
|
|
|
|
for the stateless-connect command for more information.
|
|
|
|
|
+
|
|
|
|
|
Supported commands: 'stateless-connect'.
|
|
|
|
|
|
2011-08-30 05:56:08 +02:00
|
|
|
'fetch'::
|
|
|
|
|
Can discover remote refs and transfer objects reachable from
|
|
|
|
|
them to the local object store.
|
|
|
|
|
+
|
|
|
|
|
Supported commands: 'list', 'fetch'.
|
|
|
|
|
|
|
|
|
|
'import'::
|
|
|
|
|
Can discover remote refs and output objects reachable from
|
|
|
|
|
them as a stream in fast-import format.
|
|
|
|
|
+
|
|
|
|
|
Supported commands: 'list', 'import'.
|
|
|
|
|
|
2013-07-21 10:18:05 +02:00
|
|
|
'check-connectivity'::
|
|
|
|
|
Can guarantee that when a clone is requested, the received
|
|
|
|
|
pack is self contained and is connected.
|
|
|
|
|
|
2022-08-09 15:11:39 +02:00
|
|
|
'get'::
|
|
|
|
|
Can use the 'get' command to download a file from a given URI.
|
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
If a helper advertises 'connect', Git will use it if possible and
|
2011-08-30 05:56:08 +02:00
|
|
|
fall back to another capability if the helper requests so when
|
|
|
|
|
connecting (see the 'connect' command under COMMANDS).
|
2013-01-21 20:17:53 +01:00
|
|
|
When choosing between 'fetch' and 'import', Git prefers 'fetch'.
|
2011-08-30 05:56:08 +02:00
|
|
|
Other frontends may have some other order of preference.
|
|
|
|
|
|
2012-11-28 00:03:24 +01:00
|
|
|
Miscellaneous capabilities
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
'option'::
|
|
|
|
|
For specifying settings like `verbosity` (how much output to
|
|
|
|
|
write to stderr) and `depth` (how much history is wanted in the
|
|
|
|
|
case of a shallow clone) that affect how other commands are
|
|
|
|
|
carried out.
|
|
|
|
|
|
2011-08-30 05:56:08 +02:00
|
|
|
'refspec' <refspec>::
|
2013-04-18 06:14:29 +02:00
|
|
|
For remote helpers that implement 'import' or 'export', this capability
|
|
|
|
|
allows the refs to be constrained to a private namespace, instead of
|
|
|
|
|
writing to refs/heads or refs/remotes directly.
|
2012-11-28 00:03:24 +01:00
|
|
|
It is recommended that all importers providing the 'import'
|
2013-04-18 06:14:30 +02:00
|
|
|
capability use this. It's mandatory for 'export'.
|
2011-08-30 05:56:08 +02:00
|
|
|
+
|
2012-11-28 00:03:24 +01:00
|
|
|
A helper advertising the capability
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
`refspec refs/heads/*:refs/svn/origin/branches/*`
|
2012-11-28 00:03:24 +01:00
|
|
|
is saying that, when it is asked to `import refs/heads/topic`, the
|
|
|
|
|
stream it outputs will update the `refs/svn/origin/branches/topic`
|
|
|
|
|
ref.
|
2011-08-30 05:56:08 +02:00
|
|
|
+
|
|
|
|
|
This capability can be advertised multiple times. The first
|
|
|
|
|
applicable refspec takes precedence. The left-hand of refspecs
|
|
|
|
|
advertised with this capability must cover all refs reported by
|
2013-04-18 06:14:28 +02:00
|
|
|
the list command. If no 'refspec' capability is advertised,
|
|
|
|
|
there is an implied `refspec *:*`.
|
2013-08-26 11:21:39 +02:00
|
|
|
+
|
|
|
|
|
When writing remote-helpers for decentralized version control
|
|
|
|
|
systems, it is advised to keep a local copy of the repository to
|
|
|
|
|
interact with, and to let the private namespace refs point to this
|
|
|
|
|
local repository, while the refs/remotes namespace is used to track
|
|
|
|
|
the remote repository.
|
2011-08-30 05:56:08 +02:00
|
|
|
|
2012-11-28 00:03:24 +01:00
|
|
|
'bidi-import'::
|
|
|
|
|
This modifies the 'import' capability.
|
|
|
|
|
The fast-import commands 'cat-blob' and 'ls' can be used by remote-helpers
|
|
|
|
|
to retrieve information about blobs and trees that already exist in
|
|
|
|
|
fast-import's memory. This requires a channel from fast-import to the
|
|
|
|
|
remote-helper.
|
2013-01-21 20:17:53 +01:00
|
|
|
If it is advertised in addition to "import", Git establishes a pipe from
|
2012-11-28 00:03:24 +01:00
|
|
|
fast-import to the remote-helper's stdin.
|
2013-01-21 20:17:53 +01:00
|
|
|
It follows that Git and fast-import are both connected to the
|
|
|
|
|
remote-helper's stdin. Because Git can send multiple commands to
|
2012-11-28 00:03:24 +01:00
|
|
|
the remote-helper it is required that helpers that use 'bidi-import'
|
|
|
|
|
buffer all 'import' commands of a batch before sending data to fast-import.
|
|
|
|
|
This is to prevent mixing commands and fast-import responses on the
|
|
|
|
|
helper's stdin.
|
|
|
|
|
|
|
|
|
|
'export-marks' <file>::
|
2013-01-21 20:17:53 +01:00
|
|
|
This modifies the 'export' capability, instructing Git to dump the
|
2012-11-28 00:03:24 +01:00
|
|
|
internal marks table to <file> when complete. For details,
|
2016-06-28 13:40:11 +02:00
|
|
|
read up on `--export-marks=<file>` in linkgit:git-fast-export[1].
|
2012-11-28 00:03:24 +01:00
|
|
|
|
|
|
|
|
'import-marks' <file>::
|
2013-01-21 20:17:53 +01:00
|
|
|
This modifies the 'export' capability, instructing Git to load the
|
2012-11-28 00:03:24 +01:00
|
|
|
marks specified in <file> before processing any input. For details,
|
2016-06-28 13:40:11 +02:00
|
|
|
read up on `--import-marks=<file>` in linkgit:git-fast-export[1].
|
2012-11-28 00:03:24 +01:00
|
|
|
|
2013-04-14 12:57:08 +02:00
|
|
|
'signed-tags'::
|
|
|
|
|
This modifies the 'export' capability, instructing Git to pass
|
2016-06-28 13:40:11 +02:00
|
|
|
`--signed-tags=verbatim` to linkgit:git-fast-export[1]. In the
|
|
|
|
|
absence of this capability, Git will use `--signed-tags=warn-strip`.
|
2012-11-28 00:03:24 +01:00
|
|
|
|
2020-05-25 21:59:02 +02:00
|
|
|
'object-format'::
|
|
|
|
|
This indicates that the helper is able to interact with the remote
|
|
|
|
|
side using an explicit hash algorithm extension.
|
2012-11-28 00:03:24 +01:00
|
|
|
|
|
|
|
|
|
2009-08-05 07:01:53 +02:00
|
|
|
COMMANDS
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Commands are given by the caller on the helper's standard input, one per line.
|
|
|
|
|
|
|
|
|
|
'capabilities'::
|
|
|
|
|
Lists the capabilities of the helper, one per line, ending
|
2010-04-18 02:57:37 +02:00
|
|
|
with a blank line. Each capability may be preceded with '*',
|
2013-01-21 20:17:53 +01:00
|
|
|
which marks them mandatory for Git versions using the remote
|
2012-11-28 00:03:23 +01:00
|
|
|
helper to understand. Any unknown mandatory capability is a
|
|
|
|
|
fatal error.
|
2012-11-28 00:03:25 +01:00
|
|
|
+
|
|
|
|
|
Support for this command is mandatory.
|
2009-08-05 07:01:53 +02:00
|
|
|
|
|
|
|
|
'list'::
|
|
|
|
|
Lists the refs, one per line, in the format "<value> <name>
|
|
|
|
|
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
|
2020-05-25 21:59:02 +02:00
|
|
|
a symref, ":<keyword> <value>" for a key-value pair, or
|
|
|
|
|
"?" to indicate that the helper could not get the value of the
|
|
|
|
|
ref. A space-separated list of attributes follows the name;
|
|
|
|
|
unrecognized attributes are ignored. The list ends with a
|
|
|
|
|
blank line.
|
2009-10-31 01:47:30 +01:00
|
|
|
+
|
2012-11-28 00:03:26 +01:00
|
|
|
See REF LIST ATTRIBUTES for a list of currently defined attributes.
|
2020-05-25 21:59:02 +02:00
|
|
|
See REF LIST KEYWORDS for a list of currently defined keywords.
|
2012-11-28 00:03:26 +01:00
|
|
|
+
|
2012-11-28 00:03:25 +01:00
|
|
|
Supported if the helper has the "fetch" or "import" capability.
|
|
|
|
|
|
|
|
|
|
'list for-push'::
|
|
|
|
|
Similar to 'list', except that it is used if and only if
|
|
|
|
|
the caller wants to the resulting ref list to prepare
|
|
|
|
|
push commands.
|
|
|
|
|
A helper supporting both push and fetch can use this
|
|
|
|
|
to distinguish for which operation the output of 'list'
|
|
|
|
|
is going to be used, possibly reducing the amount
|
|
|
|
|
of work that needs to be performed.
|
|
|
|
|
+
|
|
|
|
|
Supported if the helper has the "push" or "export" capability.
|
2009-08-05 07:01:53 +02:00
|
|
|
|
2009-10-31 01:47:29 +01:00
|
|
|
'option' <name> <value>::
|
2010-04-18 02:57:37 +02:00
|
|
|
Sets the transport helper option <name> to <value>. Outputs a
|
2009-10-31 01:47:29 +01:00
|
|
|
single line containing one of 'ok' (option successfully set),
|
|
|
|
|
'unsupported' (option not recognized) or 'error <msg>'
|
2010-04-18 02:57:37 +02:00
|
|
|
(option <name> is supported but <value> is not valid
|
2009-10-31 01:47:29 +01:00
|
|
|
for it). Options should be set before other commands,
|
2010-04-18 02:57:37 +02:00
|
|
|
and may influence the behavior of those commands.
|
2009-10-31 01:47:29 +01:00
|
|
|
+
|
2012-11-28 00:03:26 +01:00
|
|
|
See OPTIONS for a list of currently defined options.
|
|
|
|
|
+
|
2009-10-31 01:47:29 +01:00
|
|
|
Supported if the helper has the "option" capability.
|
2009-08-05 07:01:53 +02:00
|
|
|
|
|
|
|
|
'fetch' <sha1> <name>::
|
2009-10-31 01:47:28 +01:00
|
|
|
Fetches the given object, writing the necessary objects
|
|
|
|
|
to the database. Fetch commands are sent in a batch, one
|
2010-04-18 02:57:37 +02:00
|
|
|
per line, terminated with a blank line.
|
2009-10-31 01:47:28 +01:00
|
|
|
Outputs a single blank line when all fetch commands in the
|
|
|
|
|
same batch are complete. Only objects which were reported
|
2012-11-28 00:03:26 +01:00
|
|
|
in the output of 'list' with a sha1 may be fetched this way.
|
2009-10-31 01:47:28 +01:00
|
|
|
+
|
2019-08-30 22:12:18 +02:00
|
|
|
Optionally may output a 'lock <file>' line indicating the full path of
|
|
|
|
|
a file under `$GIT_DIR/objects/pack` which is keeping a pack until
|
|
|
|
|
refs can be suitably updated. The path must end with `.keep`. This is
|
|
|
|
|
a mechanism to name a <pack,idx,keep> tuple by giving only the keep
|
|
|
|
|
component. The kept pack will not be deleted by a concurrent repack,
|
|
|
|
|
even though its objects may not be referenced until the fetch completes.
|
|
|
|
|
The `.keep` file will be deleted at the conclusion of the fetch.
|
2009-08-05 07:01:53 +02:00
|
|
|
+
|
2013-07-21 10:18:05 +02:00
|
|
|
If option 'check-connectivity' is requested, the helper must output
|
|
|
|
|
'connectivity-ok' if the clone is self-contained and connected.
|
|
|
|
|
+
|
2009-08-05 07:01:53 +02:00
|
|
|
Supported if the helper has the "fetch" capability.
|
|
|
|
|
|
2009-10-31 01:47:30 +01:00
|
|
|
'push' +<src>:<dst>::
|
2010-04-18 02:57:37 +02:00
|
|
|
Pushes the given local <src> commit or branch to the
|
2009-10-31 01:47:30 +01:00
|
|
|
remote branch described by <dst>. A batch sequence of
|
2011-09-01 18:49:37 +02:00
|
|
|
one or more 'push' commands is terminated with a blank line
|
|
|
|
|
(if there is only one reference to push, a single 'push' command
|
|
|
|
|
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
|
2016-06-28 13:40:15 +02:00
|
|
|
the local `HEAD` to the remote 'branch', and the second
|
2011-09-01 18:49:37 +02:00
|
|
|
asking to push ref 'foo' to ref 'bar' (forced update requested
|
|
|
|
|
by the '+').
|
|
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
push refs/heads/master:refs/heads/master
|
|
|
|
|
push HEAD:refs/heads/branch
|
|
|
|
|
\n
|
|
|
|
|
push +refs/heads/foo:refs/heads/bar
|
|
|
|
|
\n
|
|
|
|
|
------------
|
2009-10-31 01:47:30 +01:00
|
|
|
+
|
|
|
|
|
Zero or more protocol options may be entered after the last 'push'
|
|
|
|
|
command, before the batch's terminating blank line.
|
|
|
|
|
+
|
|
|
|
|
When the push is complete, outputs one or more 'ok <dst>' or
|
|
|
|
|
'error <dst> <why>?' lines to indicate success or failure of
|
|
|
|
|
each pushed ref. The status report output is terminated by
|
|
|
|
|
a blank line. The option field <why> may be quoted in a C
|
|
|
|
|
style string if it contains an LF.
|
|
|
|
|
+
|
|
|
|
|
Supported if the helper has the "push" capability.
|
|
|
|
|
|
2009-11-18 02:42:27 +01:00
|
|
|
'import' <name>::
|
|
|
|
|
Produces a fast-import stream which imports the current value
|
|
|
|
|
of the named ref. It may additionally import other refs as
|
2009-11-18 02:42:28 +01:00
|
|
|
needed to construct the history efficiently. The script writes
|
|
|
|
|
to a helper-specific private namespace. The value of the named
|
|
|
|
|
ref should be written to a location in this namespace derived
|
|
|
|
|
by applying the refspecs from the "refspec" capability to the
|
|
|
|
|
name of the ref.
|
2009-11-18 02:42:27 +01:00
|
|
|
+
|
2010-04-18 02:57:37 +02:00
|
|
|
Especially useful for interoperability with a foreign versioning
|
|
|
|
|
system.
|
|
|
|
|
+
|
2011-09-01 18:49:37 +02:00
|
|
|
Just like 'push', a batch sequence of one or more 'import' is
|
|
|
|
|
terminated with a blank line. For each batch of 'import', the remote
|
|
|
|
|
helper should produce a fast-import stream terminated by a 'done'
|
|
|
|
|
command.
|
|
|
|
|
+
|
2012-09-19 17:21:20 +02:00
|
|
|
Note that if the 'bidi-import' capability is used the complete batch
|
|
|
|
|
sequence has to be buffered before starting to send data to fast-import
|
|
|
|
|
to prevent mixing of commands and fast-import responses on the helper's
|
|
|
|
|
stdin.
|
|
|
|
|
+
|
2012-11-28 00:03:25 +01:00
|
|
|
Supported if the helper has the "import" capability.
|
2009-11-18 02:42:27 +01:00
|
|
|
|
2012-11-28 00:03:22 +01:00
|
|
|
'export'::
|
|
|
|
|
Instructs the remote helper that any subsequent input is
|
|
|
|
|
part of a fast-import stream (generated by 'git fast-export')
|
|
|
|
|
containing objects which should be pushed to the remote.
|
|
|
|
|
+
|
|
|
|
|
Especially useful for interoperability with a foreign versioning
|
|
|
|
|
system.
|
|
|
|
|
+
|
|
|
|
|
The 'export-marks' and 'import-marks' capabilities, if specified,
|
|
|
|
|
affect this command in so far as they are passed on to 'git
|
|
|
|
|
fast-export', which then will load/store a table of marks for
|
|
|
|
|
local objects. This can be used to implement for incremental
|
|
|
|
|
operations.
|
|
|
|
|
+
|
2012-11-28 00:03:25 +01:00
|
|
|
Supported if the helper has the "export" capability.
|
2012-11-28 00:03:22 +01:00
|
|
|
|
2009-12-09 16:26:32 +01:00
|
|
|
'connect' <service>::
|
|
|
|
|
Connects to given service. Standard input and standard output
|
|
|
|
|
of helper are connected to specified service (git prefix is
|
|
|
|
|
included in service name so e.g. fetching uses 'git-upload-pack'
|
|
|
|
|
as service) on remote side. Valid replies to this command are
|
|
|
|
|
empty line (connection established), 'fallback' (no smart
|
|
|
|
|
transport support, fall back to dumb transports) and just
|
|
|
|
|
exiting with error message printed (can't connect, don't
|
|
|
|
|
bother trying to fall back). After line feed terminating the
|
|
|
|
|
positive (empty) response, the output of service starts. After
|
|
|
|
|
the connection ends, the remote helper exits.
|
|
|
|
|
+
|
|
|
|
|
Supported if the helper has the "connect" capability.
|
|
|
|
|
|
2018-03-15 18:31:34 +01:00
|
|
|
'stateless-connect' <service>::
|
|
|
|
|
Experimental; for internal use only.
|
|
|
|
|
Connects to the given remote service for communication using
|
|
|
|
|
git's wire-protocol version 2. Valid replies to this command
|
|
|
|
|
are empty line (connection established), 'fallback' (no smart
|
|
|
|
|
transport support, fall back to dumb transports) and just
|
|
|
|
|
exiting with error message printed (can't connect, don't bother
|
|
|
|
|
trying to fall back). After line feed terminating the positive
|
|
|
|
|
(empty) response, the output of the service starts. Messages
|
|
|
|
|
(both request and response) must consist of zero or more
|
2020-05-19 12:54:00 +02:00
|
|
|
PKT-LINEs, terminating in a flush packet. Response messages will
|
|
|
|
|
then have a response end packet after the flush packet to
|
|
|
|
|
indicate the end of a response. The client must not
|
2018-03-15 18:31:34 +01:00
|
|
|
expect the server to store any state in between request-response
|
|
|
|
|
pairs. After the connection ends, the remote helper exits.
|
|
|
|
|
+
|
|
|
|
|
Supported if the helper has the "stateless-connect" capability.
|
|
|
|
|
|
2022-08-09 15:11:39 +02:00
|
|
|
'get' <uri> <path>::
|
|
|
|
|
Downloads the file from the given `<uri>` to the given `<path>`. If
|
|
|
|
|
`<path>.temp` exists, then Git assumes that the `.temp` file is a
|
|
|
|
|
partial download from a previous attempt and will resume the
|
|
|
|
|
download from that position.
|
|
|
|
|
|
2009-08-05 07:01:53 +02:00
|
|
|
If a fatal error occurs, the program writes the error message to
|
|
|
|
|
stderr and exits. The caller should expect that a suitable error
|
|
|
|
|
message has been printed if the child closes the connection without
|
|
|
|
|
completing a valid response for the current command.
|
|
|
|
|
|
|
|
|
|
Additional commands may be supported, as may be determined from
|
|
|
|
|
capabilities reported by the helper.
|
|
|
|
|
|
|
|
|
|
REF LIST ATTRIBUTES
|
|
|
|
|
-------------------
|
|
|
|
|
|
2012-11-28 00:03:26 +01:00
|
|
|
The 'list' command produces a list of refs in which each ref
|
|
|
|
|
may be followed by a list of attributes. The following ref list
|
|
|
|
|
attributes are defined.
|
2009-08-05 07:01:53 +02:00
|
|
|
|
2009-11-18 02:42:30 +01:00
|
|
|
'unchanged'::
|
|
|
|
|
This ref is unchanged since the last import or fetch, although
|
|
|
|
|
the helper cannot necessarily determine what value that produced.
|
2009-08-05 07:01:53 +02:00
|
|
|
|
2020-05-25 21:59:02 +02:00
|
|
|
REF LIST KEYWORDS
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
The 'list' command may produce a list of key-value pairs.
|
|
|
|
|
The following keys are defined.
|
|
|
|
|
|
|
|
|
|
'object-format'::
|
|
|
|
|
The refs are using the given hash algorithm. This keyword is only
|
|
|
|
|
used if the server and client both support the object-format
|
|
|
|
|
extension.
|
|
|
|
|
|
|
|
|
|
|
2009-10-31 01:47:29 +01:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2012-11-28 00:03:26 +01:00
|
|
|
|
|
|
|
|
The following options are defined and (under suitable circumstances)
|
2013-01-21 20:17:53 +01:00
|
|
|
set by Git if the remote helper has the 'option' capability.
|
2012-11-28 00:03:26 +01:00
|
|
|
|
2011-02-17 08:48:06 +01:00
|
|
|
'option verbosity' <n>::
|
2010-04-18 02:57:37 +02:00
|
|
|
Changes the verbosity of messages displayed by the helper.
|
2011-02-17 08:48:06 +01:00
|
|
|
A value of 0 for <n> means that processes operate
|
2010-04-18 02:57:37 +02:00
|
|
|
quietly, and the helper produces only error output.
|
|
|
|
|
1 is the default level of verbosity, and higher values
|
2011-02-17 08:48:06 +01:00
|
|
|
of <n> correspond to the number of -v flags passed on the
|
2009-10-31 01:47:29 +01:00
|
|
|
command line.
|
|
|
|
|
|
2015-05-13 07:02:22 +02:00
|
|
|
'option progress' {'true'|'false'}::
|
2010-04-18 02:57:37 +02:00
|
|
|
Enables (or disables) progress messages displayed by the
|
2009-10-31 01:47:29 +01:00
|
|
|
transport helper during a command.
|
|
|
|
|
|
|
|
|
|
'option depth' <depth>::
|
2010-04-18 02:57:37 +02:00
|
|
|
Deepens the history of a shallow repository.
|
2009-10-31 01:47:29 +01:00
|
|
|
|
2024-03-20 10:17:48 +01:00
|
|
|
'option deepen-since' <timestamp>::
|
2016-06-12 12:53:59 +02:00
|
|
|
Deepens the history of a shallow repository based on time.
|
|
|
|
|
|
2024-03-20 10:17:48 +01:00
|
|
|
'option deepen-not' <ref>::
|
2016-06-12 12:54:04 +02:00
|
|
|
Deepens the history of a shallow repository excluding ref.
|
|
|
|
|
Multiple options add up.
|
|
|
|
|
|
2024-03-20 10:17:48 +01:00
|
|
|
'option deepen-relative' {'true'|'false'}::
|
fetch, upload-pack: --deepen=N extends shallow boundary by N commits
In git-fetch, --depth argument is always relative with the latest
remote refs. This makes it a bit difficult to cover this use case,
where the user wants to make the shallow history, say 3 levels
deeper. It would work if remote refs have not moved yet, but nobody
can guarantee that, especially when that use case is performed a
couple months after the last clone or "git fetch --depth". Also,
modifying shallow boundary using --depth does not work well with
clones created by --since or --not.
This patch fixes that. A new argument --deepen=<N> will add <N> more (*)
parent commits to the current history regardless of where remote refs
are.
Have/Want negotiation is still respected. So if remote refs move, the
server will send two chunks: one between "have" and "want" and another
to extend shallow history. In theory, the client could send no "want"s
in order to get the second chunk only. But the protocol does not allow
that. Either you send no want lines, which means ls-remote; or you
have to send at least one want line that carries deep-relative to the
server..
The main work was done by Dongcan Jiang. I fixed it up here and there.
And of course all the bugs belong to me.
(*) We could even support --deepen=<N> where <N> is negative. In that
case we can cut some history from the shallow clone. This operation
(and --depth=<shorter depth>) does not require interaction with remote
side (and more complicated to implement as a result).
Helped-by: Duy Nguyen <pclouds@gmail.com>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Dongcan Jiang <dongcan.jiang@gmail.com>
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-06-12 12:54:09 +02:00
|
|
|
Deepens the history of a shallow repository relative to
|
|
|
|
|
current boundary. Only valid when used with "option depth".
|
|
|
|
|
|
2015-05-13 07:02:22 +02:00
|
|
|
'option followtags' {'true'|'false'}::
|
2009-10-31 01:47:29 +01:00
|
|
|
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
|
|
|
|
|
the helper a second fetch command will usually be sent to
|
|
|
|
|
ask for the tag specifically. Some helpers may be able to
|
|
|
|
|
use this option to avoid a second network connection.
|
|
|
|
|
|
2015-05-13 07:02:22 +02:00
|
|
|
'option dry-run' {'true'|'false'}:
|
2009-10-31 01:47:30 +01:00
|
|
|
If true, pretend the operation completed successfully,
|
2019-03-06 07:30:18 +01:00
|
|
|
but don't actually change any repository data. For most
|
2009-10-31 01:47:30 +01:00
|
|
|
helpers this only applies to the 'push', if supported.
|
|
|
|
|
|
2009-12-09 16:26:32 +01:00
|
|
|
'option servpath <c-style-quoted-path>'::
|
2010-04-18 02:57:37 +02:00
|
|
|
Sets service path (--upload-pack, --receive-pack etc.) for
|
|
|
|
|
next connect. Remote helper may support this option, but
|
|
|
|
|
must not rely on this option being set before
|
2009-12-09 16:26:32 +01:00
|
|
|
connect request occurs.
|
|
|
|
|
|
2015-05-13 07:02:22 +02:00
|
|
|
'option check-connectivity' {'true'|'false'}::
|
2013-07-21 10:18:05 +02:00
|
|
|
Request the helper to check connectivity of a clone.
|
|
|
|
|
|
2015-05-13 07:02:22 +02:00
|
|
|
'option force' {'true'|'false'}::
|
2013-11-12 21:56:56 +01:00
|
|
|
Request the helper to perform a force update. Defaults to
|
|
|
|
|
'false'.
|
|
|
|
|
|
2017-02-13 21:38:35 +01:00
|
|
|
'option cloning' {'true'|'false'}::
|
2013-12-05 14:02:50 +01:00
|
|
|
Notify the helper this is a clone request (i.e. the current
|
|
|
|
|
repository is guaranteed empty).
|
|
|
|
|
|
2017-02-13 21:38:35 +01:00
|
|
|
'option update-shallow' {'true'|'false'}::
|
2013-12-05 14:02:50 +01:00
|
|
|
Allow to extend .git/shallow if the new refs require it.
|
|
|
|
|
|
2017-02-13 21:38:35 +01:00
|
|
|
'option pushcert' {'true'|'false'}::
|
2015-08-19 17:26:42 +02:00
|
|
|
GPG sign pushes.
|
|
|
|
|
|
2024-03-07 09:43:13 +01:00
|
|
|
'option push-option' <string>::
|
2017-04-30 17:48:27 +02:00
|
|
|
Transmit <string> as a push option. As the push option
|
2017-02-08 23:04:00 +01:00
|
|
|
must not contain LF or NUL characters, the string is not encoded.
|
|
|
|
|
|
introduce fetch-object: fetch one promisor object
Introduce fetch-object, providing the ability to fetch one object from a
promisor remote.
This uses fetch-pack. To do this, the transport mechanism has been
updated with 2 flags, "from-promisor" to indicate that the resulting
pack comes from a promisor remote (and thus should be annotated as such
by index-pack), and "no-dependents" to indicate that only the objects
themselves need to be fetched (but fetching additional objects is
nevertheless safe).
Whenever "no-dependents" is used, fetch-pack will refrain from using any
object flags, because it is most likely invoked as part of a dynamic
object fetch by another Git command (which may itself use object flags).
An alternative to this is to leave fetch-pack alone, and instead update
the allocation of flags so that fetch-pack's flags never overlap with
any others, but this will end up shrinking the number of flags available
to nearly every other Git command (that is, every Git command that
accesses objects), so the approach in this commit was used instead.
This will be tested in a subsequent commit.
Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-12-05 17:58:49 +01:00
|
|
|
'option from-promisor' {'true'|'false'}::
|
|
|
|
|
Indicate that these objects are being fetched from a promisor.
|
|
|
|
|
|
|
|
|
|
'option no-dependents' {'true'|'false'}::
|
|
|
|
|
Indicate that only the objects wanted need to be fetched, not
|
|
|
|
|
their dependents.
|
|
|
|
|
|
remote-curl: pass on atomic capability to remote side
When pushing more than one reference with the --atomic option, the
server is supposed to perform a single atomic transaction to update the
references, leaving them either all to succeed or all to fail. This
works fine when pushing locally or over SSH, but when pushing over HTTP,
we fail to pass the atomic capability to the remote side. In fact, we
have not reported this capability to any remote helpers during the life
of the feature.
Now normally, things happen to work nevertheless, since we actually
check for most types of failures, such as non-fast-forward updates, on
the client side, and just abort the entire attempt. However, if the
server side reports a problem, such as the inability to lock a ref, the
transaction isn't atomic, because we haven't passed the appropriate
capability over and the remote side has no way of knowing that we wanted
atomic behavior.
Fix this by passing the option from the transport code through to remote
helpers, and from the HTTP remote helper down to send-pack. With this
change, we can detect if the server side rejects the push and report
back appropriately. Note the difference in the messages: the remote
side reports "atomic transaction failed", while our own checking rejects
pushes with the message "atomic push failed".
Document the atomic option in the remote helper documentation, so other
implementers can implement it if they like.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-10-17 01:45:34 +02:00
|
|
|
'option atomic' {'true'|'false'}::
|
|
|
|
|
When pushing, request the remote server to update refs in a single atomic
|
|
|
|
|
transaction. If successful, all refs will be updated, or none will. If the
|
|
|
|
|
remote side does not support this capability, the push will fail.
|
|
|
|
|
|
transport-helper: drop "object-format <algo>" option
The documentation in gitremote-helpers.txt claims that helpers should
accept an object-format option from Git whose value is either:
1. "true", in which case the helper is merely told that Git
understands the special ":object-format" response, and will send it
2. an algorithm name that the helper should use
However, Git has never sent the second form, and it's not clear if it
would ever be useful.
When interacting with a remote Git repository, we generally discover
what _their_ object format is, and then decide what to do with a
mismatch (where that is currently just "bail out", but could eventually
be on-the-fly conversion and interop). And that is true for native
protocols, but also for transport helpers like remote-curl that talk to
remote Git repositories. There we send back an ":object-format" line
telling Git what remote-curl detected on the other side.
And this is true even for pushes (since we get it via receive-pack's
advertisement). And it is even true for dumb-http, as we guess at the
algorithm based on the hash size, due to ac093d0790 (remote-curl: detect
algorithm for dumb HTTP by size, 2020-06-19).
The one case where it _isn't_ true is dumb-http talking to an empty
repository. There we have no clue what the remote hash is, so
remote-curl just sends back its default. If we kept the "object-format
<algo>" form then in theory Git could say "object-format sha256" to
change that default. But it doesn't really accomplish anything. We still
may or may not be mis-matched with the other side. For a fetch that's
OK, since it's by definition a noop. For a push into an empty
repository, it might matter (though the dumb http-push DAV code seems
happy to clobber a remote sha256 info/refs and corrupt the repository).
If we want to pursue making this work, I think we'd be better off
improving detection of the object format of empty repositories over
dumb-http (e.g., an "info/object-format" file).
But what about helpers that _aren't_ talking to another Git repo?
Consider something like git-cinnabar, which is converting on the fly
to/from hg. Most of the heavy lifting is done by fast-import/export, but
some oids may still pass between Git and the helper. Could
"object-format <algo>" be useful to tell the helper what oids we expect
to see?
Possibly, but in practice this isn't necessary. Git-cinnabar for example
already peeks at the local-repo .git/config to check its object-format
(and currently just bails if it is sha256).
So I think the "object-format" extension really is only useful for the
helper telling Git what object-format it found, and not the other way
around.
Note that this patch can't break any remote helpers; we're not changing
the code on the Git side at all, but just bringing the documentation in
line with what Git has always done. It does remove the receiving support
in remote-curl.c, but that code was never actually triggered.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-03-20 10:37:40 +01:00
|
|
|
'option object-format true'::
|
|
|
|
|
Indicate that the caller wants hash algorithm information
|
2020-05-25 21:59:02 +02:00
|
|
|
to be passed back from the remote. This mode is used when fetching
|
|
|
|
|
refs.
|
|
|
|
|
|
2010-04-07 07:44:41 +02:00
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkgit:git-remote[1]
|
|
|
|
|
|
2014-11-11 21:17:07 +01:00
|
|
|
linkgit:git-remote-ext[1]
|
|
|
|
|
|
|
|
|
|
linkgit:git-remote-fd[1]
|
|
|
|
|
|
|
|
|
|
linkgit:git-fast-import[1]
|
|
|
|
|
|
2009-08-05 07:01:53 +02:00
|
|
|
GIT
|
|
|
|
|
---
|
|
|
|
|
Part of the linkgit:git[1] suite
|
