mirror of
https://github.com/git/git.git
synced 2026-04-12 01:40:10 +02:00
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 <gitster@pobox.com> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
committed by
Junio C Hamano
parent
159c42a063
commit
5471b190f8
@@ -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 <object> -m<message>`,
|
||||
`--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 <ref>`::
|
||||
Manipulate the notes tree in _<ref>_. This overrides
|
||||
|
||||
Reference in New Issue
Block a user