From 11c3ddb4cbd3c6f83f781b0fc8d611a119105c15 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 30 May 2019 10:00:11 +0200 Subject: [PATCH] doc: simplify system call material in doc overview PR-URL: https://github.com/nodejs/node/pull/27966 Reviewed-By: Colin Ihrig Reviewed-By: Luigi Pinca --- doc/api/documentation.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/doc/api/documentation.md b/doc/api/documentation.md index b441e9806fed5b..c0733f266dd830 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -51,20 +51,14 @@ added: v0.6.12 Every `.html` document has a corresponding `.json` document. This is for IDEs and other utilities that consume the documentation. -## Syscalls and man pages +## System calls and man pages -System calls like open(2) and read(2) define the interface between user programs -and the underlying operating system. Node.js functions -which wrap a syscall, -like [`fs.open()`][], will document that. The docs link to the corresponding man -pages (short for manual pages) which describe how the syscalls work. +Node.js functions which wrap a system call will document that. The docs link +to the corresponding man pages which describe how the system call works. -Most Unix syscalls have Windows equivalents, but behavior may differ on Windows -relative to Linux and macOS. For an example of the subtle ways in which it's -sometimes impossible to replace Unix syscall semantics on Windows, see [Node.js -issue 4760](https://github.com/nodejs/node/issues/4760). +Most Unix system calls have Windows analogues. Still, behavior differences may +be unavoidable. -[`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback [the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md [the issue tracker]: https://github.com/nodejs/node/issues/new [V8 JavaScript engine]: https://v8.dev/