summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.conf
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2012-08-07 20:07:38 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-08-07 21:30:52 (GMT)
commitc2a7f5d43843d16850a460e7f202affb0d24dc48 (patch)
tree0984c211ca17b6d68eb51245d56179ed8d86388c /Documentation/user-manual.conf
parent828ea97de486c1693d6e4f2c7347acb50235a85d (diff)
downloadgit-c2a7f5d43843d16850a460e7f202affb0d24dc48.zip
git-c2a7f5d43843d16850a460e7f202affb0d24dc48.tar.gz
git-c2a7f5d43843d16850a460e7f202affb0d24dc48.tar.bz2
docs: monospace listings in docbook output
When asciidoc converts a listing block like: ---------------------- $ git log --merge ---------------------- it marks it to be displayed in a monospace font. This works fine when generating HTML output. However, when generating docbook output, we override the expansion of a listingblock to work around bugs in some versions of the docbook toolchain. Our override did not mark the listingblock with the "monospaced" class. The main output that uses docbook as an intermediate format is the manpages. We didn't notice any issue there because the monospaced class seems to be ignored when generating roff from the docbook manpages. However, when generating texinfo to make info pages, docbook does respect this class. The resulting texinfo output properly uses "@example" blocks to display the listing in this case. Besides possibly looking prettier in some texinfo backends, one important effect is that the monospace font suppresses texinfo's expansion of "--" and "---" into en-dashes and em-dashes. With the current code, the example above ends up looking like "git log -merge", which is confusing and wrong. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/user-manual.conf')
-rw-r--r--Documentation/user-manual.conf2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/user-manual.conf b/Documentation/user-manual.conf
index 339b309..d87294d 100644
--- a/Documentation/user-manual.conf
+++ b/Documentation/user-manual.conf
@@ -14,7 +14,7 @@ ifdef::backend-docbook[]
# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
[listingblock]
<example><title>{title}</title>
-<literallayout>
+<literallayout class="monospaced">
|
</literallayout>
{title#}</example>