diff options
| author | David Sterba <dsterba@suse.com> | 2018-02-02 20:51:25 +0100 |
|---|---|---|
| committer | David Sterba <dsterba@suse.com> | 2018-02-02 21:02:13 +0100 |
| commit | 652544f4c01b8b1a2ab1705cec33af337ffae2ff (patch) | |
| tree | 1cf2285c536c52af817dd444ab34cc347386c429 /configure.ac | |
| parent | 4523dc2776783ecd2fb1e3c72997f23ac2c3b975 (diff) | |
btrfs-progs: build: add support for asciidoctor doc generator
We've been using asciidoc that's written in python2, which is going to
be phased out and deprecated next year. There's a replacement,
asciidoctor. Add a configure-time detection which tool is available,
update Documentation/Makefile.in.
The original asciidoc tool is still preferred as it produces slightly
better output. The file asciidoc.conf does not have a direct equivalten
in asciidoct and would need to be replaced by extension written in ruby.
The differences:
- the <literal> are not automatically underlined and are less visible in
the generated manual page, but it's still acceptable
- the inline CSS for the html output looks subjectively worse, is less
compact and colourful
Issue: #89
Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'configure.ac')
| -rw-r--r-- | configure.ac | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/configure.ac b/configure.ac index 3afcdb47..56d17c3a 100644 --- a/configure.ac +++ b/configure.ac @@ -39,6 +39,7 @@ AC_CHECK_TOOL([AR], [ar]) AC_PATH_PROG([RM], [rm], [rm]) AC_PATH_PROG([RMDIR], [rmdir], [rmdir]) + AC_CHECK_FUNCS([openat], [], [AC_MSG_ERROR([cannot find openat() function])]) @@ -88,13 +89,27 @@ AS_IF([test "x$enable_documentation" = xyes], [DISABLE_DOCUMENTATION=0], [DISABL AC_SUBST([DISABLE_DOCUMENTATION]) dnl detect tools to build documentation +ASCIIDOC_TOOL="none" if test "x$enable_documentation" = xyes; then - AC_PATH_PROG([ASCIIDOC], [asciidoc], [asciidoc]) AC_PATH_PROG([XMLTO], [xmlto], [xmlto]) AC_PATH_PROG([GZIP], [gzip], [gzip]) AC_PATH_PROG([MV], [mv], [mv]) AC_PROG_SED + AC_PATH_PROG([ASCIIDOC], [asciidoc]) + AC_PATH_PROG([ASCIIDOCTOR], [asciidoctor]) + + dnl asciidoc is preferred + if test -n "$ASCIIDOC"; then + ASCIIDOC_TOOL="asciidoc" + else + if test -n "$ASCIIDOCTOR"; then + ASCIIDOC_TOOL="asciidoctor" + else + AC_MSG_ERROR([cannot find asciidoc or asciidoctor, cannot build documentation]) + fi + fi fi +AC_SUBST([ASCIIDOC_TOOL]) AC_ARG_ENABLE([convert], AS_HELP_STRING([--disable-convert], [do not build btrfs-convert]), @@ -246,6 +261,7 @@ AC_MSG_RESULT([ ldflags: ${LDFLAGS} documentation: ${enable_documentation} + doc generator: ${ASCIIDOC_TOOL} backtrace support: ${enable_backtrace} btrfs-convert: ${enable_convert} ${convertfs:+($convertfs)} btrfs-restore zstd: ${enable_zstd} |