summaryrefslogtreecommitdiffstats
path: root/include/zix/path.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/zix/path.h')
-rw-r--r--include/zix/path.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/zix/path.h b/include/zix/path.h
index 5d3bd60..7a52d31 100644
--- a/include/zix/path.h
+++ b/include/zix/path.h
@@ -67,7 +67,8 @@ zix_path_preferred(ZixAllocator* ZIX_NULLABLE allocator,
replaced with a single "\" on Windows, and a single "/" everwhere else).
Note that this function doesn't access the filesystem, so won't do anything
- like case normalization or symbolic link dereferencing.
+ like case normalization or symbolic link dereferencing. For that, use
+ zix_canonical_path().
*/
ZIX_API
char* ZIX_ALLOCATED