commit fcc4664872b0c39fdd0ca4dba367c5a63ba50e46
parent 0bd298e6711bf335963c25b3acfffe786dda5595
Author: Sebastian <sebastian@sebsite.pw>
Date: Sun, 1 May 2022 23:28:27 -0400
os, fs: fix resolve doc comment
Signed-off-by: Sebastian <sebastian@sebsite.pw>
Diffstat:
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/fs/fs.ha b/fs/fs.ha
@@ -260,7 +260,8 @@ export fn chown(fs: *fs, path: str, uid: uint, gid: uint) (void | error) = {
// Resolves a path to its absolute, normalized value. Relative paths will be
// rooted (if supported by the fs implementation), and "." and ".." components
// will be reduced. This function does not follow symlinks; see [[realpath]] if
-// you need this behavior. The caller must free the return value.
+// you need this behavior. The return value is statically allocated; use
+// [[strings::dup]] to extend its lifetime.
export fn resolve(fs: *fs, path: str) str = {
match (fs.resolve) {
case null => void;
diff --git a/os/fs.ha b/os/fs.ha
@@ -58,7 +58,8 @@ export fn chown(path: str, uid: uint, gid: uint) (void | fs::error) = fs::chown(
// Resolves a path to its absolute, normalized value. Relative paths will be
// rooted (if supported by the host filesystem), and "." and ".." components
// will be reduced. This function does not follow symlinks; see [[realpath]] if
-// you need this behavior. The caller must free the return value.
+// you need this behavior. The return value is statically allocated; use
+// [[strings::dup]] to extend its lifetime.
export fn resolve(path: str) str = fs::resolve(cwd, path);
// Returns the path referred to by a symbolic link. The return value is