From: Ramsay Jones <ramsay@ramsayjones.plus.com>
To: "Junio C Hamano" <gitster@pobox.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] branch doc: Change `git branch <pattern>` to use `<branchname>`
Date: Thu, 23 Mar 2017 17:44:07 +0000 [thread overview]
Message-ID: <5d04c82c-45a4-5d5e-0317-511587ee3474@ramsayjones.plus.com> (raw)
In-Reply-To: <xmqq1stoexmb.fsf@gitster.mtv.corp.google.com>
On 23/03/17 17:01, Junio C Hamano wrote:
> Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
>
>> Change an example for `git branch <pattern>` to say `git branch
>> <branchname>` to be consistent with the synopsis. This changes
>> documentation added in d8d33736b5 ("branch: allow pattern arguments",
>> 2011-08-28).
>>
>> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
>> ---
>> Documentation/git-branch.txt | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
>> index 092f1bcf9f..e65e5c0dee 100644
>> --- a/Documentation/git-branch.txt
>> +++ b/Documentation/git-branch.txt
>> @@ -142,7 +142,7 @@ This option is only applicable in non-verbose mode.
>> List both remote-tracking branches and local branches.
>>
>> --list::
>> - Activate the list mode. `git branch <pattern>` would try to create a branch,
>> + Activate the list mode. `git branch <branchname>` would try to create a branch,
>> use `git branch --list <pattern>` to list matching branches.
>
> This makes the description more correct.
>
> I am not sure if it makes that much sense to have that sentence here
> in the first place (after all, it is describing a behaviour of a
> mode that is *not* the list mode), but I guess that it may be a
> common mistake to forget to specify "-l" while asking for branches
> that match the pattern? If we were writing this today from scratch,
> I would perhaps write something entirely different, e.g.
>
> --list::
> List branches. With optional <pattern>... at the
> end of the command line, list only the branches that
> match any of the given patterns. Do not forget '-l'
> and say "git branch <pattern>", as it will instead
> try to create a new branch whose name is <pattern>,
> which is a common mistake.
Hmm, but with git-branch -l means --create-reflog not --list.
I have make the mistake of using -l rather than --list several
times ... :D
ATB,
Ramsay Jones
next prev parent reply other threads:[~2017-03-23 17:44 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-23 12:03 [PATCH] branch doc: Change `git branch <pattern>` to use `<branchname>` Ævar Arnfjörð Bjarmason
2017-03-23 17:01 ` Junio C Hamano
2017-03-23 17:44 ` Ramsay Jones [this message]
2017-03-23 19:01 ` Junio C Hamano
2017-03-23 21:07 ` Ævar Arnfjörð Bjarmason
2017-03-23 21:31 ` Junio C Hamano
2017-03-24 0:48 ` Jonathan Nieder
2017-03-24 4:56 ` [PATCH] branch doc: update description for `--list` Junio C Hamano
2017-03-24 5:00 ` Jonathan Nieder
2017-03-24 11:06 ` Ævar Arnfjörð Bjarmason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5d04c82c-45a4-5d5e-0317-511587ee3474@ramsayjones.plus.com \
--to=ramsay@ramsayjones.plus.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).