[PATCH] DocBook XML toolchain modernization

Christopher Faylor cgf-use-the-mailinglist-please@cygwin.com
Tue Apr 30 20:27:00 GMT 2013

On Tue, Apr 30, 2013 at 02:09:52PM -0600, Warren Young wrote:
>On 4/30/2013 13:07, Christopher Faylor wrote:
>> On Tue, Apr 30, 2013 at 12:58:49PM -0600, Warren Young wrote:
>>> Do you mean for me to check these changes in when I get my sourceware
>>> account?
>> Yes, with the implied assumption that you won't be breaking anything.
>Of course.
>Some questions from the original post:
>- When a change is checked in to the docs, does it immediately propagate 
>to the public web site, or is there a manual publication process?  I 
>mean, if the build is technically broken for a few seconds while I check 
>in a batch of changes, does it immediately break cygwin.com?  If so, 
>that would require that I check in only self-contained change sets even 
>if it means long CVS log messages.

No, it has to be published but you now have that ability.  The CVS path
is:  :ext:sourceware.org:/cvs/cygwin .

>- Am I right that we no longer need the second FAQ output format?

I think the single page form is the only thing required now.

>- http://cygwin.com/faq.html appears to be assembled from a site-wide 
>style/navigation file and winsup/doc/faq/faq.html.  Is that right, and 
>if so, do you mind if I add a target to the Makefile that gets you a 
>secondary variant of faq.html containing just the <body> tag's contents? 
>  Embedding <html> within <html> is eeevil.

faq.html is a pretty simple file and it seems to work.  Are there any
non-religious advantages to doing this?

>- Do you want me to do the proposed doctool to Doxygen conversion, so we 
>can get rid of doctool?

This was something that Corinna wanted so I can't comment but since she
asked you to be the maintainer, I'd say that whatever you want is
acceptable as long as we still have a readable FAQ.

>- If I get rid of doctool, do you agree that we no longer need Autoconf 
>for the docs?
>- Is someone using the @srcdir@ feature of the current doc build system 
>to build outside the source tree?

We always build everything in Cygwin outside of the source tree so I'd
rather keep autoconf around.  In theory you should be able to just type
"make doc" from wherever you're building cygwin and it should just work.

>- Any comments about the other items in my FUTURE WORK section? 
>Unconditional green light, or do you want to approve them one by one?

You have the right to change anything in the doc directory.  Anything
outside of that will require approval.


More information about the Cygwin-patches mailing list