From: Eric Sunshine <sunshine@sunshineco.com>
To: Denton Liu <liu.denton@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH 1/9] git-stash.txt: be explicit about subcommand options
Date: Tue, 2 Feb 2021 12:37:07 -0500 [thread overview]
Message-ID: <CAPig+cRuD19xwfmkn2E4669n+0BPJg24NBOp-Zjv9uKDTXedFA@mail.gmail.com> (raw)
In-Reply-To: <17675b9e4c0c50e6bfd5219c933b5ba1148ab86c.1612258145.git.liu.denton@gmail.com>
On Tue, Feb 2, 2021 at 4:36 AM Denton Liu <liu.denton@gmail.com> wrote:
> Currently, the options for the `list` and `show` subcommands are just
> listed as `<options>`. This seems to imply, from a cursory glance at the
> summary, that they take the stash options listed below. However, reading
> more carefully, we see that they take log options and diff options
> respectively.
>
> Make it more obvious that they take log and diff options by explicitly
> stating this in the subcommand summary.
>
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> @@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q
> -list [<options>]::
> +list [<log options>]::
>
> -show [<options>] [<stash>]::
> +show [<diff options>] [<stash>]::
I might suggest that it is more common to hyphenate these words than
to separate them with spaces:
list [<log-options>]::
show [<diff-options>] [<stash>]::
next prev parent reply other threads:[~2021-02-02 17:44 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-02 9:31 [PATCH 0/9] stash show: learn --include-untracked and --only-untracked Denton Liu
2021-02-02 9:33 ` [PATCH 1/9] git-stash.txt: be explicit about subcommand options Denton Liu
2021-02-02 17:37 ` Eric Sunshine [this message]
2021-02-02 9:33 ` [PATCH 2/9] t3905: remove spaces after redirect operators Denton Liu
2021-02-02 9:33 ` [PATCH 3/9] t3905: move all commands into test cases Denton Liu
2021-02-02 21:41 ` Junio C Hamano
2021-02-02 9:33 ` [PATCH 4/9] t3905: remove nested git in command substitution Denton Liu
2021-02-02 9:33 ` [PATCH 5/9] t3905: replace test -s with test_file_not_empty Denton Liu
2021-02-02 9:33 ` [PATCH 6/9] t3905: use test_cmp() to check file contents Denton Liu
2021-02-02 9:33 ` [PATCH 7/9] stash: declare ref_stash as an array Denton Liu
2021-02-02 21:46 ` Junio C Hamano
2021-02-02 9:33 ` [PATCH 8/9] stash show: teach --include-tracked and --only-untracked Denton Liu
2021-02-02 21:56 ` Junio C Hamano
2021-02-02 9:33 ` [PATCH 9/9] stash show: learn stash.showIncludeUntracked Denton Liu
2021-02-09 7:28 ` [PATCH v2 0/9] stash show: learn --include-untracked and --only-untracked Denton Liu
2021-02-09 7:28 ` [PATCH v2 1/9] git-stash.txt: be explicit about subcommand options Denton Liu
2021-02-10 7:17 ` Junio C Hamano
2021-02-11 19:07 ` [PATCH] fixup! " Denton Liu
2021-02-09 7:28 ` [PATCH v2 2/9] t3905: remove spaces after redirect operators Denton Liu
2021-02-10 7:18 ` Junio C Hamano
2021-02-09 7:28 ` [PATCH v2 3/9] t3905: move all commands into test cases Denton Liu
2021-02-09 7:28 ` [PATCH v2 4/9] t3905: remove nested git in command substitution Denton Liu
2021-02-10 7:24 ` Junio C Hamano
2021-02-09 7:28 ` [PATCH v2 5/9] t3905: replace test -s with test_file_not_empty Denton Liu
2021-02-09 7:28 ` [PATCH v2 6/9] t3905: use test_cmp() to check file contents Denton Liu
2021-02-09 7:28 ` [PATCH v2 7/9] stash: declare ref_stash as an array Denton Liu
2021-02-10 7:28 ` Junio C Hamano
2021-02-09 7:28 ` [PATCH v2 8/9] stash show: teach --include-untracked and --only-untracked Denton Liu
2021-02-10 7:53 ` Junio C Hamano
2021-02-16 3:15 ` Denton Liu
2021-02-16 6:42 ` Junio C Hamano
2021-02-09 7:28 ` [PATCH v2 9/9] stash show: learn stash.showIncludeUntracked Denton Liu
2021-02-16 7:11 ` [PATCH v3 0/2] stash show: learn --include-untracked and --only-untracked Denton Liu
2021-02-16 7:11 ` [PATCH v3 1/2] stash show: teach " Denton Liu
2021-02-16 20:22 ` Junio C Hamano
2021-02-17 11:18 ` Denton Liu
2021-02-17 17:50 ` Junio C Hamano
2021-02-17 2:31 ` Junio C Hamano
2021-02-16 7:11 ` [PATCH v3 2/2] stash show: learn stash.showIncludeUntracked Denton Liu
2021-03-03 11:16 ` [PATCH v4 0/2] stash show: learn --include-untracked and --only-untracked Denton Liu
2021-03-03 11:16 ` [PATCH v4 1/2] stash show: teach " Denton Liu
2021-03-03 11:16 ` [PATCH v4 2/2] stash show: learn stash.showIncludeUntracked Denton Liu
2021-03-04 0:38 ` [PATCH v4 0/2] stash show: learn --include-untracked and --only-untracked Junio C Hamano
2021-03-04 1:33 ` Denton Liu
2021-03-04 1:42 ` Denton Liu
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=CAPig+cRuD19xwfmkn2E4669n+0BPJg24NBOp-Zjv9uKDTXedFA@mail.gmail.com \
--to=sunshine@sunshineco.com \
--cc=git@vger.kernel.org \
--cc=liu.denton@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.
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).