[PATCH] gitremote-helpers(1): clarify refspec behaviour

[PATCH] gitremote-helpers(1): clarify refspec behaviour

[John Keeping]

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>
---
 Documentation/gitremote-helpers.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 0c91aba..f506031 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -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
-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.
-- 
1.8.2.692.g17a9715

Re: [PATCH] gitremote-helpers(1): clarify refspec behaviour

[Sverre Rabbelier]

In Sat, Apr 6, 2013 at 11:13 AM, John Keeping <john@keeping.me.uk> wrote:
> 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>

--
Cheers,

Sverre Rabbelier

Re: [PATCH] gitremote-helpers(1): clarify refspec behaviour

[Felipe Contreras]

On Sat, Apr 6, 2013 at 12:13 PM, John Keeping <john@keeping.me.uk> wrote:

> --- a/Documentation/gitremote-helpers.txt
> +++ b/Documentation/gitremote-helpers.txt
> @@ -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
> -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 *:*`.

But if it advertises a straight 'refspec *:*', nothing would work. If
anything, it should be 'refs/heads/*:refs/remotes/$alias/*', but then
tags would fail. Why not just tell the remote helpers to do the right
thing and avoid this comment altogether?

-- 
Felipe Contreras