From: Chris Johnsen <chris_johnsen@pobox.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>
Subject: [PATCH 0/8] Documentation: XSLT/asciidoc.conf cleanup; tty literals
Date: Tue, 24 Mar 2009 03:04:18 -0500 [thread overview]
Message-ID: <1237881866-5497-1-git-send-email-chris_johnsen@pobox.com> (raw)
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 reply other threads:[~2009-03-24 8:06 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-03-24 8:04 Chris Johnsen [this message]
2009-03-24 8:04 ` [PATCH 1/8] Documentation: move callouts.xsl to manpage-{base,normal}.xsl Chris Johnsen
2009-03-24 8:51 ` Jeff King
2009-03-24 19:36 ` Chris Johnsen
2009-03-26 9:40 ` Jeff King
2009-03-24 8:04 ` [PATCH 2/8] Documentation: use parametrized manpage-base.xsl with manpage-{1.72,normal}.xsl Chris Johnsen
2009-03-24 8:57 ` Jeff King
2009-03-24 19:42 ` Chris Johnsen
2009-03-24 8:04 ` [PATCH 3/8] Documentation: rename docbook-xsl-172 attribute to git-asciidoc-no-roff Chris Johnsen
2009-03-24 9:04 ` Jeff King
2009-03-24 19:48 ` Chris Johnsen
2009-03-26 9:43 ` Jeff King
2009-03-26 16:47 ` Junio C Hamano
2009-03-26 18:49 ` Michael J Gruber
2009-03-24 8:04 ` [PATCH 4/8] Documentation: move quieting params into manpage-base.xsl Chris Johnsen
2009-03-24 9:18 ` Jeff King
2009-03-25 4:21 ` [PATCH 1/2] Documentation/Makefile: make most operations "quiet" Chris Johnsen
2009-03-25 4:21 ` [PATCH 2/2] Documentation/Makefile: break up texi pipeline Chris Johnsen
2009-03-25 4:28 ` [PATCH 1/2] Documentation/Makefile: make most operations "quiet" Jeff King
2009-03-25 9:55 ` Chris Johnsen
2009-03-24 8:04 ` [PATCH 5/8] Documentation: move "spurious .sp" code into manpage-base.xsl Chris Johnsen
2009-03-24 8:04 ` [PATCH 6/8] Documentation: asciidoc.conf: always use <literallayout> for [blocktext] Chris Johnsen
2009-03-24 8:04 ` [PATCH 7/8] Documentation: asciidoc.conf: fix verse block with block titles Chris Johnsen
2009-03-24 8:04 ` [PATCH 8/8] Documentation: option to render literal text as bold for manpages Chris Johnsen
2009-03-26 8:59 ` [PATCH 0/8] Documentation: XSLT/asciidoc.conf cleanup; tty literals Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1237881866-5497-1-git-send-email-chris_johnsen@pobox.com \
--to=chris_johnsen@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).