docs: update remote helper docs for object-format extensions
Update the remote helper docs to document the object-format extensions we will implement in remote-curl and the transport helper code shortly. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:

committed by
Junio C Hamano

parent
bb095d0875
commit
452e35684f
@ -238,6 +238,9 @@ the remote repository.
|
|||||||
`--signed-tags=verbatim` to linkgit:git-fast-export[1]. In the
|
`--signed-tags=verbatim` to linkgit:git-fast-export[1]. In the
|
||||||
absence of this capability, Git will use `--signed-tags=warn-strip`.
|
absence of this capability, Git will use `--signed-tags=warn-strip`.
|
||||||
|
|
||||||
|
'object-format'::
|
||||||
|
This indicates that the helper is able to interact with the remote
|
||||||
|
side using an explicit hash algorithm extension.
|
||||||
|
|
||||||
|
|
||||||
COMMANDS
|
COMMANDS
|
||||||
@ -257,12 +260,14 @@ Support for this command is mandatory.
|
|||||||
'list'::
|
'list'::
|
||||||
Lists the refs, one per line, in the format "<value> <name>
|
Lists the refs, one per line, in the format "<value> <name>
|
||||||
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
|
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
|
||||||
a symref, or "?" to indicate that the helper could not get the
|
a symref, ":<keyword> <value>" for a key-value pair, or
|
||||||
value of the ref. A space-separated list of attributes follows
|
"?" to indicate that the helper could not get the value of the
|
||||||
the name; unrecognized attributes are ignored. The list ends
|
ref. A space-separated list of attributes follows the name;
|
||||||
with a blank line.
|
unrecognized attributes are ignored. The list ends with a
|
||||||
|
blank line.
|
||||||
+
|
+
|
||||||
See REF LIST ATTRIBUTES for a list of currently defined attributes.
|
See REF LIST ATTRIBUTES for a list of currently defined attributes.
|
||||||
|
See REF LIST KEYWORDS for a list of currently defined keywords.
|
||||||
+
|
+
|
||||||
Supported if the helper has the "fetch" or "import" capability.
|
Supported if the helper has the "fetch" or "import" capability.
|
||||||
|
|
||||||
@ -430,6 +435,18 @@ attributes are defined.
|
|||||||
This ref is unchanged since the last import or fetch, although
|
This ref is unchanged since the last import or fetch, although
|
||||||
the helper cannot necessarily determine what value that produced.
|
the helper cannot necessarily determine what value that produced.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -514,6 +531,14 @@ set by Git if the remote helper has the 'option' capability.
|
|||||||
transaction. If successful, all refs will be updated, or none will. If the
|
transaction. If successful, all refs will be updated, or none will. If the
|
||||||
remote side does not support this capability, the push will fail.
|
remote side does not support this capability, the push will fail.
|
||||||
|
|
||||||
|
'option object-format' {'true'|algorithm}::
|
||||||
|
If 'true', indicate that the caller wants hash algorithm information
|
||||||
|
to be passed back from the remote. This mode is used when fetching
|
||||||
|
refs.
|
||||||
|
+
|
||||||
|
If set to an algorithm, indicate that the caller wants to interact with
|
||||||
|
the remote side using that algorithm.
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
linkgit:git-remote[1]
|
linkgit:git-remote[1]
|
||||||
|
Reference in New Issue
Block a user