From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH] branch doc: Change `git branch <pattern>` to use `<branchname>`
Date: Thu, 23 Mar 2017 14:31:52 -0700 [thread overview]
Message-ID: <xmqq37e3brxz.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <CACBZZX7vW0TkbrBvLvKWnY=UpHNHzzQ7wuwhEhNOjCCjzPVMjA@mail.gmail.com> ("Ævar Arnfjörð Bjarmason"'s message of "Thu, 23 Mar 2017 22:07:55 +0100")
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
>>> --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.
>
> I'm just doing s/pattern/branchname/ on the existing documentation. If
> you'd like to entirely reword this to make that unnecessary that
> sounds good, but makes sense that you then submit that patch & just
> drop this one, rather than me copy/pasting your proposal, sending that
> as my own patch etc...
That is sensible. I've already queued yours as-is a few hours ago,
and the remainder of this message is in preparation for a follow-up
patch that is a separate topic.
>> --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.
>
> I like the old one better. It has 3 actual command examples you can
> readily see.
Having the _wrong_ example `git branch <branchname>` that is readily
available for cutting and pasting is the worst of the three reasons
why I think the current text is bad (the other two being "it does
not even help in explaining the `--list` option" and "The argument
to the other mode is not <pattern> but is <branchname>").
I can go without "Do not forget ..." and everything that follows,
though, and if we are going to do so, then
--list::
List branches. With optional <pattern>...,
e.g. `git branch --list 'maint-*`, list only the
branches that match the pattern(s).
would be fine. I am not opposed to having an visually distinctive
example--I just do not want to have one that is wrong without
clearly marking it as such.
next prev parent reply other threads:[~2017-03-23 21:31 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
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 [this message]
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=xmqq37e3brxz.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
/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).