brian m. carlson
2014-10-11 23:37:32 UTC
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 (=C2=B1 1 character instead of 2) and requires
matching delimiter lengths[0]. They're needed regardless of whether th=
e
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 generatin=
g
manpage (refentry) output in DocBook format. The need for these patche=
s
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=3Dasciidoctor ASCIIDOC_DOCBOOK=3Ddocbook45 ASCIIDOC=
_HTML=3Dhtml5 ASCIIDOC_CONF=3D'-I. -rasciidoctor/extensions -rextension=
s'
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
--=20
2.1.1
using Asciidoctor instead of AsciiDoc.
The first two patches are bug fixes. Asciidoctor is stricter about
title underline lengths (=C2=B1 1 character instead of 2) and requires
matching delimiter lengths[0]. They're needed regardless of whether th=
e
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 generatin=
g
manpage (refentry) output in DocBook format. The need for these patche=
s
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=3Dasciidoctor ASCIIDOC_DOCBOOK=3Ddocbook45 ASCIIDOC=
_HTML=3Dhtml5 ASCIIDOC_CONF=3D'-I. -rasciidoctor/extensions -rextension=
s'
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
--=20
2.1.1