git-remote-helpers.txt: clarify options & ref list attributes
The documentation was misleading in that it gave the impression that 'for-push' could be used as a ref attribute in the output of the 'list' command. That is wrong. Also, explicitly point out the connection between the commands 'list' and 'options' on the one hand, and the sections 'REF LIST ATTRIBUTES' and 'OPTIONS' on the other hand. Signed-off-by: Max Horn <max@quendi.de> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Max Horn committed
Nov 28, 2012 at 00:03 UTC
9ec8bcda6031d2c75fb8b06b26bcf9414e9448f6
1 file changed
+12
-5
Documentation/git-remote-helpers.txt
+12
-5
@@ -227,6 +227,8 @@ Support for this command is mandatory.
227
the name; unrecognized attributes are ignored. The list ends
228
with a blank line.
229
+
230
+See REF LIST ATTRIBUTES for a list of currently defined attributes.
231
++
232
Supported if the helper has the "fetch" or "import" capability.
233
234
'list for-push'::
@@ -248,6 +250,8 @@ Supported if the helper has the "push" or "export" capability.
250
for it). Options should be set before other commands,
251
and may influence the behavior of those commands.
252
+
253
+See OPTIONS for a list of currently defined options.
254
++
255
Supported if the helper has the "option" capability.
256
257
'fetch' <sha1> <name>::
@@ -256,7 +260,7 @@ Supported if the helper has the "option" capability.
260
per line, terminated with a blank line.
261
Outputs a single blank line when all fetch commands in the
262
same batch are complete. Only objects which were reported
259
- in the ref list with a sha1 may be fetched this way.
263
+ in the output of 'list' with a sha1 may be fetched this way.
264
+
265
Optionally may output a 'lock <file>' line indicating a file under
266
GIT_DIR/objects/pack which is keeping a pack until refs can be
@@ -360,10 +364,9 @@ capabilities reported by the helper.
364
REF LIST ATTRIBUTES
365
-------------------
366
363
-'for-push'::
364
- The caller wants to use the ref list to prepare push
365
- commands. A helper might chose to acquire the ref list by
366
- opening a different type of connection to the destination.
367
+The 'list' command produces a list of refs in which each ref
368
+may be followed by a list of attributes. The following ref list
369
+attributes are defined.
370
371
'unchanged'::
372
This ref is unchanged since the last import or fetch, although
@@ -371,6 +374,10 @@ REF LIST ATTRIBUTES
374
375
OPTIONS
376
-------
377
+
378
+The following options are defined and (under suitable circumstances)
379
+set by git if the remote helper has the 'option' capability.
380
+
381
'option verbosity' <n>::
382
Changes the verbosity of messages displayed by the helper.
383
A value of 0 for <n> means that processes operate