From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: git@vger.kernel.org
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Jeff King <peff@peff.net>
Subject: [PATCH 0/7] Macro for Asciidoctor support
Date: Sat, 21 Jan 2017 21:59:05 +0000 [thread overview]
Message-ID: <20170121215912.246691-1-sandals@crustytoothpaste.net> (raw)
There are two major processors of AsciiDoc: AsciiDoc itself, and Asciidoctor.
Both have advantages and disadvantages, but traditionally the documentation has
been built with AsciiDoc, leading to some surprising breakage when building with
Asciidoctor. Partially, this is due to the need to specify a significant number
of macros on the command line when building with Asciidoctor.
This series cleans up some issues building the documentation with Asciidoctor
and provides two knobs, USE_ASCIIDOCTOR, which controls building with
Asciidoctor, and ASCIIDOCTOR_EXTENSIONS_LAB, which controls the location of the
Asciidoctor Extensions Lab, which is necessary to expand the linkgit macro.
The need for the extensions could be replaced with a small amount of Ruby code,
if that's considered desirable. Previous opinions on doing so were negative,
however.
In the process, I found several issues with cat-texi.perl, which have been
fixed. It has also been modernized to use strict, warnings, and lexical file
handles. I also made an attempt to produce more diffable texi files; I may
follow up with additional series along this line to make the documentation build
reproducibly.
brian m. carlson (7):
Documentation: fix warning in cat-texi.perl
Documentation: modernize cat-texi.perl
Documentation: remove unneeded argument in cat-texi.perl
Documentation: sort sources for gitman.texi
Documentation: add XSLT to fix DocBook for Texinfo
Documentation: move dblatex arguments into variable
Makefile: add a knob to enable the use of Asciidoctor
Documentation/Makefile | 22 ++++++++++++++++++----
Documentation/cat-texi.perl | 21 ++++++++++++---------
Documentation/texi.xsl | 26 ++++++++++++++++++++++++++
Makefile | 6 ++++++
4 files changed, 62 insertions(+), 13 deletions(-)
create mode 100644 Documentation/texi.xsl
next reply other threads:[~2017-01-21 21:59 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-21 21:59 brian m. carlson [this message]
2017-01-21 21:59 ` [PATCH 1/7] Documentation: fix warning in cat-texi.perl brian m. carlson
2017-01-21 21:59 ` [PATCH 2/7] Documentation: modernize cat-texi.perl brian m. carlson
2017-01-21 21:59 ` [PATCH 3/7] Documentation: remove unneeded argument in cat-texi.perl brian m. carlson
2017-01-21 21:59 ` [PATCH 4/7] Documentation: sort sources for gitman.texi brian m. carlson
2017-01-21 21:59 ` [PATCH 5/7] Documentation: add XSLT to fix DocBook for Texinfo brian m. carlson
2017-01-21 21:59 ` [PATCH 6/7] Documentation: move dblatex arguments into variable brian m. carlson
2017-01-22 1:03 ` Øyvind A. Holm
2017-01-21 21:59 ` [PATCH 7/7] Makefile: add a knob to enable the use of Asciidoctor brian m. carlson
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=20170121215912.246691-1-sandals@crustytoothpaste.net \
--to=sandals@crustytoothpaste.net \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--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).