Skip to content
  • Jeff King's avatar
    docs: monospace listings in docbook output · c2a7f5d4
    Jeff King authored and Junio C Hamano's avatar Junio C Hamano committed
    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: default avatarJeff King <peff@peff.net>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    c2a7f5d4