Skip to content

Commit 2205818

Browse files
cjihrigtargos
authored andcommitted
doc: format Unix consistently
Update the API docs to always spell as Unix. PR-URL: #28576 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
1 parent 643d099 commit 2205818

File tree

6 files changed

+23
-23
lines changed

6 files changed

+23
-23
lines changed

doc/api/child_process.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ changes:
146146
* `encoding` {string} **Default:** `'utf8'`
147147
* `shell` {string} Shell to execute the command with. See
148148
[Shell Requirements][] and [Default Windows Shell][]. **Default:**
149-
`'/bin/sh'` on UNIX, `process.env.ComSpec` on Windows.
149+
`'/bin/sh'` on Unix, `process.env.ComSpec` on Windows.
150150
* `timeout` {number} **Default:** `0`
151151
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
152152
stderr. If exceeded, the child process is terminated and any output is
@@ -260,7 +260,7 @@ changes:
260260
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
261261
done on Windows. Ignored on Unix. **Default:** `false`.
262262
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
263-
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
263+
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
264264
shell can be specified as a string. See [Shell Requirements][] and
265265
[Default Windows Shell][]. **Default:** `false` (no shell).
266266
* `callback` {Function} Called with the output when process terminates.
@@ -411,7 +411,7 @@ changes:
411411
* `uid` {number} Sets the user identity of the process (see setuid(2)).
412412
* `gid` {number} Sets the group identity of the process (see setgid(2)).
413413
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
414-
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
414+
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
415415
shell can be specified as a string. See [Shell Requirements][] and
416416
[Default Windows Shell][]. **Default:** `false` (no shell).
417417
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
@@ -666,7 +666,7 @@ child registers an event handler for the [`'disconnect'`][] event
666666
or the [`'message'`][] event. This allows the child to exit
667667
normally without the process being held open by the open IPC channel.*
668668

669-
On UNIX-like operating systems, the [`child_process.spawn()`][] method
669+
On Unix-like operating systems, the [`child_process.spawn()`][] method
670670
performs memory operations synchronously before decoupling the event loop
671671
from the child. Applications with a large memory footprint may find frequent
672672
[`child_process.spawn()`][] calls to be a bottleneck. For more information,
@@ -729,7 +729,7 @@ changes:
729729
* `windowsHide` {boolean} Hide the subprocess console window that would
730730
normally be created on Windows systems. **Default:** `false`.
731731
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
732-
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
732+
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
733733
shell can be specified as a string. See [Shell Requirements][] and
734734
[Default Windows Shell][]. **Default:** `false` (no shell).
735735
* Returns: {Buffer|string} The stdout from the command.
@@ -780,7 +780,7 @@ changes:
780780
* `env` {Object} Environment key-value pairs.
781781
* `shell` {string} Shell to execute the command with. See
782782
[Shell Requirements][] and [Default Windows Shell][]. **Default:**
783-
`'/bin/sh'` on UNIX, `process.env.ComSpec` on Windows.
783+
`'/bin/sh'` on Unix, `process.env.ComSpec` on Windows.
784784
* `uid` {number} Sets the user identity of the process. (See setuid(2)).
785785
* `gid` {number} Sets the group identity of the process. (See setgid(2)).
786786
* `timeout` {number} In milliseconds the maximum amount of time the process
@@ -858,7 +858,7 @@ changes:
858858
* `encoding` {string} The encoding used for all stdio inputs and outputs.
859859
**Default:** `'buffer'`.
860860
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
861-
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
861+
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
862862
shell can be specified as a string. See [Shell Requirements][] and
863863
[Default Windows Shell][]. **Default:** `false` (no shell).
864864
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
@@ -1255,7 +1255,7 @@ can be handled by the parent and some by the child.
12551255
While the example above uses a server created using the `net` module, `dgram`
12561256
module servers use exactly the same workflow with the exceptions of listening on
12571257
a `'message'` event instead of `'connection'` and using `server.bind()` instead
1258-
of `server.listen()`. This is, however, currently only supported on UNIX
1258+
of `server.listen()`. This is, however, currently only supported on Unix
12591259
platforms.
12601260

12611261
#### Example: sending a socket object

doc/api/cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -589,7 +589,7 @@ The `addressType` is one of:
589589

590590
* `4` (TCPv4)
591591
* `6` (TCPv6)
592-
* `-1` (unix domain socket)
592+
* `-1` (Unix domain socket)
593593
* `'udp4'` or `'udp6'` (UDP v4 or v6)
594594

595595
## Event: 'message'

doc/api/fs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,7 @@ The times in the stat object have the following semantics:
785785
* `birthtime` "Birth Time" - Time of file creation. Set once when the
786786
file is created. On filesystems where birthtime is not available,
787787
this field may instead hold either the `ctime` or
788-
`1970-01-01T00:00Z` (ie, unix epoch timestamp `0`). This value may be greater
788+
`1970-01-01T00:00Z` (ie, Unix epoch timestamp `0`). This value may be greater
789789
than `atime` or `mtime` in this case. On Darwin and other FreeBSD variants,
790790
also set if the `atime` is explicitly set to an earlier value than the current
791791
`birthtime` using the utimes(2) system call.

doc/api/net.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,34 @@ const net = require('net');
1717

1818
## IPC Support
1919

20-
The `net` module supports IPC with named pipes on Windows, and UNIX domain
20+
The `net` module supports IPC with named pipes on Windows, and Unix domain
2121
sockets on other operating systems.
2222

