undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-remote-helpers.txt: clarify command <-> capability correspondences

Browse Source 
In particular, document 'list for-push' separately from 'list', as
the former needs only be supported for the push/export
capabilities, and the latter only for fetch/import. Indeed, a
hypothetically 'push-only' helper would only need to support the
former, not the latter.

Signed-off-by: Max Horn <max@quendi.de>
Acked-by: Sverre Rabbelier <srabbelier@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Max Horn 2012-11-28 00:03:25 +01:00 committed by Junio C Hamano
parent 0673bb28d0
commit 754cb1aeba
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/git-remote-helpers.txt
View File

@ -216,6 +216,8 @@ Commands are given by the caller on the helper's standard input, one per line.
which marks them mandatory for git versions using the remote which marks them mandatory for git versions using the remote
helper to understand. Any unknown mandatory capability is a helper to understand. Any unknown mandatory capability is a
fatal error. fatal error.
+
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>
@ -225,9 +227,18 @@ Commands are given by the caller on the helper's standard input, one per line.
the name; unrecognized attributes are ignored. The list ends the name; unrecognized attributes are ignored. The list ends
with a blank line. with a blank line.
+ +
If 'push' is supported this may be called as 'list for-push' Supported if the helper has the "fetch" or "import" capability.
to obtain the current refs prior to sending one or more 'push'
commands to the helper. '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.
'option' <name> <value>:: 'option' <name> <value>::
Sets the transport helper option <name> to <value>. Outputs a Sets the transport helper option <name> to <value>. Outputs a
@ -306,7 +317,7 @@ 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 to prevent mixing of commands and fast-import responses on the helper's
stdin. stdin.
+ +
Supported if the helper has the 'import' capability. Supported if the helper has the "import" capability.
'export':: 'export'::
Instructs the remote helper that any subsequent input is Instructs the remote helper that any subsequent input is
@ -322,7 +333,7 @@ fast-export', which then will load/store a table of marks for
local objects. This can be used to implement for incremental local objects. This can be used to implement for incremental
operations. operations.
+ +
Supported if the helper has the 'export' capability. Supported if the helper has the "export" capability.
'connect' <service>:: 'connect' <service>::
Connects to given service. Standard input and standard output Connects to given service. Standard input and standard output