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

[Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>]

Matt Wilson writes ("[Xen-devel] [PATCH 1 of 3] tools: check for documentation 
generation tools at configure time"):
> It is sometimes hard to discover all the optional documentation
> generation 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.

The way you've done this seems a bit odd to me:

> diff -r d7e4efa17fb0 -r 674b694814c8 config/Tools.mk.in
> --- a/config/Tools.mk.in      Tue Aug 28 15:35:08 2012 -0700
> +++ b/config/Tools.mk.in      Wed Aug 29 11:07:52 2012 -0700
> @@ -22,6 +22,17 @@
>  LD86                := @LD86@
>  BCC                 := @BCC@
>  IASL                := @IASL@
> +PS2PDF              := @PS2PDF@
> +DVIPS               := @DVIPS@

But this leaves settings of PS2PDF := ps2pdf in docs/Docs.mk AFAICT.
Surely this should be all plumbed through to the same places ?
Or is this part of the fallback mechanism ?  It's not clear.

You do say this:

> diff -r d7e4efa17fb0 -r 674b694814c8 docs/Makefile
> --- a/docs/Makefile   Tue Aug 28 15:35:08 2012 -0700
> +++ b/docs/Makefile   Wed Aug 29 11:07:52 2012 -0700
> @@ -3,6 +3,11 @@
>  XEN_ROOT=$(CURDIR)/..
>  include $(XEN_ROOT)/Config.mk
>  include $(XEN_ROOT)/docs/Docs.mk
> +# The default documentation tools specified in Docs.mk can be
> +# persistently overridden by the user via ./configure, but running
> +# ./configure is not required to build the docs tree. Thus Tools.mk is
> +# optionally included.
> +-include $(XEN_ROOT)/config/Tools.mk

But I think setting the same thing in two places like this does need
to be documented more clearly.  In particular if I'm right about the
purpose of the two settings, each set needs a comment pointing at the
other so that (a) they can be both changed at once when either is
changed (b) people don't get confused when the setting they're
changing has no effect.

Ian.

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