]> Savannah Git Hosting - gnulib.git/commitdiff
getcwd: Improve documentation.
authorBruno Haible <bruno@clisp.org>
Sat, 27 Jun 2020 00:59:07 +0000 (02:59 +0200)
committerBruno Haible <bruno@clisp.org>
Sat, 27 Jun 2020 01:00:46 +0000 (03:00 +0200)
* lib/getcwd.c (__getcwd): Document the failure return convention.

ChangeLog
lib/getcwd.c

index c047c411ca1b6d45f59bb1aa12c55383257e0c44..49422d39b2cf443f2c872f23740357fc774fd6a5 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2020-06-26  Bruno Haible  <bruno@clisp.org>
+
+       getcwd: Improve documentation.
+       * lib/getcwd.c (__getcwd): Document the failure return convention.
+
 2020-06-26  Bruno Haible  <bruno@clisp.org>
 
        fchdir: Improve documentation.
index 45470fcbe92549ada26663baa99c73884b4652fe..1a42ef1bfa3300aec0b38afbf4392d8064c4593e 100644 (file)
@@ -133,10 +133,10 @@ getcwd_nothrow (char *buf, size_t size)
 #endif
 
 /* Get the name of the current working directory, and put it in SIZE
-   bytes of BUF.  Returns NULL if the directory couldn't be determined or
-   SIZE was too small.  If successful, returns BUF.  In GNU, if BUF is
-   NULL, an array is allocated with 'malloc'; the array is SIZE bytes long,
-   unless SIZE == 0, in which case it is as big as necessary.  */
+   bytes of BUF.  Returns NULL with errno set if the directory couldn't be
+   determined or SIZE was too small.  If successful, returns BUF.  In GNU,
+   if BUF is NULL, an array is allocated with 'malloc'; the array is SIZE
+   bytes long, unless SIZE == 0, in which case it is as big as necessary.  */
 
 char *
 __getcwd (char *buf, size_t size)