From: Kristoffer Haugsbakk Date: Tue, 27 May 2025 21:19:35 +0000 (+0200) Subject: doc: notes: clearly state that --stripspace is the default X-Git-Tag: v2.50.0-rc1~11^2~3 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5471b190f80f2781c4414e347162656ab3b0c4ef;p=thirdparty%2Fgit.git doc: notes: clearly state that --stripspace is the default Clearly state when which of the regular and negated form of the option take effect.[1] Also mention the subtle behavior that occurs when you mix options like `-m` and `-C`, including a note that it might be fixed in the future. The topic was brought up on v8 of the `--separator` series.[2][3] [1]: https://lore.kernel.org/git/xmqqcyct1mtq.fsf@gitster.g/ [2]: https://lore.kernel.org/git/xmqq4jp326oj.fsf@gitster.g/ † 3: v11 was the version that landed Helped-by: Junio C Hamano Signed-off-by: Kristoffer Haugsbakk Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-notes.adoc b/Documentation/git-notes.adoc index 383e8bca68..ef5a939516 100644 --- a/Documentation/git-notes.adoc +++ b/Documentation/git-notes.adoc @@ -179,10 +179,19 @@ OPTIONS Clean up whitespace. Specifically (see linkgit:git-stripspace[1]): + +-- - remove trailing whitespace from all lines - collapse multiple consecutive empty lines into one empty line - remove empty lines from the beginning and end of the input - add a missing `\n` to the last line if necessary. +-- ++ +`--stripspace` is the default except for +`-C`/`--reuse-message`. However, keep in mind that this depends on the +order of similar options. For example, for `-C -m`, +`--stripspace` will be used because the default for `-m` overrides the +previous `-C`. This is a known limitation that may be fixed in the +future. `--ref `:: Manipulate the notes tree in __. This overrides