New upstream version 4.24upstream/4.24upstream

1 files changed, 8 insertions, 1 deletions

diff --git a/doc/files_and_dirs.rst b/doc/files_and_dirs.rst
index a18b5a4..a1d7090 100644
--- a/doc/files_and_dirs.rst
+++ b/doc/files_and_dirs.rst
@@ -57,9 +57,15 @@ Operation on directory entries
 
 	#include <libHX/io.h>
 
+	int HX_getcwd(hxmc_t **buf);
 	int HX_readlink(hxmc_t **buf, const char *path);
 	int HX_realpath(hxmc_t **buf, const char *path, unsigned int flags);
 
+``HX_getcwd`` is a length-agnostic version of getcwd. On error, a negative
+integer is returned indicating the errno; the contents of ``*buf`` are
+unspecified if that happens. On success, a non-zero positive integer is
+returned.
+
 ``HX_readlink`` calls through to readlink to read the target of a symbolic
 link, and stores the result in the memory container referenced by ``*buf``
 (similar to ``HX_getl`` semantics). If ``*buf`` is ``NULL``, a new container
@@ -91,7 +97,8 @@ actions:
 
 The result is stored in a memory container whose pointer is returned through
 ``*buf``. The return value of the function will be negative to indicate a
-possible system error, or be positive non-zero for success.
+possible system error, or be positive non-zero for success. The contents of the
+buffer are unspecified in case HX_realpath returns an error.
 
 
 Operations on directories