diff options
| author | Jon Turney <jon.turney@dronecode.org.uk> | 2021-12-07 17:05:34 +0300 |
|---|---|---|
| committer | Jon Turney <jon.turney@dronecode.org.uk> | 2021-12-18 01:28:16 +0300 |
| commit | f4a26ececa180cec70c41b6dd2082ff730f92065 (patch) | |
| tree | 65ae27ecbf2fa0c64637f01b345ee80fe23863a4 /winsup/doc | |
| parent | 80f4b7d5456ea17d64998805fb3d64db091201fc (diff) | |
Cygwin: Conditionally build documentation
Add a configure option '--disable-doc' to disable building of the
documentation by the 'all' target.
Check for the required tools at configure time, and require them if
building documentation is enabled.
Even if building the documentation was diabled with '--disable-doc',
'make -C doc' at the top-level can still make the documentation, if the
documentation tools were found. If the tools were not found, 'missing'
is used to issue a warning about that.
Update instructions for building Cygwin appropriately.
(Building documentation remains the default to increase the chances of
noticing when building the documentation is broken.)
Diffstat (limited to 'winsup/doc')
| -rw-r--r-- | winsup/doc/Makefile.am | 2 | ||||
| -rw-r--r-- | winsup/doc/faq-programming.xml | 14 |
2 files changed, 10 insertions, 6 deletions
diff --git a/winsup/doc/Makefile.am b/winsup/doc/Makefile.am index 534d67480..5164c6e0a 100644 --- a/winsup/doc/Makefile.am +++ b/winsup/doc/Makefile.am @@ -16,7 +16,7 @@ doc_DATA = \ htmldir = $(datarootdir)/doc -XMLTO=xmlto --skip-validation --with-dblatex +XMLTO=@XMLTO@ --skip-validation --with-dblatex DOCBOOK2XTEXI=@DOCBOOK2XTEXI@ --xinclude --info --utf8trans-map=charmap -include Makefile.dep diff --git a/winsup/doc/faq-programming.xml b/winsup/doc/faq-programming.xml index 26fcfe921..46dd23ab8 100644 --- a/winsup/doc/faq-programming.xml +++ b/winsup/doc/faq-programming.xml @@ -689,12 +689,16 @@ Building for 32-bit Cygwin also requires Building for 64-bit Cygwin also requires <literal>mingw64-x86_64-gcc-g++</literal> and <literal>mingw64-x86_64-zlib</literal>. +</para> + <!-- If you want to run the tests, <literal>dejagnu</literal> is also required. --> -Normally, building ignores any errors in building the documentation, -which requires the <literal>dblatex</literal>, <literal>docbook2X</literal>, -<literal>docbook-xml45</literal>, <literal>docbook-xsl</literal>, and -<literal>xmlto</literal> packages. For more information on building the -documentation, see the README included in the <literal>cygwin-doc</literal> package. + +<para> +Building the documentation also requires the <literal>dblatex</literal>, +<literal>docbook2X</literal>, <literal>docbook-xml45</literal>, +<literal>docbook-xsl</literal>, and <literal>xmlto</literal> packages. Building +the documentation can be disabled with the <literal>--disable-doc</literal> +option to <literal>configure</literal>. </para> <para>Next, check out the Cygwin sources from the |