public inbox for cygwin-patches@cygwin.com
 help / color / mirror / Atom feed
* RE: [PATCH] Cygwin: Conditionally build documentation
@ 2022-01-14 20:18 Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  2022-01-15  5:04 ` Brian Inglis
  2022-01-15 15:06 ` Jon Turney
  0 siblings, 2 replies; 8+ messages in thread
From: Lavrentiev, Anton (NIH/NLM/NCBI) [C] @ 2022-01-14 20:18 UTC (permalink / raw)
  To: Jon Turney, cygwin-patches

> 
> Add a configure option '--disable-doc' to disable building of the
> documentation by the 'all' target.
>

Can you please also add --disable-doc to "configure --help"?  It took me awhile to figure out which option I should use to skip the doc from building because it does no longer ignore doc build failure by default (unlike it used to do).  Also this fact is not reflected in the FAQ here:

https://cygwin.com/faq.html#faq.programming.building-cygwin

which still mentions the doc build errors ignored:

> Normally, building ignores any errors in building the documentation

Thanks!

Anton Lavrentiev
Contractor NIH/NLM/NCBI


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-14 20:18 [PATCH] Cygwin: Conditionally build documentation Lavrentiev, Anton (NIH/NLM/NCBI) [C]
@ 2022-01-15  5:04 ` Brian Inglis
  2022-01-15 15:06 ` Jon Turney
  1 sibling, 0 replies; 8+ messages in thread
From: Brian Inglis @ 2022-01-15  5:04 UTC (permalink / raw)
  To: cygwin-patches


On 2022-01-14 13:18, Lavrentiev, Anton (NIH/NLM/NCBI) [C] wrote:
>> Add a configure option '--disable-doc' to disable building of the
>> documentation by the 'all' target.

> Can you please also add --disable-doc to "configure --help"?  It took me awhile to figure out which option I should use to skip the doc from building because it does no longer ignore doc build failure by default (unlike it used to do).  Also this fact is not reflected in the FAQ here:
> 
> https://cygwin.com/faq.html#faq.programming.building-cygwin
> 
> which still mentions the doc build errors ignored:

>> Normally, building ignores any errors in building the documentation

Updated by Jon a month ago:

https://cygwin.com/git/?p=newlib-cygwin.git;a=commitdiff;h=f4a26ececa180cec70c41b6dd2082ff730f92065

winsup/configure.ac:
...
+AC_ARG_ENABLE(doc,
+             [AS_HELP_STRING([--enable-doc], [Build documentation])],,
+             enable_doc=yes)
+AM_CONDITIONAL(BUILD_DOC, [test $enable_doc != "no"])
...

winsup/faq-programming.xml:
...
+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>.
...

probably won't appear on the web site until the next release.

-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in binary units and prefixes, physical quantities in SI.]

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-14 20:18 [PATCH] Cygwin: Conditionally build documentation Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  2022-01-15  5:04 ` Brian Inglis
@ 2022-01-15 15:06 ` Jon Turney
  2022-01-15 19:06   ` [EXTERNAL] " Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  2022-01-17 19:39   ` Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  1 sibling, 2 replies; 8+ messages in thread
From: Jon Turney @ 2022-01-15 15:06 UTC (permalink / raw)
  To: Lavrentiev, Anton (NIH/NLM/NCBI) [C], cygwin-patches

On 14/01/2022 20:18, Lavrentiev, Anton (NIH/NLM/NCBI) [C] wrote:
>>
>> Add a configure option '--disable-doc' to disable building of the
>> documentation by the 'all' target.
>>
> 
> Can you please also add --disable-doc to "configure --help"?  It took
> me awhile to figure out which option I should use to skip the doc
> from building because it does no longer ignore doc build failure by
> default (unlike it used to do).

It is reported by 'configure --help', at the appropriate level (although 
since enable is the default, I probably should have written 
'--disable-doc' here).

 > jon@tambora /work/cygwin/src/winsup master
 > $ ./configure --help
[...]
 >   --enable-doc            Build documentation
[...]

^ permalink raw reply	[flat|nested] 8+ messages in thread

* RE: [EXTERNAL] Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-15 15:06 ` Jon Turney
@ 2022-01-15 19:06   ` Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  2022-01-15 23:00     ` Brian Inglis
  2022-01-17 19:39   ` Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  1 sibling, 1 reply; 8+ messages in thread
