From: Bruno Haible <bruno@clisp.org>
Date: Sat, 27 Jun 2020 01:00:01 +0000 (+0200)
Subject: xgetcwd: Improve documentation.
X-Git-Tag: v1.0~3963
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b7e52f508ecb769b69975976be5aaa3a9a0b1ca2;p=thirdparty%2Fgnulib.git

xgetcwd: Improve documentation.

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

diff --git a/ChangeLog b/ChangeLog
index 49422d39b2..7016db36da 100644
--- 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 62b8c8c0a8..8fb934298e 100644
--- 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)