fchdir: Improve documentation.

* lib/fchdir.c (get_name, _gl_register_fd): Document the failure return
convention.

2 files changed, 10 insertions, 3 deletions

diff --git a/ChangeLog b/ChangeLog
index 932993a7fc..c047c411ca 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2020-06-26  Bruno Haible  <bruno@clisp.org>
 
+	fchdir: Improve documentation.
+	* lib/fchdir.c (get_name, _gl_register_fd): Document the failure return
+	convention.
+
+2020-06-26  Bruno Haible  <bruno@clisp.org>
+
 	filenamecat-lgpl: Set errno upon failure.
 	* lib/filenamecat-lgpl.c (mfile_name_concat): Document the failure
 	return convention.
diff --git a/lib/fchdir.c b/lib/fchdir.c
index 20ecd3c17b..1fa9a7edc6 100644
--- a/lib/fchdir.c
+++ b/lib/fchdir.c
@@ -84,7 +84,8 @@ ensure_dirs_slot (size_t fd)
   return true;
 }
 
-/* Return an absolute name of DIR in malloc'd storage.  */
+/* Return an absolute name of DIR in malloc'd storage.
+   Upon failure, return NULL with errno set.  */
 static char *
 get_name (char const *dir)
 {
@@ -125,8 +126,8 @@ _gl_unregister_fd (int fd)
 /* Mark FD as visiting FILENAME.  FD must be non-negative, and refer
    to an open file descriptor.  If REPLACE_OPEN_DIRECTORY is non-zero,
    this should only be called if FD is visiting a directory.  Close FD
-   and return -1 if there is insufficient memory to track the
-   directory name; otherwise return FD.  */
+   and return -1 with errno set if there is insufficient memory to track
+   the directory name; otherwise return FD.  */
 int
 _gl_register_fd (int fd, const char *filename)
 {