git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 0/8] Documentation: XSLT/asciidoc.conf cleanup; tty literals

From
Chris Johnsen <chris_johnsen@pobox.com>
Date
Mar 24, 2009, 08:04 UTC
Message-ID
<1237881866-5497-1-git-send-email-chris_johnsen@pobox.com>

I had a go at wrangling with the documentation generation tools to fix a couple of issues that I had noticed.

First, I could never get reasonable output for generated manpages. I have asciidoc 8.3.1 and docbook-xsl 1.74.0 on my system. They chew through the documentation OK, but I was never sure which flags I should use with them.

ASCIIDOC8 never seemed to do much (I was probably not looking in the right places), but I decided to leave it enabled since it is entirely outside the scope of the git code/configuration.

The other variable was DOCBOOK_XSL_172, and no matter which way I turned it, I always got flawed output. If I set it, I would get funky characters in the callout sections. If I unset it, I would get ".ft C" and ".ft" bracketing literal blocks.

Second, the inline literal text of both the official and my generated manpages was indistinguishable from the surrounding text when viewing manpages in a terminal. It turns out the official manpages end up with no markup for inline literal text. The ones I generated did have some markup, but it was flagged as monospace text, which is not all that distinguishable from the normal, roman text when viewing through a terminal.

So I set about trying to solve these problems along with the meta-problem of code duplication between callouts.xsl and manpage-1.72.xsl.

The following series is my attempt to
  eliminate the XSLT code duplication,
  tease apart the uses of the "1.72" label that apply only to
    docbook-xsl 1.72 and those that also apply to some other
    versions of docbook-xsl,
  unify some of the items that look like they were applied to
    only one side of various "1.72" configurations but still
    seemed applicable to the other,
  fix a mostly unrelated, small, latent bug in asciidoc.conf,
  and provide an option to differentiate inline literal text when
    viewed on a terminal.
  Documentation/Makefile                 |   37 ++++++++++++++++++++++--
  Documentation/asciidoc.conf            |   15 +++++----
  Documentation/callouts.xsl             |   30 --------------------
  Documentation/manpage-1.72.xsl         |   28 ++++++------------
  Documentation/manpage-base.xsl         |   48 ++++++++++++++++++++++++++++++++
  Documentation/manpage-bold-literal.xsl |   17 +++++++++++
  Documentation/manpage-normal.xsl       |   12 ++++++++
  7 files changed, 129 insertions(+), 58 deletions(-)
-- 
Chris
Next: Chris Johnsen
Message 1 of 25 in “Documentation: XSLT/asciidoc.conf cleanup; tty literals”
  1. 0/8 Documentation: XSLT/asciidoc.conf cleanup; tty literalsChris Johnsen, Mar 24, 2009
  2. 1/8 Documentation: move callouts.xsl to manpage-{base,normal}.xslChris Johnsen, Mar 24, 2009
  3. Jeff KingMar 24, 2009
  4. Chris JohnsenMar 24, 2009
  5. Jeff KingMar 26, 2009
  6. 2/8 Documentation: use parametrized manpage-base.xsl with manpage-{1.72,normal}.xslChris Johnsen, Mar 24, 2009
  7. Jeff KingMar 24, 2009
  8. Chris JohnsenMar 24, 2009
  9. 3/8 Documentation: rename docbook-xsl-172 attribute to git-asciidoc-no-roffChris Johnsen, Mar 24, 2009
  10. Jeff KingMar 24, 2009
  11. Chris JohnsenMar 24, 2009
  12. Jeff KingMar 26, 2009
  13. Junio C HamanoMar 26, 2009
  14. Michael J GruberMar 26, 2009
  15. 4/8 Documentation: move quieting params into manpage-base.xslChris Johnsen, Mar 24, 2009
  16. Jeff KingMar 24, 2009
  17. 1/2 Documentation/Makefile: make most operations "quiet"Chris Johnsen, Mar 25, 2009
  18. 2/2 Documentation/Makefile: break up texi pipelineChris Johnsen, Mar 25, 2009
  19. Jeff KingMar 25, 2009
  20. Chris JohnsenMar 25, 2009
  21. 5/8 Documentation: move "spurious .sp" code into manpage-base.xslChris Johnsen, Mar 24, 2009
  22. 6/8 Documentation: asciidoc.conf: always use <literallayout> for [blocktext]Chris Johnsen, Mar 24, 2009
  23. 7/8 Documentation: asciidoc.conf: fix verse block with block titlesChris Johnsen, Mar 24, 2009
  24. 8/8 Documentation: option to render literal text as bold for manpagesChris Johnsen, Mar 24, 2009
  25. Junio C HamanoMar 26, 2009

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.