[Spice-devel] [PATCH v2] doc: Generate chunked manual

[Marc-André Lureau]

On Tue, Apr 1, 2014 at 5:09 PM, Christophe Fergeau <cfergeau at redhat.com>wrote:

> This commit makes use of a2x in order to generate a chunked manual in
> addition to the "all in one page" one.
> ---
>
> Change since v1:
> - keep using 'asciidoc' to generate single page manual
>
>  configure.ac            |  7 ++++++-
>  docs/manual/Makefile.am | 14 +++++++++++++-
>  2 files changed, 19 insertions(+), 2 deletions(-)
>
> diff --git a/configure.ac b/configure.ac
> index 53d05a2..e4ba9b2 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -425,9 +425,14 @@ if test "x$enable_manual" != "xno"; then
>      AC_PATH_PROG([ASCIIDOC], [asciidoc])
>      AS_IF([test -z "$ASCIIDOC" && test "x$enable_manual" = "xyes"],
>            [AC_MSG_ERROR([asciidoc is missing and build of manual was
> requested])])
> +    AC_PATH_PROG([A2X], [a2x])
> +    AS_IF([test -z "$A2X" && test "x$enable_manual" = "xyes"],
> +          [AC_MSG_ERROR([a2x is missing and build of manual was
> requested])])
>  fi
>  AS_IF([test -n "$ASCIIDOC"], [have_asciidoc=yes], [have_asciidoc=no])
> -AM_CONDITIONAL([BUILD_MANUAL], [test -n "$ASCIIDOC"])
> +AM_CONDITIONAL([BUILD_MANUAL], [test -n "$ASCIIDOC" || test -n "$A2X"])
> +AM_CONDITIONAL([BUILD_HTML_MANUAL], [test -n "$ASCIIDOC"])
> +AM_CONDITIONAL([BUILD_CHUNKED_MANUAL], [test -n "$A2X"])
>
>
>  dnl
> ===========================================================================
> diff --git a/docs/manual/Makefile.am b/docs/manual/Makefile.am
> index f464e7a..c8471b3 100644
> --- a/docs/manual/Makefile.am
> +++ b/docs/manual/Makefile.am
> @@ -7,13 +7,25 @@ EXTRA_DIST =                                  \
>         images/icons/*.png                      \
>         images/spicec01.png                     \
>         manual.html                             \
> +       manual.chunked/*                        \
>         manual.txt                              \
>         $(NULL)
>
>  .txt.html:
>         $(AM_V_GEN) $(ASCIIDOC) $(ASCIIDOC_FLAGS) $<
>
> -all-local: manual.html
> +manual.chunked: manual.txt
> +       $(AM_V_GEN) $(A2X) -f chunked $(ASCIIDOC_FLAGS) $<
> +
>

You may want to make it a PHONY, and touch $@

other than that, ack


> +docfiles =
> +if BUILD_HTML_MANUAL
> +docfiles += manual.html
> +endif
> +if BUILD_CHUNKED_MANUAL
> +docfiles += manual.chunked
> +endif
> +
> +all-local: $(docfiles)
>
>  clean-local:
>         rm manual.html
> --
> 1.9.0
>
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/spice-devel
>



-- 
Marc-André Lureau
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/spice-devel/attachments/20140401/92f74cab/attachment.html>