| commit | 1c262bb7b2968a8eecca3fed366638e0779184bb | |
| author | Jeff King <peff@peff.net> | |
| Wed, 13 May 2015 05:01:38 +0000 (13 01:01 -0400) | ||
| committer | Junio C Hamano <gitster@pobox.com> | |
| Wed, 13 May 2015 05:14:46 +0000 (12 22:14 -0700) | ||
| tree | da23b914b6d41a3f2e42dcc7cc4d5ce90a29b3e0 | treesnapshot (tar.gz zip) |
| parent | 0a3ca9c011c274f4e38a6a4508f5a370b32a0745 | commitdiff |
doc: convert \--option to --option
Older versions of AsciiDoc would convert the "--" in
"--option" into an emdash. According to 565e135
(Documentation: quote double-dash for AsciiDoc, 2011-06-29),
this is fixed in AsciiDoc 8.3.0. According to bf17126, we
don't support anything older than 8.4.1 anyway, so we no
longer need to worry about quoting.
Even though this does not change the output at all, there
are a few good reasons to drop the quoting:
1. It makes the source prettier to read.
2. We don't quote consistently, which may be confusing when
reading the source.
3. Asciidoctor does not like the quoting, and renders a
literal backslash.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Older versions of AsciiDoc would convert the "--" in
"--option" into an emdash. According to 565e135
(Documentation: quote double-dash for AsciiDoc, 2011-06-29),
this is fixed in AsciiDoc 8.3.0. According to bf17126, we
don't support anything older than 8.4.1 anyway, so we no
longer need to worry about quoting.
Even though this does not change the output at all, there
are a few good reasons to drop the quoting:
1. It makes the source prettier to read.
2. We don't quote consistently, which may be confusing when
reading the source.
3. Asciidoctor does not like the quoting, and renders a
literal backslash.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>