[PATCH/resend] Doc: git-push: Specify the default mode in the description

[PATCH/resend] Doc: git-push: Specify the default mode in the description

[Santi Béjar]

Signed-off-by: Santi Béjar <santi@agolina.net>
---
Hi *,

  just resend a patch that maybe was missed inside this thread:

Subject:    possible bug when pushing with multiple remote repos.
From:       Arnaud Mouiche
Date:       2010-10-22 9:12:51
http://marc.info/?i=1287738771.13348.34.camel%20()%20amolinux

Santi

 Documentation/git-push.txt |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index e11660a..9a2a93e 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -23,6 +23,8 @@ You can make interesting things happen to a repository
 every time you push into it, by setting up 'hooks' there.  See
 documentation for linkgit:git-receive-pack[1].
 
+The default operation mode if no explicit refspec is found is
+to push "matching" branches, see below.
 
 OPTIONS[[OPTIONS]]
 ------------------
-- 
1.7.3.2.337.gc40334

Re: [PATCH/resend] Doc: git-push: Specify the default mode in the description

[Junio C Hamano]

Santi Béjar <santi@agolina.net> writes:

> Signed-off-by: Santi Béjar <santi@agolina.net>
> ---
> Hi *,
>
>   just resend a patch that maybe was missed inside this thread:

No, I didn't miss it.

The new text says 'push "matching" branches' before explaining what it is,
only vaguely refers the reader to the next section by "see below" without
telling which part of below the reader should look at.  In other words, it
wastes two lines without adding two lines worth of additional information.

Saying "look for string 'default' below" might be an improvement ;-), but
then the reader can do that without being told to do so themselves, so...

> Subject:    possible bug when pushing with multiple remote repos.
> From:       Arnaud Mouiche
> Date:       2010-10-22 9:12:51
> http://marc.info/?i=1287738771.13348.34.camel%20()%20amolinux
>
> Santi
>
>  Documentation/git-push.txt |    2 ++
>  1 files changed, 2 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
> index e11660a..9a2a93e 100644
> --- a/Documentation/git-push.txt
> +++ b/Documentation/git-push.txt
> @@ -23,6 +23,8 @@ You can make interesting things happen to a repository
>  every time you push into it, by setting up 'hooks' there.  See
>  documentation for linkgit:git-receive-pack[1].
>  
> +The default operation mode if no explicit refspec is found is
> +to push "matching" branches, see below.
>  
>  OPTIONS[[OPTIONS]]
>  ------------------
> -- 
> 1.7.3.2.337.gc40334

Re: [PATCH/resend] Doc: git-push: Specify the default mode in the description

[Santi Béjar]

On Mon, Nov 8, 2010 at 9:48 PM, Junio C Hamano <gitster@pobox.com> wrote:
> Santi Béjar <santi@agolina.net> writes:
>
>> Signed-off-by: Santi Béjar <santi@agolina.net>
>> ---
>> Hi *,
>>
>>   just resend a patch that maybe was missed inside this thread:
>
> No, I didn't miss it.
>
> The new text says 'push "matching" branches' before explaining what it is,
> only vaguely refers the reader to the next section by "see below" without
> telling which part of below the reader should look at.  In other words, it
> wastes two lines without adding two lines worth of additional information.
>
> Saying "look for string 'default' below" might be an improvement ;-), but
> then the reader can do that without being told to do so themselves, so...

At least with the new text the reader will know what to look for. She
has to look for "matching" and not the generic "default". BTW, I'll
send another patch with the explanation of matching, but it just
repeats what is written in the <refspec> option...

Another option would be to add "see the <refspec> option below",
although is is already implicit as the paragraph begins with "if no
explicit refspec".

Santi

[PATCHv2] Doc: git-push: Specify the default mode in the description

[Santi Béjar]

Text extracted from the <refspec> option.

Signed-off-by: Santi Béjar <santi@agolina.net>
---
 Documentation/git-push.txt |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index e11660a..2c0b311 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -23,6 +23,11 @@ You can make interesting things happen to a repository
 every time you push into it, by setting up 'hooks' there.  See
 documentation for linkgit:git-receive-pack[1].
 
+The default operation mode if no explicit refspec is found is
+to push "matching" branches, that is for every branch that exists on
+the local side, the remote side is updated if a branch of the same name
+already exists on the remote side. See the <refspec> option below for
+more details.
 
 OPTIONS[[OPTIONS]]
 ------------------
-- 
1.7.3.2.337.gc40334

Re: [PATCHv2] Doc: git-push: Specify the default mode in the description

[Junio C Hamano]

Santi Béjar <santi@agolina.net> writes:

> Text extracted from the <refspec> option.

Perhaps I wasn't clear enough.  "extracted" is not something we want.

If you think "'matching' is the default" is so important than anything
else, explaining it upfront _might_ be a good idea, but then why leave the
original description only to repeat the same thing again?

It would be an improvement if you rephrased things so that the manual
becomes shorter, non repetitive, and having more important information
easier to find.  Otherwise it's just adding noise on top of noise that
already is there, isn't it?