diff options
| author | Corinna Vinschen <corinna@vinschen.de> | 2009-12-18 13:11:56 +0300 |
|---|---|---|
| committer | Corinna Vinschen <corinna@vinschen.de> | 2009-12-18 13:11:56 +0300 |
| commit | ae8547442be050ac348b805b4cb72ee239670c2f (patch) | |
| tree | 7eaf7483a92a57ddf49c7bf88e1de5b0a69b3c54 /winsup/cygwin | |
| parent | e8ba3932737eba42a49b253c4bd03e1883ef45a6 (diff) | |
* 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.
Diffstat (limited to 'winsup/cygwin')
| -rw-r--r-- | winsup/cygwin/ChangeLog | 6 | ||||
| -rw-r--r-- | winsup/cygwin/path.sgml | 15 |
2 files changed, 15 insertions, 6 deletions
diff --git a/winsup/cygwin/ChangeLog b/winsup/cygwin/ChangeLog index 043fda876..8445b7dbd 100644 --- 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 249f48de7..26c3ea34e 100644 --- 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> |