canonicalize: Improve documentation.
authorBruno Haible <bruno@clisp.org>
Sat, 27 Jun 2020 00:11:08 +0000 (02:11 +0200)
committerBruno Haible <bruno@clisp.org>
Sat, 27 Jun 2020 01:00:48 +0000 (03:00 +0200)
* lib/canonicalize.h (canonicalize_filename_mode): Document the failure
return convention.

ChangeLog
lib/canonicalize.h

index 7016db36da20807b30c4843d138a4a94ad362234..945941e45c4ea43090096bc6d4add2a3d7c9576c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2020-06-26  Bruno Haible  <bruno@clisp.org>
+
+       canonicalize: Improve documentation.
+       * lib/canonicalize.h (canonicalize_filename_mode): Document the failure
+       return convention.
+
 2020-06-26  Bruno Haible  <bruno@clisp.org>
 
        xgetcwd: Improve documentation.
index 950d117d5dd50a4c9874b63aac140c7affc37638..1815297dfb0b20497c3bf8cdf6355da824f5e3d8 100644 (file)
@@ -46,7 +46,8 @@ typedef enum canonicalize_mode_t canonicalize_mode_t;
    does not contain any `.', `..' components nor any repeated file name
    separators ('/') or, depending on other CAN_MODE flags, symlinks.
    Whether components must exist or not depends on canonicalize mode.
-   The result is malloc'd.  */
+   The result is malloc'd.
+   Upon failure, return NULL with errno set.  */
 char *canonicalize_filename_mode (const char *, canonicalize_mode_t);
 
 #ifdef __cplusplus