[PATCH 2/5] winsup/doc: Add intro man pages from cygwin-doc
Corinna Vinschen
corinna-cygwin@cygwin.com
Mon Jun 22 15:14:00 GMT 2015
A few nits:
[intro.1]
> + <para><emphasis>Cygwin</emphasis> is a Linux-like environment for
> + Windows. It consists of two parts:</para>
> + <para>A DLL (<filename>cygwin1.dll</filename>) which acts as a Linux API
s#Linux#POSIX#
> + emulation layer providing substantial Linux API functionality. The
s#Linux API functionality#POSIX API functionality modeled after the GNU/Linux operating system#
> + <citerefentry><refentrytitle>intro</refentrytitle><manvolnum>3</manvolnum></citerefentry>
> + man page gives an introduction to this API.</para>
> + <para>A collection of tools which provide Linux look and feel. This man
> + page describes the user environment.</para>
> + </refsect1>
> + <refsect1>
> + <title>AVAILABILITY</title>
> + <para><emphasis>Cygwin</emphasis> is developed by volunteers collaborating
> + over the Internet. It is distributed through the website <ulink
> + url="http://cygwin.com">http://cygwin.com</ulink>, where you can find
> + extensive documentation, including FAQ, User's Guide, and API
> + Reference. The <emphasis>Cygwin</emphasis> website should be considered
> + the authoritative source of information. The source code, released under
> + the <emphasis>GNU General Public License, Version 2</emphasis>, is also
s#Version 2#Version 3 (GPLv3+)#
[intro.3]
> + <para><emphasis>Cygwin</emphasis> is a Linux-like environment for
> + Windows. It consists of two parts:</para>
> + <para>A DLL (<filename>cygwin1.dll</filename>) which acts as a Linux API
s#Linux#POSIX#
> + emulation layer providing substantial Linux API functionality. This page
s#Linux API functionality#POSIX API functionality modeled after the
GNU/Linux operating system#
> + describes the API provided by the DLL.
> + </para>
> + <para>A collection of tools which provide Linux look and feel. This
> + environment is described in the
> + <citerefentry><refentrytitle>intro</refentrytitle><manvolnum>1</manvolnum></citerefentry>
> + man page.</para>
> + </refsect1>
> + <refsect1>
> + <title>AVAILABILITY</title>
> + <para><emphasis>Cygwin</emphasis> is developed by volunteers collaborating
> + over the Internet. It is distributed through the website <ulink
> + url="http://cygwin.com">http://cygwin.com</ulink>. The website has
> + extensive documentation, including FAQ, User's Guide, and API
> + Reference. It should be considered the authoritative source of
> + information. The source code, released under the <emphasis>GNU General
> + Public License, Version 2</emphasis>, is also available from the website
s#Version 2#Version 3 (GPLv3+)#
> + or one of the mirrors.</para>
> + </refsect1>
> + <refsect1>
> + <title>COMPATIBILITY</title>
> + <para><emphasis>Cygwin</emphasis> policy is to attempt to adhere to
> + <emphasis>POSIX/SUSv2</emphasis> (Portable Operating System Interface for
s#POSIX/SUSv2#POSIX.1-2008/SUSv4#
> + UNIX / The Single UNIX Specification, Version 2) where possible.</para>
s#Version 2#Version 4#
> + <para><emphasis>SUSv2</emphasis> is available online at:</para>
s#SUSv2#POSIX.1-2008/SUSv4#
> + <para>
> + <ulink url="http://www.opengroup.org/onlinepubs/007908799/">http://www.opengroup.org/onlinepubs/007908799/</ulink>
http://pubs.opengroup.org/onlinepubs/9699919799/
> + <para>Keep in mind that there are many underlying differences between UNIX
> + and Win32 (for example, a case-insensitive file system), making complete
> + compatibility an ongoing challenge.</para>
Is "case-insensitive file system" a good example? For one thing, NTFS
is a case-sensitive filesystem, and only the Win32 API and the default
NT kernel setting in the registry enforces case-insensitivity. See
https://cygwin.com/cygwin-ug-net/using-specialnames.html#pathnames-casesensitive
What about the OS consequently using UTF-16 as an example?
> + </refsect1>
> + <refsect1>
> + <title>REPORTING BUGS</title>
> + <para>If you find a bug in <emphasis>Cygwin</emphasis>, please read</para>
> + <para>
> + <ulink url="http://cygwin.com/bugs.html">http://cygwin.com/bugs.html</ulink>
> + </para>
> + <para>and follow the instructions for reporting found there. If you are
> + able to track down the source of the bug and can provide a fix, there are
> + instructions for contributing patches at:</para>
> + <para>
> + <ulink url="http://cygwin.com/contrib.html">http://cygwin.com/contrib.html</ulink>
> + </para>
> + </refsect1>
> + <refsect1>
> + <title>SEE ALSO</title>
> + <para>
> + <citerefentry>
> + <refentrytitle>intro</refentrytitle>
> + <manvolnum>1</manvolnum>
Shouldn't that be a 3 here?
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://cygwin.com/pipermail/cygwin-patches/attachments/20150622/934c7b14/attachment.sig>
More information about the Cygwin-patches
mailing list