Thread (29 messages) 29 messages, 3 authors, 2025-05-27
STALE417d
Revisions (2)
  1. v2 current
  2. v3 [diff vs current]

[PATCH v2 8/9] doc: notes: treat --stdin equally between copy/remove

From: <hidden>
Date: 2025-05-23 19:32:17
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

From: Kristoffer Haugsbakk <redacted>

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 <redacted>
---

Notes (series):
    v2:
    • On --stdin: just refer to the respective subcommands and stop there.
      As suggested.
    
      Link: https://lore.kernel.org/git/xmqq34czhyz8.fsf@gitster.g/ (local)

 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 ad152aa94ce..a0167af5aba 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.
@@ -207,9 +211,7 @@ previous `-C`.
 	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).
+	For `remove` and `copy`. See the respective subcommands.
 
 `-n`::
 `--dry-run`::
-- 
2.49.0.780.g892193c3f50
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help