diff options
| author | Bruno Haible <bruno@clisp.org> | 2020-06-27 02:11:08 +0200 |
|---|---|---|
| committer | Bruno Haible <bruno@clisp.org> | 2020-06-27 03:00:48 +0200 |
| commit | d4eef51732de47e1b76253deb65789fb0f0df414 (patch) | |
| tree | abc7ec8aa5534c69526fb28136afc6a4e2bcaac5 /lib | |
| parent | b7e52f508ecb769b69975976be5aaa3a9a0b1ca2 (diff) | |
| download | gnulib-d4eef51732de47e1b76253deb65789fb0f0df414.tar.gz | |
canonicalize: Improve documentation.
* lib/canonicalize.h (canonicalize_filename_mode): Document the failure
return convention.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/canonicalize.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/canonicalize.h b/lib/canonicalize.h index 950d117d5d..1815297dfb 100644 --- a/lib/canonicalize.h +++ b/lib/canonicalize.h @@ -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 |