diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2025-10-08 13:48:46 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-10-10 07:56:09 -0700 |
| commit | b3ac6e737db8635aaed0c355ebaf291b63fb0461 (patch) | |
| tree | 375d37c779eb9fb067d7d617660ef016b26f1261 /Documentation/git-config.adoc | |
| parent | c44beea485f0f2feaf460e2ac87fdd5608d63cf0 (diff) | |
| download | git-b3ac6e737db8635aaed0c355ebaf291b63fb0461.tar.gz | |
doc: fix accidental literal blocks
Make sure that normal paragraphs in most user-facing docs[1] don’t
use literal blocks. This can easily happen if you try to maintain
indentation in order to continue a block; that might work in
e.g. Markdown variants, but not in AsciiDoc.
The fixes are straightforward, i.e. just deindent the block and maybe
add line continuations. The only exception is git-sparse-checkout(1)
where we also replace indentation used for *intended* literal blocks
with `----`.
† 1: These have not been considered:
• `Documentation/howto/`
• `Documentation/technical/`
• `Documentation/gitprotocol*`
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-config.adoc')
| -rw-r--r-- | Documentation/git-config.adoc | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/git-config.adoc b/Documentation/git-config.adoc index 511b2e26bf..a633ab8ec3 100644 --- a/Documentation/git-config.adoc +++ b/Documentation/git-config.adoc @@ -117,15 +117,15 @@ OPTIONS --comment <message>:: Append a comment at the end of new or modified lines. - - If _<message>_ begins with one or more whitespaces followed - by "#", it is used as-is. If it begins with "#", a space is - prepended before it is used. Otherwise, a string " # " (a - space followed by a hash followed by a space) is prepended - to it. And the resulting string is placed immediately after - the value defined for the variable. The _<message>_ must - not contain linefeed characters (no multi-line comments are - permitted). ++ +If _<message>_ begins with one or more whitespaces followed +by "#", it is used as-is. If it begins with "#", a space is +prepended before it is used. Otherwise, a string " # " (a +space followed by a hash followed by a space) is prepended +to it. And the resulting string is placed immediately after +the value defined for the variable. The _<message>_ must +not contain linefeed characters (no multi-line comments are +permitted). --all:: With `get`, return all values for a multi-valued key. |