From: Junio C Hamano <gitster@pobox•com>
To: Scott Schmit <i.grok@comcast•net>
Cc: Alexander Kuleshov <kuleshovmail@gmail•com>, git@vger•kernel.org
Subject: Re: [PATCH] stash: git stash create and git stash store added to git stash usage synopsys
Date: Wed, 14 Jan 2015 09:43:29 -0800 [thread overview]
Message-ID: <xmqqy4p59s1q.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <20150114031137.GA12605@odin.ulthar.us> (Scott Schmit's message of "Tue, 13 Jan 2015 22:11:37 -0500")
Scott Schmit <i.grok@comcast•net> writes:
[administrivia: please refrain from using Mail-follow-up-to]
> On Tue, Jan 13, 2015 at 11:54:06PM +0600, Alexander Kuleshov wrote:
>> Signed-off-by: Alexander Kuleshov <kuleshovmail@gmail•com>
>> ---
>> git-stash.sh | 4 +++-
>> 1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/git-stash.sh b/git-stash.sh
>> index 6846b18..6e30380 100755
>> --- a/git-stash.sh
>> +++ b/git-stash.sh
>> @@ -9,7 +9,9 @@ USAGE="list [<options>]
>> or: $dashless branch <branchname> [<stash>]
>> or: $dashless [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
>> [-u|--include-untracked] [-a|--all] [<message>]]
>> - or: $dashless clear"
>> + or: $dashless clear
>> + or: $dashless create [<message>]
>> + or: $dashless store [-m|--message <message>] [-q|--quiet] <commit>"
>>
>> SUBDIRECTORY_OK=Yes
>> OPTIONS_SPEC=
>
> Considering the man page says create & store are intended for scripts
> and "probably not the command you want to use", why would we want it in
> the synopsis?
With the understanding that these are only for scripters, I think we
can agree that we do want to describe them in the manual pages, and
we do not want them in the completion.
I feel "git stash -h" output is on the borderline, and can be argued
both ways:
- When you script and are not clear how a command you wanted to use
in your script is to be used, it wouldn't be a crime to ask the
short "git stash -h" form (instead of the full manual page "git
stash --help") to remind how the command line ought to be
spelled.
- When you are not interested in script at all, from the command
line you may want to be reminded how to spell the subcommand with
"git stash -h" form. Having "store" listed, which will never be
what you want in this scenario, will be confusing. You want to
see "save".
So, I dunno.
next prev parent reply other threads:[~2015-01-14 17:43 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-13 17:54 [PATCH] stash: git stash create and git stash store added to git stash usage synopsys Alexander Kuleshov
2015-01-14 3:11 ` Scott Schmit
2015-01-14 17:43 ` Junio C Hamano [this message]
2015-02-12 22:54 ` Junio C Hamano
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=xmqqy4p59s1q.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=i.grok@comcast$(echo .)net \
--cc=kuleshovmail@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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