Re: [Xen-devel] [PATCH 1 of 2 v2] tools: check for documentation generation tools at configure time

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Thu, 2012-08-30 at 19:59 +0100, Matt Wilson wrote:
> It is sometimes hard to discover all the optional tools that should be
> on a system to build all available Xen documentation. By checking for
> documentation generation tools at ./configure time and displaying a
> warning, Xen packagers will more easily learn about new optional build
> dependencies, like markdown, when they are introduced.
> 
> Changes since v1:
>  * require that ./configure be run before building docs
>  * remove Docs.mk and make Tools.mk the canonical locaiton where
>    docs tools are defined (via ./configure)
>  * fold in checking for markdown_py
> 
> Signed-off-by: Matt Wilson <msw@xxxxxxxxxx>
> 
> diff -r d7e4efa17fb0 -r 512b4e0c49f3 README
> --- a/README  Tue Aug 28 15:35:08 2012 -0700
> +++ b/README  Thu Aug 30 10:51:00 2012 -0700
> @@ -28,8 +28,9 @@
>  your system. For full documentation, see the Xen User Manual. If this
>  is a pre-built release then you can find the manual at:
>   dist/install/usr/share/doc/xen/pdf/user.pdf
> -If you have a source release, then 'make -C docs' will build the
> -manual at docs/pdf/user.pdf.
> +If you have a source release and the required documentation generation
> +tools, then './configure; make -C docs' will build the manual at
> +docs/pdf/user.pdf.

This document was removed in 24563:4271634e4c86, looks like we missed
this reference. Could you nuke it as you go please?

> diff -r d7e4efa17fb0 -r 512b4e0c49f3 tools/m4/docs_tool.m4
> --- /dev/null Thu Jan 01 00:00:00 1970 +0000
> +++ b/tools/m4/docs_tool.m4   Thu Aug 30 10:51:00 2012 -0700
> @@ -0,0 +1,17 @@
> +AC_DEFUN([AX_DOCS_TOOL_PROG], [
> +dnl
> +    AC_ARG_VAR([$1], [Path to $2 tool])
> +    AC_PATH_PROG([$1], [$2])
> +    AS_IF([! test -x "$ac_cv_path_$1"], [
> +        AC_MSG_WARN([$2 is not available so some documentation won't be 
> built])
> +    ])
> +])
> +
> +AC_DEFUN([AX_DOCS_TOOL_PROGS], [
> +dnl
> +    AC_ARG_VAR([$1], [Path to $2 tool])

Does this do something sensible when $2 is a space separated list?

Do we need both PROG and PROGS variants? PROG is just a special case of
PROGS, isn't it? Although seeing that AC apparently has both variants I
guess there's a reason for that.

> +    AC_PATH_PROGS([$1], [$2])
> +    AS_IF([! test -x "$ac_cv_path_$1"], [
> +        AC_MSG_WARN([$2 is not available so some documentation won't be 
> built])
> +    ])
> +])



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel