1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: simplify system call material in doc overview

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/27966
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
Rich Trott 2019-05-30 10:00:11 +02:00
parent f86100caf3
commit 187b056408
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/api/documentation.md
View File

@ -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/