Skip to content

Commit 71e9494

Browse files
committed
Document nqp::lstat
1 parent f7586fc commit 71e9494

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/ops.markdown

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1110,9 +1110,9 @@ directory didn't exist. May throw an exception.
11101110
## stat
11111111
* `stat(str $path, int $code)`
11121112

1113-
Given a path and a code, return an int describing that path. Any of
1114-
these variants may throw an exception if the platform does not support
1115-
them. (JVM does not support `STAT_PLATFORM_BLOCKSIZE` or
1113+
Given a path and a code, return an int describing that path using the OS's
1114+
stat() function. Any of these variants may throw an exception if the platform
1115+
does not support them. (JVM does not support `STAT_PLATFORM_BLOCKSIZE` or
11161116
`STAT_PLATFORM_BLOCKS`).
11171117

11181118
* `nqp::const::STAT_EXISTS`
@@ -1190,6 +1190,12 @@ Returns preferred I/O size in bytes for interacting with the file.
11901190

11911191
Returns number of system-specific blocks allocated on disk.
11921192

1193+
## lstat
1194+
* `lstat(str $path, int $code)`
1195+
1196+
Same as stat, but internally uses the OS's lstat() function, which does *not*
1197+
follow symlinks.
1198+
11931199
## symlink
11941200
* `symlink(str $before, str $after)`
11951201

0 commit comments

Comments
 (0)