summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2017-01-22 02:41:56 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-01-23 18:56:57 (GMT)
commitec3366eb52caad29e4cfb0a0afb605c450ad5a39 (patch)
tree6cfc90983c15d6a512f2361040e2fadaacc97aec /Makefile
parentae4e3e8d449a8e1fbe8d5a3fe5e69f1154f97f3f (diff)
downloadgit-ec3366eb52caad29e4cfb0a0afb605c450ad5a39.zip
git-ec3366eb52caad29e4cfb0a0afb605c450ad5a39.tar.gz
git-ec3366eb52caad29e4cfb0a0afb605c450ad5a39.tar.bz2
Makefile: add a knob to enable the use of Asciidoctor
While Git has traditionally built its documentation using AsciiDoc, some people wish to use Asciidoctor for speed or other reasons. Add a Makefile knob, USE_ASCIIDOCTOR, that sets various options in order to produce acceptable output. For HTML output, XHTML5 was chosen, since the AsciiDoc options also produce XHTML, albeit XHTML 1.1. Asciidoctor does not have built-in support for the linkgit macro, but it is available using the Asciidoctor Extensions Lab. Add a macro to enable the use of this extension if it is available. Without it, the linkgit macros are emitted into the output. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile6
1 files changed, 6 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index f53fcc9..24e35dd 100644
--- a/Makefile
+++ b/Makefile
@@ -250,6 +250,12 @@ all::
# apostrophes to be ASCII so that cut&pasting examples to the shell
# will work.
#
+# Define USE_ASCIIDOCTOR to use Asciidoctor instead of AsciiDoc to build the
+# documentation.
+#
+# Define ASCIIDOCTOR_EXTENSIONS_LAB to point to the location of the Asciidoctor
+# Extensions Lab if you have it available.
+#
# Define PERL_PATH to the path of your Perl binary (usually /usr/bin/perl).
#
# Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's