[PATCH v2 5/9] doc: notes: remove stripspace discussion from other options
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- May 23, 2025, 19:29 UTC
- Message-ID
- <f4755040f38170b508e9cba03a7226b5b4d5cd9c.1748028010.git.code@khaugsbakk.name>
- In-Reply-To
- <cover.1748028010.git.code@khaugsbakk.name>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
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> ---
Notes (series):
v2:
• New
• Together with one other patch replaces v1 patch “doc: notes:
mention comment character configuration”
• I figured out that mentioning the comment character/comment lines
doesn’t make sense here. So all attempts to rephrase “comment
character” or “lines that start with `#`” are goneDocumentation/git-notes.adoc | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-notes.adoc b/Documentation/git-notes.adoc index d672794a942..383e8bca685 100644 --- a/Documentation/git-notes.adoc +++ b/Documentation/git-notes.adoc @@ -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>`::
-- 2.49.0.780.g892193c3f50