From: Lavrentiev, Anton (NIH/NLM/NCBI) [C] @ 2022-01-15 19:06 UTC (permalink / raw)
  To: Jon Turney, cygwin-patches

> It is reported by 'configure --help', at the appropriate level (although
> since enable is the default, I probably should have written
> '--disable-doc' here).

I'm sorry if I'm missing anything, but I updated y'day and this is what I see regarding the doc in configure:

$ ./configure --help | grep doc
  --infodir=DIR           info documentation [DATAROOTDIR/info]
  --mandir=DIR            man documentation [DATAROOTDIR/man]
  --docdir=DIR            documentation root [DATAROOTDIR/doc/PACKAGE]
  --htmldir=DIR           html documentation [DOCDIR]
  --dvidir=DIR            dvi documentation [DOCDIR]
  --pdfdir=DIR            pdf documentation [DOCDIR]
  --psdir=DIR             ps documentation [DOCDIR]


Anton Lavrentiev
Contractor NIH/NLM/NCBI


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [EXTERNAL] Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-15 19:06   ` [EXTERNAL] " Lavrentiev, Anton (NIH/NLM/NCBI) [C]
@ 2022-01-15 23:00     ` Brian Inglis
  2022-01-18 20:01       ` Jon Turney
  0 siblings, 1 reply; 8+ messages in thread
From: Brian Inglis @ 2022-01-15 23:00 UTC (permalink / raw)
  To: cygwin-patches

On 2022-01-15 12:06, Lavrentiev, Anton (NIH/NLM/NCBI) [C] via 
Cygwin-patches wrote:
>> It is reported by 'configure --help', at the appropriate level (although
>> since enable is the default, I probably should have written
>> '--disable-doc' here).
> 
> I'm sorry if I'm missing anything, but I updated y'day and this is what I see regarding the doc in configure:
> 
> $ ./configure --help | grep doc
>    --infodir=DIR           info documentation [DATAROOTDIR/info]
>    --mandir=DIR            man documentation [DATAROOTDIR/man]
>    --docdir=DIR            documentation root [DATAROOTDIR/doc/PACKAGE]
>    --htmldir=DIR           html documentation [DOCDIR]
>    --dvidir=DIR            dvi documentation [DOCDIR]
>    --pdfdir=DIR            pdf documentation [DOCDIR]
>    --psdir=DIR             ps documentation [DOCDIR]

It looks like it's not propagated to newlib-cygwin/configure, and 
newlib-cygwin/configure --help=recursive seems to loop recursing on 
newlib 4.2.0, so it's only shown by winsup/configure:

$ ../winsup/configure --help=short
Configuration of Cygwin 0:

Optional Features:
   --disable-option-checking  ignore unrecognized --enable/--with options
   --disable-FEATURE       do not include FEATURE (same as 
--enable-FEATURE=no)
   --enable-FEATURE[=ARG]  include FEATURE [ARG=yes]
   --enable-silent-rules   less verbose build output (undo: "make V=1")
   --disable-silent-rules  verbose build output (undo: "make V=0")
   --enable-dependency-tracking
                           do not reject slow dependency extractors
   --disable-dependency-tracking
                           speeds up one-time build
   --enable-debugging      Build a cygwin DLL which has more consistency
                           checking for debugging
   --enable-doc            Build documentation

Optional Packages:
   --with-PACKAGE[=ARG]    use PACKAGE [ARG=yes]
   --without-PACKAGE       do not use PACKAGE (same as --with-PACKAGE=no)
   --with-cross-bootstrap  do not build programs using the MinGW 
toolchain or
                           check for MinGW libraries (useful for 
bootstrapping
                           a cross-compiler)

Some influential environment variables:
   CC          C compiler command
   CFLAGS      C compiler flags
   LDFLAGS     linker flags, e.g. -L<lib dir> if you have libraries in a
               nonstandard directory <lib dir>
   LIBS        libraries to pass to the linker, e.g. -l<library>
   CPPFLAGS    (Objective) C/C++ preprocessor flags, e.g. -I<include dir> if
               you have headers in a nonstandard directory <include dir>
   CXX         C++ compiler command
   CXXFLAGS    C++ compiler flags
   CPP         C preprocessor
   CCAS        assembler compiler command (defaults to CC)
   CCASFLAGS   assembler compiler flags (defaults to CFLAGS)

Use these variables to override the choices made by `configure' or to help
it to find libraries and programs with nonstandard names/locations.

