kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

doc: notes: remove stripspace discussion from other options 

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>
maint
Kristoffer Haugsbakk 2025-05-27 23:19:34 +02:00 committed by Junio C Hamano
parent 6521ca8ec4
commit 159c42a063
1 changed files with 2 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/git-notes.adoc
View File

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


`-c <object>`:: `-c <object>`::
`--reedit-message=<object>`:: `--reedit-message=<object>`::