gitremote-helpers(1): clarify refspec behaviour
The documentation says that "If no 'refspec' capability is advertised, there is an implied `refspec *:*`" but this is only the case for the "import" command. Since there is a comment in transport-helper.c indicating that this default is for historical reasons, change the documentation to clarify that a refspec should always be specified. Signed-off-by: John Keeping <john@keeping.me.uk> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
John Keeping committed
Apr 6, 2013 at 19:13 UTC
9e7673ed7ff656738fdc02d1c529d363aaa98002
1 file changed
+2
-2
Documentation/gitremote-helpers.txt
+2
-2
@@ -174,8 +174,8 @@ ref.
174
This capability can be advertised multiple times. The first
175
applicable refspec takes precedence. The left-hand of refspecs
176
advertised with this capability must cover all refs reported by
177
-the list command. If no 'refspec' capability is advertised,
178
-there is an implied `refspec *:*`.
177
+the list command. If a helper does not need a specific 'refspec'
178
+capability then it should advertise `refspec *:*`.
179
180
'bidi-import'::
181
This modifies the 'import' capability.