From: Bruno Haible Date: Sat, 27 Jun 2020 00:44:38 +0000 (+0200) Subject: fchdir: Improve documentation. X-Git-Tag: v1.0~3965 X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=999b19465ad40e0aebbd126c63644acb9b2eddda;p=gnulib.git fchdir: Improve documentation. * lib/fchdir.c (get_name, _gl_register_fd): Document the failure return convention. --- diff --git a/ChangeLog b/ChangeLog index 932993a7fc..c047c411ca 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2020-06-26 Bruno Haible + + fchdir: Improve documentation. + * lib/fchdir.c (get_name, _gl_register_fd): Document the failure return + convention. + 2020-06-26 Bruno Haible filenamecat-lgpl: Set errno upon failure. 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) {