Git development
 help / color / mirror / Atom feed
From: "Philip Oakley" <philipoakley@iee.org>
To: "Duy Nguyen" <pclouds@gmail.com>,
	"Dannier Castro L" <danniercl@gmail.com>
Cc: "Git Mailing List" <git@vger.kernel.org>,
	"Junio C Hamano" <gitster@pobox.com>,
	"Matthieu Moy" <Matthieu.Moy@imag.fr>,
	"Jonathan Nieder" <jrnieder@gmail.com>,
	"Brandon Williams" <bmwill@google.com>
Subject: Re: Re: [PATCH 1/3] checkout.c: add strict usage of -- before file_path
Date: Mon, 14 May 2018 00:06:56 +0100	[thread overview]
Message-ID: <190EC44928954138B9E9E78BA2323639@PhilipOakley> (raw)
In-Reply-To: 775fe020-be92-f65c-5a67-e83e6bf4777f@gmail.com

From: "Dannier Castro L" <danniercl@gmail.com>
> On 13/05/2018 00:03, Duy Nguyen wrote:
>
>> On Sun, May 13, 2018 at 4:23 AM, Dannier Castro L <danniercl@gmail.com>
>> wrote:
>>> For GIT new users, this complicated versatility of <checkout> could
>>> be very confused, also considering that actually the flag '--' is
>>> completely useless (added or not, there is not any difference for
>>> this command), when the same program messages promote the use of
>>> this flag.
>> I would like an option to revert back to current behavior. I'm not a
>> new user. I know what I'm doing. Please don't make me type more.
>>
>> And '--" is not completely useless. If you have <file> and <branch>
>> with the same name, you have to give "--" to to tell git what the
>> first argument means.
>
> Sure Duy, you're right, probably "completely useless" is not the correct
> definition, even according with the code I didn't find another useful
> case that is not file and branch with the same name. The program is able
> to know the type using only the name, turning "--" into an extra flag in
> most of cases.
>
> I think this solution could please you more: By default the configuration
> is the current, but the user has the chance to set this, for example:
>
> git config --global flag.strictdashdash true
>
> Thank you so much for the spent time reviewing the patch, this is my
> first one in this repository.

It maybe that after review you could suggest an appropriate rewording or
re-arrangement of the man page to better highlight the proper use of the
'--' disambiguation.

Perhaps frame the man page as if it is normal for the '--' to be included
within command lines (which should be the case for scripts anyway!).

Then indicate that it isn't mandatory if the file/branch/dwim distinction is
obvious. i.e. make sure that the man page is educational as well as being a
reference that may be misunderstood.

Those well versed in the Git cli will normally omit the '--', only using it
where necessary, however for a new users/readers of the man page, it may be
better to be more explicit and avoid future misunderstandings.

--
Philip


  parent reply	other threads:[~2018-05-13 23:07 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-13  2:23 [PATCH 1/3] checkout.c: add strict usage of -- before file_path Dannier Castro L
2018-05-13  2:23 ` [PATCH 2/3] test: update tests for strict usage of -- checkout Dannier Castro L
2018-05-13  2:23 ` [PATCH 3/3] doc: update doc " Dannier Castro L
2018-05-13  6:03 ` [PATCH 1/3] checkout.c: add strict usage of -- before file_path Duy Nguyen
2018-05-13 19:11   ` Dannier Castro L
2018-05-13 20:18     ` SZEDER Gábor
2018-05-13 23:06     ` Philip Oakley [this message]
2018-05-14  1:51   ` Junio C Hamano
2018-05-13 21:02 ` Kevin Daudt
2018-05-14 14:52   ` Duy Nguyen
2018-05-14 15:43     ` Duy Nguyen

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=190EC44928954138B9E9E78BA2323639@PhilipOakley \
    --to=philipoakley@iee.org \
    --cc=Matthieu.Moy@imag.fr \
    --cc=bmwill@google.com \
    --cc=danniercl@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=pclouds@gmail.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox