diff --git a/base/event.jl b/base/event.jl index 84ca7d1777bec..d7adfed6dd966 100644 --- a/base/event.jl +++ b/base/event.jl @@ -29,7 +29,7 @@ Block the current task until some event occurs, depending on the type of the arg can be used to determine success or failure. * [`Task`](@ref): Wait for a `Task` to finish. If the task fails with an exception, the exception is propagated (re-thrown in the task that called `wait`). -* `RawFD`: Wait for changes on a file descriptor (see the `FileWatching` package). +* [`RawFD`](@ref): Wait for changes on a file descriptor (see the `FileWatching` package). If no argument is passed, the task blocks for an undefined period. A task can only be restarted by an explicit call to [`schedule`](@ref) or [`yieldto`](@ref). diff --git a/base/libc.jl b/base/libc.jl index c06fcee7da662..18486d43d4eb8 100644 --- a/base/libc.jl +++ b/base/libc.jl @@ -19,6 +19,15 @@ include(string(length(Core.ARGS) >= 2 ? Core.ARGS[2] : "", "errno_h.jl")) # inc ## RawFD ## # Wrapper for an OS file descriptor (on both Unix and Windows) +""" + RawFD + +Primitive type which wraps the native OS file descriptor. +`RawFD`s can be passed to methods like [`stat`](@ref) to +discover information about the underlying file, and can +also be used to open streams, with the `RawFD` describing +the OS file backing the stream. +""" primitive type RawFD 32 end RawFD(fd::Integer) = bitcast(RawFD, Cint(fd)) RawFD(fd::RawFD) = fd diff --git a/doc/src/base/file.md b/doc/src/base/file.md index 26e9f9d577928..d2f57e2462486 100644 --- a/doc/src/base/file.md +++ b/doc/src/base/file.md @@ -12,6 +12,7 @@ Base.Filesystem.symlink Base.Filesystem.readlink Base.Filesystem.chmod Base.Filesystem.chown +Base.RawFD Base.stat Base.Filesystem.lstat Base.Filesystem.ctime