gitremote-helpers(1): clarify refspec behaviour
authorJohn Keeping <john@keeping.me.uk>
Sat, 6 Apr 2013 18:13:41 +0000 (19:13 +0100)
committerJunio C Hamano <gitster@pobox.com>
Sun, 7 Apr 2013 07:40:48 +0000 (00:40 -0700)
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>
Documentation/gitremote-helpers.txt
index 0c91aba86182f91206fcba5470b7202e4496f073..f506031ae49070e216e71914d8ef241da58430e1 100644 (file)
@@ -174,8 +174,8 @@ ref.
 This capability can be advertised multiple times.  The first
 applicable refspec takes precedence.  The left-hand of refspecs
 advertised with this capability must cover all refs reported by
 This capability can be advertised multiple times.  The first
 applicable refspec takes precedence.  The left-hand of refspecs
 advertised with this capability must cover all refs reported by
-the list command.  If no 'refspec' capability is advertised,
-there is an implied `refspec *:*`.
+the list command.  If a helper does not need a specific 'refspec'
+capability then it should advertise `refspec *:*`.
 
 'bidi-import'::
        This modifies the 'import' capability.
 
 'bidi-import'::
        This modifies the 'import' capability.