Report bugs to <cygwin@cygwin.com>.
Cygwin home page: <https://cygwin.com>.

-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in binary units and prefixes, physical quantities in SI.]

^ permalink raw reply	[flat|nested] 8+ messages in thread

* RE: [EXTERNAL] Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-15 15:06 ` Jon Turney
  2022-01-15 19:06   ` [EXTERNAL] " Lavrentiev, Anton (NIH/NLM/NCBI) [C]
@ 2022-01-17 19:39   ` Lavrentiev, Anton (NIH/NLM/NCBI) [C]
  2022-01-18 19:57     ` Jon Turney
  1 sibling, 1 reply; 8+ messages in thread
From: Lavrentiev, Anton (NIH/NLM/NCBI) [C] @ 2022-01-17 19:39 UTC (permalink / raw)
  To: Jon Turney, cygwin-patches

> It is reported by 'configure --help', at the appropriate level (although
> since enable is the default, I probably should have written
> '--disable-doc' here).

Can you please make it show as --disable-doc ?

Also, can you please make it visible in the top-level configure?

Thanks,

Anton Lavrentiev
Contractor NIH/NLM/NCBI


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [EXTERNAL] Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-17 19:39   ` Lavrentiev, Anton (NIH/NLM/NCBI) [C]
@ 2022-01-18 19:57     ` Jon Turney
  0 siblings, 0 replies; 8+ messages in thread
From: Jon Turney @ 2022-01-18 19:57 UTC (permalink / raw)
  To: Lavrentiev, Anton (NIH/NLM/NCBI) [C], Cygwin Patches

On 17/01/2022 19:39, Lavrentiev, Anton (NIH/NLM/NCBI) [C] wrote:
>> It is reported by 'configure --help', at the appropriate level (although
>> since enable is the default, I probably should have written
>> '--disable-doc' here).
> 
> Can you please make it show as --disable-doc ?

It would almost be less typing for you to submit the change yourself :)

> Also, can you please make it visible in the top-level configure?

No.

None of the other configure flags supported by cygwin or newlib appear 
there.

The top-level files are owned by and maintained in the gcc repository.

Google "cygnus tree" or "cygnus uberbaum" for the history of this oddity.

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [EXTERNAL] Re: [PATCH] Cygwin: Conditionally build documentation
  2022-01-15 23:00     ` Brian Inglis
@ 2022-01-18 20:01       ` Jon Turney
  0 siblings, 0 replies; 8+ messages in thread
From: Jon Turney @ 2022-01-18 20:01 UTC (permalink / raw)
  To: Cygwin Patches

On 15/01/2022 23:00, Brian Inglis wrote:
> On 2022-01-15 12:06, Lavrentiev, Anton (NIH/NLM/NCBI) [C] via 
> Cygwin-patches wrote:
>>> It is reported by 'configure --help', at the appropriate level (although
>>> since enable is the default, I probably should have written
>>> '--disable-doc' here).
>>
[...]
> 
> It looks like it's not propagated to newlib-cygwin/configure, and 
> newlib-cygwin/configure --help=recursive seems to loop recursing on 
> newlib 4.2.0, so it's only shown by winsup/configure:

In my testing, it seems that a top-level './configure --help=recursive' 
terminates eventually, it's just that there are also configures in 
subdirectories of newlib (for no good reason I know of), which makes it 
spend a long time repeating mostly useless output...

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2022-01-18 20:01 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-14 20:18 [PATCH] Cygwin: Conditionally build documentation Lavrentiev, Anton (NIH/NLM/NCBI) [C]
2022-01-15  5:04 ` Brian Inglis
2022-01-15 15:06 ` Jon Turney
2022-01-15 19:06   ` [EXTERNAL] " Lavrentiev, Anton (NIH/NLM/NCBI) [C]
2022-01-15 23:00     ` Brian Inglis
2022-01-18 20:01       ` Jon Turney
2022-01-17 19:39   ` Lavrentiev, Anton (NIH/NLM/NCBI) [C]
2022-01-18 19:57     ` Jon Turney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).