xgetcwd: Improve documentation.

* lib/xgetcwd.c (xgetcwd): Document the failure return convention.

diff --git a/ChangeLog b/ChangeLog
index 49422d39b2cf443f2c872f23740357fc774fd6a5..7016db36da20807b30c4843d138a4a94ad362234 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2020-06-26  Bruno Haible  <bruno@clisp.org>
+
+       xgetcwd: Improve documentation.
+       * lib/xgetcwd.c (xgetcwd): Document the failure return convention.
+
 2020-06-26  Bruno Haible  <bruno@clisp.org>
 
        getcwd: Improve documentation.

diff --git a/lib/xgetcwd.c b/lib/xgetcwd.c
index 62b8c8c0a8d13a53d9567b5f8cd6e99c0fb94fb4..8fb934298e294f8d1d505bee994e9c22df11883a 100644 (file)
--- a/lib/xgetcwd.c
+++ b/lib/xgetcwd.c
@@ -29,7 +29,7 @@
 
 /* Return the current directory, newly allocated.
    Upon an out-of-memory error, call xalloc_die.
-   Upon any other type of error, return NULL.  */
+   Upon any other type of error, return NULL with errno set.  */
 
 char *
 xgetcwd (void)