From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Thomas Gummerer <t.gummerer@gmail.com>,
Junio C Hamano <gitster@pobox.com>,
Eric Sunshine <sunshine@sunshineco.com>
Subject: [PATCH v3 03/10] pretty-options.txt: --notes accepts a ref instead of treeish
Date: Wed, 20 Nov 2019 13:18:31 -0800 [thread overview]
Message-ID: <4989956f128fe36f743c25aacc89aae14be845ff.1574284470.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1574284470.git.liu.denton@gmail.com>
Although `--notes=` accepts and handles a tree-ish just fine, it isn't a
common use-case for users to pass in bare trees. By having "treeish", it
makes it harder to click in users' minds that the argument here is the
same type as the `notes.displayRef` configuration variable, for example.
Change `treeish` to `ref` so that it will be easier for users to make
this connection.
Note that we don't completely lose the notion that `--notes=` can accept
a tree-ish. In git-notes.txt, we have
It is also permitted for a notes ref to point directly to a tree
object, in which case the history of the notes can be read with
`git log -p -g <refname>`.
which means that a hardcore user who wants to take advantage of this
obscure use-case will be able to infer the connection and not be
completely left in the dark.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Documentation/pretty-options.txt | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index e44fc8f738..6893a4a7ba 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -57,7 +57,7 @@ message by 4 spaces (i.e. 'medium', which is the default, 'full',
and 'fuller').
ifndef::git-rev-list[]
---notes[=<treeish>]::
+--notes[=<ref>]::
Show the notes (see linkgit:git-notes[1]) that annotate the
commit, when showing the commit log message. This is the default
for `git log`, `git show` and `git whatchanged` commands when
@@ -68,8 +68,8 @@ By default, the notes shown are from the notes refs listed in the
`core.notesRef` and `notes.displayRef` variables (or corresponding
environment overrides). See linkgit:git-config[1] for more details.
+
-With an optional '<treeish>' argument, use the treeish to find the notes
-to display. The treeish can specify the full refname when it begins
+With an optional '<ref>' argument, use the ref to find the notes
+to display. The ref can specify the full refname when it begins
with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
`refs/notes/` is prefixed to form a full name of the ref.
+
@@ -85,7 +85,7 @@ being displayed. Examples: "--notes=foo" will show only notes from
"--notes --notes=foo --no-notes --notes=bar" will only show notes
from "refs/notes/bar".
---show-notes[=<treeish>]::
+--show-notes[=<ref>]::
--[no-]standard-notes::
These options are deprecated. Use the above --notes/--no-notes
options instead.
--
2.24.0.450.g7a9a4598a9
next prev parent reply other threads:[~2019-11-20 21:18 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-19 1:06 [PATCH 0/3] range-diff: don't compare notes Denton Liu
2019-11-19 1:06 ` [PATCH 1/3] t3206: remove spaces after redirect operators Denton Liu
2019-11-19 1:06 ` [PATCH 2/3] t3206: demonstrate failure with notes Denton Liu
2019-11-19 3:03 ` Junio C Hamano
2019-11-19 1:06 ` [PATCH 3/3] range-diff: use --no-notes to generate patches Denton Liu
2019-11-19 2:56 ` [PATCH 0/3] range-diff: don't compare notes Junio C Hamano
2019-11-19 23:55 ` [PATCH v2 0/8] range-diff: learn `--notes` Denton Liu
2019-11-19 23:55 ` [PATCH v2 1/8] argv-array: add space after `while` Denton Liu
2019-11-19 23:55 ` [PATCH v2 2/8] rev-list-options.txt: remove reference to --show-notes Denton Liu
2019-11-19 23:55 ` [PATCH v2 3/8] t3206: remove spaces after redirect operators Denton Liu
2019-11-20 0:20 ` Eric Sunshine
2019-11-19 23:55 ` [PATCH v2 4/8] t3206: s/expected/expect/ Denton Liu
2019-11-19 23:55 ` [PATCH v2 5/8] t3206: demonstrate current notes behavior Denton Liu
2019-11-20 4:17 ` Junio C Hamano
2019-11-19 23:55 ` [PATCH v2 6/8] range-diff: output `## Notes ##` header Denton Liu
2019-11-19 23:55 ` [PATCH v2 7/8] range-diff: passthrough --[no-]notes to `git log` Denton Liu
2019-11-20 4:26 ` Junio C Hamano
2019-11-20 19:12 ` Denton Liu
2019-11-21 12:43 ` Eric Sunshine
2019-11-21 18:35 ` Denton Liu
2019-11-19 23:55 ` [PATCH v2 8/8] format-patch: pass notes configuration to range-diff Denton Liu
2019-11-20 21:18 ` [PATCH v3 00/10] range-diff: learn `--notes` Denton Liu
2019-11-20 21:18 ` [PATCH v3 01/10] argv-array: add space after `while` Denton Liu
2019-11-20 21:18 ` [PATCH v3 02/10] rev-list-options.txt: remove reference to --show-notes Denton Liu
2019-11-20 21:18 ` Denton Liu [this message]
2019-11-20 21:18 ` [PATCH v3 04/10] t3206: remove spaces after redirect operators Denton Liu
2019-11-20 21:18 ` [PATCH v3 05/10] t3206: disable parameter substitution in heredoc Denton Liu
2019-11-20 21:18 ` [PATCH v3 06/10] t3206: s/expected/expect/ Denton Liu
2019-11-20 21:18 ` [PATCH v3 07/10] t3206: range-diff compares logs with commit notes Denton Liu
2019-11-20 21:18 ` [PATCH v3 08/10] range-diff: output `## Notes ##` header Denton Liu
2019-11-20 21:18 ` [PATCH v3 09/10] range-diff: pass through --notes to `git log` Denton Liu
2019-11-20 21:18 ` [PATCH v3 10/10] format-patch: pass notes configuration to range-diff 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4989956f128fe36f743c25aacc89aae14be845ff.1574284470.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sunshine@sunshineco.com \
--cc=t.gummerer@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.