]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: notes: remove stripspace discussion from other options
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Tue, 27 May 2025 21:19:34 +0000 (23:19 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 27 May 2025 22:31:06 +0000 (15:31 -0700)
Cleaning up whitespace in metadata is typical porcelain behavior and
this default does not need to be pointed out.[1]  Only speak up when
the default `--stripspace` is not used.

Also remove all misleading mentions of comment lines in the process;
see the previous commit.

Also remove the period that trails the parenthetical here.

† 1: See `-F` in git-commit(1) which has nothing to say about whitespace
    cleanup.  The cleanup discussion is on `--cleanup`.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-notes.adoc

index d672794a9427a0112f0d821b635527314a676b21..383e8bca685285efaa56e9408cacfaeef3f9ca45 100644 (file)
@@ -144,26 +144,18 @@ OPTIONS
        Use the given note message (instead of prompting).
        If multiple `-m` options are given, their values
        are concatenated as separate paragraphs.
-       Lines starting with `#` and empty lines other than a
-       single line between paragraphs will be stripped out.
-       If you wish to keep them verbatim, use `--no-stripspace`.
 
 `-F <file>`::
 `--file=<file>`::
        Take the note message from the given file.  Use `-` to
        read the note message from the standard input.
-       Lines starting with `#` and empty lines other than a
-       single line between paragraphs will be stripped out.
-       If you wish to keep them verbatim, use `--no-stripspace`.
 
 `-C <object>`::
 `--reuse-message=<object>`::
        Take the given blob object (for example, another note) as the
        note message. (Use `git notes copy <object>` instead to
-       copy notes between objects.).  By default, message will be
-       copied verbatim, but if you wish to strip out the lines
-       starting with `#` and empty lines other than a single line
-       between paragraphs, use with `--stripspace` option.
+       copy notes between objects.)  Implies `--no-stripspace` since
+       the default behavior is to copy the message verbatim.
 
 `-c <object>`::
 `--reedit-message=<object>`::