Mailing-List: contact cygwin-help AT cygwin DOT com; run by ezmlm
List-Subscribe: <mailto:cygwin-subscribe AT cygwin DOT com>
List-Archive: <http://sourceware.org/ml/cygwin/>
List-Post: <mailto:cygwin AT cygwin DOT com>
List-Help: <mailto:cygwin-help AT cygwin DOT com>, <http://sourceware.org/ml/#faqs>
Sender: cygwin-owner AT cygwin DOT com
Mail-Followup-To: cygwin AT cygwin DOT com
Delivered-To: mailing list cygwin AT cygwin DOT com
Message-ID: <cb51e2e05091613515a40ce3@mail.gmail.com>
Date: Fri, 16 Sep 2005 13:51:02 -0700
From: Joshua Daniel Franklin <joshuadfranklin AT gmail DOT com>
Reply-To: joshuadfranklin AT gmail DOT com
To: cygwin AT cygwin DOT com
Subject: Re: Documentation on functions
In-Reply-To: <26617704.1126801364351.JavaMail.SYSTEM@CCC-NOVA1>
Mime-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1
Content-Disposition: inline
References: <091420051431 DOT 19746 DOT 432834510009D11000004D2222058864420A050E040D0C079D0A AT comcast DOT net> 	 <26617704 DOT 1126801364351 DOT JavaMail DOT SYSTEM AT CCC-NOVA1>
X-IsSubscribed: yes
Content-Transfer-Encoding: 8bit
X-MIME-Autoconverted: from quoted-printable to 8bit by delorie.com id j8GKpGmF017033

On 9/15/05, Siegfried Heintze wrote:
> In other words, is the process of submitting documentation documented? Does
> one use the GNU texi or SGML docbook or some other format? I've been curious
> about these tools for years but have never used them.

It depends on what you're documenting. As Eric noted, for libc functions you
submit a patch to the newlib mailing list and then it trickles into Cygwin via
my cygwin-doc package. For the Cygwin-specific functions, the documentation
is in the Cygwin CVS <http://cygwin.com/cvs.html> and is written in 
XML DocBook. Unfortunately there have been no updates to this documentation
in a long time, I would love to see more. (And, if you want to learn more about
DocBook, I recommend the in-progress Fedora Documentation Guide
<http://fedora.redhat.com/participate/documentation-guide/> --obviously
there are differences in Cygwin specifics but introduction to the tools and 
the parts about the tags and style are very helpful.)
 
> Is it a simple matter of cutting and pasting from linux (e.g. fedora) man
> pages or does one have to go to the source code and extract the copious
> comments there and just reformat them into man pages?

As others have noted, Cygwin usually tries for POSIX conformance so the
Linux man pages are usually good enough but might disagree at times. 
I suppose I should build some sort of placeholder man pages pointing to
the POSIX website. 

Anybody want to write a script to do it?

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/