2323
### Identifying paths for IPC connections
2424

2525
[`net.connect()`][], [`net.createConnection()`][], [`server.listen()`][] and
2626
[`socket.connect()`][] take a `path` parameter to identify IPC endpoints.
2727

28-
On UNIX, the local domain is also known as the UNIX domain. The path is a
28+
On Unix, the local domain is also known as the Unix domain. The path is a
2929
filesystem pathname. It gets truncated to `sizeof(sockaddr_un.sun_path) - 1`,
3030
which varies on different operating system between 91 and 107 bytes.
3131
The typical values are 107 on Linux and 103 on macOS. The path is
3232
subject to the same naming conventions and permissions checks as would be done
33-
on file creation. If the UNIX domain socket (that is visible as a file system
33+
on file creation. If the Unix domain socket (that is visible as a file system
3434
path) is created and used in conjunction with one of Node.js' API abstractions
3535
such as [`net.createServer()`][], it will be unlinked as part of
3636
[`server.close()`][]. On the other hand, if it is created and used outside of
3737
these abstractions, the user will need to manually remove it. The same applies
3838
when the path was created by a Node.js API but the program crashes abruptly.
39-
In short, a UNIX domain socket once successfully created will be visible in the
39+
In short, a Unix domain socket once successfully created will be visible in the
4040
filesystem, and will persist until unlinked.
4141

4242
On Windows, the local domain is implemented using a named pipe. The path *must*
4343
refer to an entry in `\\?\pipe\` or `\\.\pipe\`. Any characters are permitted,
4444
but the latter may do some processing of pipe names, such as resolving `..`
4545
sequences. Despite how it might look, the pipe namespace is flat. Pipes will
4646
*not persist*. They are removed when the last reference to them is closed.
47-
Unlike UNIX domain sockets, Windows will close and remove the pipe when the
47+
Unlike Unix domain sockets, Windows will close and remove the pipe when the
4848
owning process exits.
4949

5050
JavaScript string escaping requires paths to be specified with extra backslash
@@ -121,7 +121,7 @@ as reported by the operating system if listening on an IP socket
121121
(useful to find which port was assigned when getting an OS-assigned address):
122122
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`.
123123

124-
For a server listening on a pipe or UNIX domain socket, the name is returned
124+
For a server listening on a pipe or Unix domain socket, the name is returned
125125
as a string.
126126

127127
```js
@@ -241,7 +241,7 @@ added: v0.5.10
241241
* Returns: {net.Server}
242242

243243
Start a server listening for connections on a given `handle` that has
244-
already been bound to a port, a UNIX domain socket, or a Windows named pipe.
244+
already been bound to a port, a Unix domain socket, or a Windows named pipe.
245245

246246
The `handle` object can be either a server, a socket (anything with an
247247
underlying `_handle` member), or an object with an `fd` member that is a
@@ -385,7 +385,7 @@ added: v0.3.4
385385
-->
386386

387387
This class is an abstraction of a TCP socket or a streaming [IPC][] endpoint
388-
(uses named pipes on Windows, and UNIX domain sockets otherwise). A
388+
(uses named pipes on Windows, and Unix domain sockets otherwise). A
389389
`net.Socket` is also a [duplex stream][], so it can be both readable and
390390
writable, and it is also an [`EventEmitter`][].
391391

@@ -496,7 +496,7 @@ changes:
496496
-->
497497

498498
Emitted after resolving the hostname but before connecting.
499-
Not applicable to UNIX sockets.
499+
Not applicable to Unix sockets.
500500

501501
* `err` {Error|null} The error object. See [`dns.lookup()`][].
502502
* `address` {string} The IP address.
@@ -1112,7 +1112,7 @@ server.listen('/tmp/echo.sock', () => {
11121112
});
11131113
```
11141114

1115-
Use `nc` to connect to a UNIX domain socket server:
1115+
Use `nc` to connect to a Unix domain socket server:
11161116

11171117
```console
11181118
$ nc -U /tmp/echo.sock

doc/api/os.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ The properties included on each object include:
164164
]
165165
```
166166

167-
Because `nice` values are UNIX-specific, on Windows the `nice` values of all
167+
Because `nice` values are Unix-specific, on Windows the `nice` values of all
168168
processors are always 0.
169169

170170
## os.endianness()
@@ -239,7 +239,7 @@ The load average is a measure of system activity, calculated by the operating
239239
system and expressed as a fractional number. As a rule of thumb, the load
240240
average should ideally be less than the number of logical CPUs in the system.
241241

242-
The load average is a UNIX-specific concept with no real equivalent on
242+
The load average is a Unix-specific concept with no real equivalent on
243243
Windows platforms. On Windows, the return value is always `[0, 0, 0]`.
244244

245245
## os.networkInterfaces()

doc/api/tls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1207,7 +1207,7 @@ changes:
12071207
* `host` {string} Host the client should connect to. **Default:**
12081208
`'localhost'`.
12091209
* `port` {number} Port the client should connect to.
1210-
* `path` {string} Creates unix socket connection to path. If this option is
1210+
* `path` {string} Creates Unix socket connection to path. If this option is
12111211
specified, `host` and `port` are ignored.
12121212
* `socket` {stream.Duplex} Establish secure connection on a given socket
12131213
rather than creating a new socket. Typically, this is an instance of

0 commit comments

Comments
 (0)