diff options
author | Jamie Davis <davisjam@vt.edu> | 2017-03-28 11:44:40 -0400 |
---|---|---|
committer | Santiago Gimeno <santiago.gimeno@gmail.com> | 2017-04-01 19:25:17 +0200 |
commit | eb8509210df264d30644a93d83d5fbdf5d580231 (patch) | |
tree | 96b19dd1b459b7387ba1f0698950780b7a485666 /docs/src | |
parent | 671ad7839dc776235e8ee4126f4d3dd6c89611fd (diff) | |
download | libuv-eb8509210df264d30644a93d83d5fbdf5d580231.tar.gz libuv-eb8509210df264d30644a93d83d5fbdf5d580231.zip |
doc: fix multiple doc typos
Use "file system" instead of "filesystem" throughout the document and
some other minor fixes.
PR-URL: https://github.com/libuv/libuv/pull/1278
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'docs/src')
-rw-r--r-- | docs/src/design.rst | 2 | ||||
-rw-r--r-- | docs/src/fs.rst | 14 | ||||
-rw-r--r-- | docs/src/fs_event.rst | 4 | ||||
-rw-r--r-- | docs/src/threadpool.rst | 2 |
4 files changed, 11 insertions, 11 deletions
diff --git a/docs/src/design.rst b/docs/src/design.rst index 34c3cff6..ecf2609b 100644 --- a/docs/src/design.rst +++ b/docs/src/design.rst @@ -128,7 +128,7 @@ For a thorough explanation of the cross-platform file I/O landscape, checkout libuv currently uses a global thread pool on which all loops can queue work on. 3 types of operations are currently run on this pool: - * Filesystem operations + * File system operations * DNS functions (getaddrinfo and getnameinfo) * User specified code via :c:func:`uv_queue_work` diff --git a/docs/src/fs.rst b/docs/src/fs.rst index 192ecc70..17e328c7 100644 --- a/docs/src/fs.rst +++ b/docs/src/fs.rst @@ -1,15 +1,15 @@ .. _fs: -Filesystem operations +File system operations ===================== -libuv provides a wide variety of cross-platform sync and async filesystem +libuv provides a wide variety of cross-platform sync and async file system operations. All functions defined in this document take a callback, which is allowed to be NULL. If the callback is NULL the request is completed synchronously, otherwise it will be performed asynchronously. -All file operations are run on the threadpool, see :ref:`threadpool` for information +All file operations are run on the threadpool. See :ref:`threadpool` for information on the threadpool size. @@ -18,7 +18,7 @@ Data types .. c:type:: uv_fs_t - Filesystem request type. + File system request type. .. c:type:: uv_timespec_t @@ -58,7 +58,7 @@ Data types .. c:type:: uv_fs_type - Filesystem request type. + File system request type. :: @@ -216,7 +216,7 @@ API Unlike `scandir(3)`, this function does not return the "." and ".." entries. .. note:: - On Linux, getting the type of an entry is only supported by some filesystems (btrfs, ext2, + On Linux, getting the type of an entry is only supported by some file systems (btrfs, ext2, ext3 and ext4 at the time of this writing), check the :man:`getdents(2)` man page. .. c:function:: int uv_fs_stat(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb) @@ -291,7 +291,7 @@ API Equivalent to :man:`realpath(3)` on Unix. Windows uses `GetFinalPathNameByHandle <https://msdn.microsoft.com/en-us/library/windows/desktop/aa364962(v=vs.85).aspx>`_. .. warning:: - This function has certain platform specific caveats that were discovered when used in Node. + This function has certain platform-specific caveats that were discovered when used in Node. * macOS and other BSDs: this function will fail with UV_ELOOP if more than 32 symlinks are found while resolving the given path. This limit is hardcoded and cannot be sidestepped. diff --git a/docs/src/fs_event.rst b/docs/src/fs_event.rst index fb855b0b..2af3e980 100644 --- a/docs/src/fs_event.rst +++ b/docs/src/fs_event.rst @@ -66,7 +66,7 @@ Data types UV_FS_EVENT_WATCH_ENTRY = 1, /* * By default uv_fs_event will try to use a kernel interface such as inotify - * or kqueue to detect events. This may not work on remote filesystems such + * or kqueue to detect events. This may not work on remote file systems such * as NFS mounts. This flag makes fs_event fall back to calling stat() on a * regular interval. * This flag is currently not implemented yet on any backend. @@ -74,7 +74,7 @@ Data types UV_FS_EVENT_STAT = 2, /* * By default, event watcher, when watching directory, is not registering - * (is ignoring) changes in it's subdirectories. + * (is ignoring) changes in its subdirectories. * This flag will override this behaviour on platforms that support it. */ UV_FS_EVENT_RECURSIVE = 4 diff --git a/docs/src/threadpool.rst b/docs/src/threadpool.rst index 18949507..93bd236d 100644 --- a/docs/src/threadpool.rst +++ b/docs/src/threadpool.rst @@ -5,7 +5,7 @@ Thread pool work scheduling =========================== libuv provides a threadpool which can be used to run user code and get notified -in the loop thread. This thread pool is internally used to run all filesystem +in the loop thread. This thread pool is internally used to run all file system operations, as well as getaddrinfo and getnameinfo requests. Its default size is 4, but it can be changed at startup time by setting the |