[PATCH v3 8/9] doc: notes: treat --stdin equally between copy/remove
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- May 27, 2025, 21:19 UTC
- Message-ID
- <530dd953170e14ff02dfb6c84b1188745a8b1501.1748380390.git.code@khaugsbakk.name>
- In-Reply-To
- <cover.1748380390.git.code@khaugsbakk.name>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
46538012d94 (notes remove: --stdin reads from the standard input, 2011-05-18) added `--stdin` for the `remove` subcommand, documenting it in the “Options” section. But `copy --stdin` was added before that, in 160baa0d9cb (notes: implement 'git notes copy --stdin', 2010-03-12).
Treat this option equally between the two subcommands:
• remove: mention `--stdin` on the subcommand as well, like for `copy` • copy: mention it as well under the option documentation
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> ---
Notes (series):
v3:
• Rephrase to “Only valid for”
Link: https://lore.kernel.org/git/xmqqecwfvwdu.fsf@gitster.g/
v2:
• On --stdin: just refer to the respective subcommands and stop there.
As suggested.
Link: https://lore.kernel.org/git/xmqq34czhyz8.fsf@gitster.g/Documentation/git-notes.adoc | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-notes.adoc b/Documentation/git-notes.adoc index 9ce71ec3455..397f6caa92a 100644 --- a/Documentation/git-notes.adoc +++ b/Documentation/git-notes.adoc @@ -127,6 +127,10 @@ When done, the user can either finalize the merge with giving zero or one object from the command line, this is equivalent to specifying an empty note message to the `edit` subcommand. ++ +In `--stdin` mode, also remove the object names given on standard +input. In other words, `--stdin` can be combined with object names from +the command line. `prune`:: Remove all notes for non-existing/unreachable objects. @@ -208,9 +212,7 @@ future. object that does not have notes attached to it. `--stdin`:: - Also read the object names to remove notes from the standard - input (there is no reason you cannot combine this with object - names from the command line). + Only valid for `remove` and `copy`. See the respective subcommands. `-n`:: `--dry-run`::
-- 2.49.0.780.g892193c3f50