Skip to content

Commit 9ec8bcd

Browse files
fingolfingitster
authored andcommitted
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 <[email protected]> Acked-by: Sverre Rabbelier <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 754cb1a commit 9ec8bcd

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

Documentation/git-remote-helpers.txt

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,8 @@ Support for this command is mandatory.
227227
the name; unrecognized attributes are ignored. The list ends
228228
with a blank line.
229229
+
230+
See REF LIST ATTRIBUTES for a list of currently defined attributes.
231+
+
230232
Supported if the helper has the "fetch" or "import" capability.
231233

232234
'list for-push'::
@@ -248,6 +250,8 @@ Supported if the helper has the "push" or "export" capability.
248250
for it). Options should be set before other commands,
249251
and may influence the behavior of those commands.
250252
+
253+
See OPTIONS for a list of currently defined options.
254+
+
251255
Supported if the helper has the "option" capability.
252256

253257
'fetch' <sha1> <name>::
@@ -256,7 +260,7 @@ Supported if the helper has the "option" capability.
256260
per line, terminated with a blank line.
257261
Outputs a single blank line when all fetch commands in the
258262
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.
260264
+
261265
Optionally may output a 'lock <file>' line indicating a file under
262266
GIT_DIR/objects/pack which is keeping a pack until refs can be
@@ -360,17 +364,20 @@ capabilities reported by the helper.
360364
REF LIST ATTRIBUTES
361365
-------------------
362366

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.
367370

368371
'unchanged'::
369372
This ref is unchanged since the last import or fetch, although
370373
the helper cannot necessarily determine what value that produced.
371374

372375
OPTIONS
373376
-------
377+
378+
The following options are defined and (under suitable circumstances)
379+
set by git if the remote helper has the 'option' capability.
380+
374381
'option verbosity' <n>::
375382
Changes the verbosity of messages displayed by the helper.
376383
A value of 0 for <n> means that processes operate

0 commit comments

Comments
 (0)