]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: notes: treat --stdin equally between copy/remove
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Tue, 27 May 2025 21:19:37 +0000 (23:19 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 27 May 2025 22:31:07 +0000 (15:31 -0700)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-notes.adoc

index 9ce71ec34552c58cd7c3ae95ef09a7d2d28eba93..397f6caa92a35dff8615568c375c9618ff9fc6df 100644 (file)
@@ -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`::