From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: git@vger.kernel.org
Subject: [PATCH 0/4] Allow building Git with Asciidoctor
Date: Sat, 11 Oct 2014 23:37:32 +0000 [thread overview]
Message-ID: <1413070656-241955-1-git-send-email-sandals@crustytoothpaste.net> (raw)
This series is designed to implement the changes necessary to build Git
using Asciidoctor instead of AsciiDoc.
The first two patches are bug fixes. Asciidoctor is stricter about
title underline lengths (± 1 character instead of 2) and requires
matching delimiter lengths[0]. They're needed regardless of whether the
other two patches are accepted because git-scm.com uses Asciidoctor to
render the documentation, so we might as well render it correctly.
Even with these patches, Asciidoctor warns about everyday.txt and
user-manual.txt. I'm not sending patches for these right now because
I've seen recent series including those and don't want to cause a
merge conflict.
The second two patches implement some basic support for building with
Asciidoctor. The first of these moves some items into variables due to
some differences between the AsciiDoc and Asciidoctor command lines.
The user can then override these values when invoking make.
The final patch adds support for the linkgit macro. Asciidoctor uses
Ruby extensions to implement macro support, unlike AsciiDoc, which uses
a configuration file.
In order to build the documentation successfully, the patches from [1]
are required. The current version of Asciidoctor uses the wrong
elements in some cases and is lacking elements in others when generating
manpage (refentry) output in DocBook format. The need for these patches
is also the reason I didn't implement a configuration macro for
Asciidoctor, as almost nobody will be able to use it at the moment.
With these patches and the ones for Asciidoctor, it's possible to build
the documentation with the following command line:
make doc ASCIIDOC=asciidoctor ASCIIDOC_DOCBOOK=docbook45 ASCIIDOC_HTML=html5 ASCIIDOC_CONF='-I. -rasciidoctor/extensions -rextensions'
brian m. carlson (4):
Documentation: adjust document title underlining
Documentation: fix mismatched delimiters in git-imap-send
Documentation: move some AsciiDoc parameters into variables
Documentation: implement linkgit macro for Asciidoctor
Documentation/Makefile | 18 +++++++++++-------
Documentation/extensions.rb | 39 ++++++++++++++++++++++++++++++++++++++
Documentation/git-imap-send.txt | 4 ++--
Documentation/git-prune-packed.txt | 2 +-
Documentation/git-quiltimport.txt | 2 +-
Documentation/git-stage.txt | 2 +-
6 files changed, 55 insertions(+), 12 deletions(-)
create mode 100644 Documentation/extensions.rb
[0] http://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/
[1] https://github.com/asciidoctor/asciidoctor/pull/1142
--
2.1.1
next reply other threads:[~2014-10-11 23:38 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-10-11 23:37 brian m. carlson [this message]
2014-10-11 23:37 ` [PATCH 1/4] Documentation: adjust document title underlining brian m. carlson
2014-10-13 20:35 ` Junio C Hamano
2014-10-11 23:37 ` [PATCH 2/4] Documentation: fix mismatched delimiters in git-imap-send brian m. carlson
2014-10-11 23:37 ` [PATCH 3/4] Documentation: move some AsciiDoc parameters into variables brian m. carlson
2014-10-15 20:43 ` Junio C Hamano
2014-10-16 1:52 ` brian m. carlson
2014-10-11 23:37 ` [PATCH 4/4] Documentation: implement linkgit macro for Asciidoctor brian m. carlson
2014-10-13 20:41 ` [PATCH 0/4] Allow building Git with Asciidoctor Junio C Hamano
2014-10-14 0:34 ` brian m. carlson
2014-10-14 10:07 ` Jakub Narębski
2014-10-14 11:26 ` brian m. carlson
2014-10-14 9:51 ` Jeff King
2014-10-14 17:08 ` Junio C Hamano
2014-10-15 1:17 ` brian m. carlson
2014-10-15 17:43 ` Junio C Hamano
2014-10-15 11:24 ` Thomas Braun
2014-10-15 23:52 ` brian m. carlson
2014-10-16 22:53 ` Philip Oakley
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=1413070656-241955-1-git-send-email-sandals@crustytoothpaste.net \
--to=sandals@crustytoothpaste.net \
--cc=git@vger.kernel.org \
/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).