Skip to content

Commit 11c3ddb

Browse files
Trotttargos
authored andcommitted
doc: simplify system call material in doc overview
PR-URL: #27966 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 799aeca commit 11c3ddb

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

doc/api/documentation.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,14 @@ added: v0.6.12
5151
Every `.html` document has a corresponding `.json` document. This is for IDEs
5252
and other utilities that consume the documentation.
5353

54-
## Syscalls and man pages
54+
## System calls and man pages
5555

56-
System calls like open(2) and read(2) define the interface between user programs
57-
and the underlying operating system. Node.js functions
58-
which wrap a syscall,
59-
like [`fs.open()`][], will document that. The docs link to the corresponding man
60-
pages (short for manual pages) which describe how the syscalls work.
56+
Node.js functions which wrap a system call will document that. The docs link
57+
to the corresponding man pages which describe how the system call works.
6158

62-
Most Unix syscalls have Windows equivalents, but behavior may differ on Windows
63-
relative to Linux and macOS. For an example of the subtle ways in which it's
64-
sometimes impossible to replace Unix syscall semantics on Windows, see [Node.js
65-
issue 4760](https://github.com/nodejs/node/issues/4760).
59+
Most Unix system calls have Windows analogues. Still, behavior differences may
60+
be unavoidable.
6661

67-
[`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback
6862
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
6963
[the issue tracker]: https://github.com/nodejs/node/issues/new
7064
[V8 JavaScript engine]: https://v8.dev/

0 commit comments

Comments
 (0)