* path.sgml (func-cygwin-conv-path): Clarify meaning of size parameter.

	(func-cygwin-conv-path-list): Fix typo.
	(func-cygwin-posix-path-list-p): Ditto.

diff --git a/winsup/cygwin/ChangeLog b/winsup/cygwin/ChangeLog
index 043fda876295181788f3396fb0febdb9c148c015..8445b7dbdf0a158907a34dfd56ad6a4072cd9fec 100644 (file)
--- a/winsup/cygwin/ChangeLog
+++ b/winsup/cygwin/ChangeLog
@@ -1,3 +1,9 @@
+2009-12-18  Corinna Vinschen  <corinna@vinschen.de>
+
+       * path.sgml (func-cygwin-conv-path): Clarify meaning of size parameter.
+       (func-cygwin-conv-path-list): Fix typo.
+       (func-cygwin-posix-path-list-p): Ditto.
+
 2009-12-17  Corinna Vinschen  <corinna@vinschen.de>
 
        * syscalls.cc (try_to_bin): Handle remote shares as well.  Just rename

diff --git a/winsup/cygwin/path.sgml b/winsup/cygwin/path.sgml
index 249f48de7810d52be4c76c5a75c77bfc2ac375be..26c3ea34ebf6ae183cf975270c39dd8d9456d5ea 100644 (file)
--- a/winsup/cygwin/path.sgml
+++ b/winsup/cygwin/path.sgml
@@ -35,10 +35,11 @@ default.</para>
   CCP_RELATIVE = 0x100    /* Request to keep path relative.               */
 </programlisting>
 
-<para>If <parameter>size</parameter> is 0,
-<function>cygwin_conv_path</function> just returns the required buffer
-size in bytes.  Otherwise, it returns 0 on success, or -1 on error and
-errno is set to one of the below values.</para>
+<para><parameter>size</parameter> is the size of the buffer pointed to
+by <parameter>to</parameter> in bytes.  If <parameter>size</parameter>
+is 0, <function>cygwin_conv_path</function> just returns the required
+buffer size in bytes.  Otherwise, it returns 0 on success, or -1 on
+error and errno is set to one of the below values.</para>
 
 <programlisting>
     EINVAL        what has an invalid value.
@@ -80,7 +81,7 @@ else
 
 <funcsynopsis><funcprototype>
 <funcdef>extern "C" ssize_t
-<function>cygwin_conv_path</function></funcdef>
+<function>cygwin_conv_path_list</function></funcdef>
 <paramdef>cygwin_conv_path_t <parameter>what</parameter></paramdef>
 <paramdef>const void * <parameter>from</parameter></paramdef>
 <paramdef>void * <parameter>to</parameter></paramdef>
@@ -95,6 +96,8 @@ convert it to the equivalent Win32 %PATH%-style string (i.e. d:\;e:\bar).</para>
 <para>If <parameter>what</parameter> is CCP_WIN_A_TO_POSIX or
 CCP_WIN_W_TO_POSIX, given a Win32 %PATH%-style string (i.e. d:\;e:\bar)
 convert it to the equivalent POSIX $PATH-style string (i.e. /foo:/bar).</para>
+<para><parameter>size</parameter> is the size of the buffer pointed to by
+<parameter>to</parameter> in bytes.</para>
 
 <para>See also <link linkend="func-cygwin-conv-path">cygwin_conv_path</link></para>
 
@@ -134,7 +137,7 @@ errno can be set to the below value.</para>
 
 <funcsynopsis><funcprototype>
 <funcdef>extern "C" int
-<function>posix_path_list_p</function></funcdef>
+<function>cygwin_posix_path_list_p</function></funcdef>
 <paramdef>const char *<parameter>path</parameter></paramdef>
 </funcprototype></funcsynopsis>