From 7a5d07c7fbd43f3645d7f707fd6a98f2a251bdbd Mon Sep 17 00:00:00 2001 From: JR McEntee Date: Tue, 28 Mar 2017 19:46:10 -0400 Subject: [PATCH] doc: change Mac OS X to macOS This update changes references to "Mac OS X", "OS X", and "OSX" in markdown files to "macOS". PR-URL: https://github.com/nodejs/node/pull/12106 Fixes: https://github.com/nodejs/node/issues/12086 Reviewed-By: Vse Mozhet Byt Reviewed-By: Colin Ihrig Reviewed-By: Richard Lau Reviewed-By: Luigi Pinca Reviewed-By: Gibson Fahnestock Reviewed-By: James M Snell --- BUILDING.md | 12 ++++++------ CONTRIBUTING.md | 2 +- doc/STYLE_GUIDE.md | 2 +- doc/api/child_process.md | 4 ++-- doc/api/documentation.md | 4 ++-- doc/api/errors.md | 2 +- doc/api/fs.md | 14 +++++++------- doc/api/net.md | 2 +- doc/api/os.md | 2 +- doc/api/process.md | 2 +- test/README.md | 2 +- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index ffa233ab93..8bd791b333 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -73,7 +73,7 @@ Depending on host platform, the selection of toolchains may vary. ## Building Node.js on supported platforms -### Unix / OS X +### Unix / macOS Prerequisites: @@ -82,7 +82,7 @@ Prerequisites: * Python 2.6 or 2.7 * GNU Make 3.81 or newer -On OS X, you will also need: +On macOS, you will also need: * [Xcode](https://developer.apple.com/xcode/download/) - You also need to install the `Command Line Tools` via Xcode. You can find this under the menu `Xcode -> Preferences -> Downloads` @@ -236,7 +236,7 @@ With the `--download=all`, this may download ICU if you don't have an ICU in `deps/icu`. (The embedded `small-icu` included in the default Node.js source does not include all locales.) -##### Unix / OS X: +##### Unix / macOS: ```console $ ./configure --with-intl=full-icu --download=all @@ -253,7 +253,7 @@ $ ./configure --with-intl=full-icu --download=all The `Intl` object will not be available, nor some other APIs such as `String.normalize`. -##### Unix / OS X: +##### Unix / macOS: ```console $ ./configure --without-intl @@ -265,7 +265,7 @@ $ ./configure --without-intl > .\vcbuild without-intl ``` -#### Use existing installed ICU (Unix / OS X only): +#### Use existing installed ICU (Unix / macOS only): ```console $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu @@ -281,7 +281,7 @@ You can find other ICU releases at Download the file named something like `icu4c-**##.#**-src.tgz` (or `.zip`). -##### Unix / OS X +##### Unix / macOS From an already-unpacked ICU: ```console diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4daf126bd1..9480944c31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,7 +157,7 @@ Bug fixes and features **should come with tests**. Add your tests in the project, see this [guide](./doc/guides/writing-tests.md). Looking at other tests to see how they should be structured can also help. -To run the tests on Unix / OS X: +To run the tests on Unix / macOS: ```text $ ./configure && make -j4 test diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index f087718a67..0d3fc00107 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -39,7 +39,7 @@ * When documenting APIs, note the version the API was introduced in at the end of the section. If an API has been deprecated, also note the first version that the API appeared deprecated in. -* When using dashes, use emdashes ("—", Ctrl+Alt+"-" on OSX) surrounded by +* When using dashes, use emdashes ("—", Ctrl+Alt+"-" on macOS) surrounded by spaces, per the New York Times usage. * Including assets: * If you wish to add an illustration or full program, add it to the diff --git a/doc/api/child_process.md b/doc/api/child_process.md index df0ba49dbd..8d6c787488 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -75,7 +75,7 @@ when the child process terminates. The importance of the distinction between [`child_process.exec()`][] and [`child_process.execFile()`][] can vary based on platform. On Unix-type operating -systems (Unix, Linux, OSX) [`child_process.execFile()`][] can be more efficient +systems (Unix, Linux, macOS) [`child_process.execFile()`][] can be more efficient because it does not spawn a shell. On Windows, however, `.bat` and `.cmd` files are not executable on their own without a terminal, and therefore cannot be launched using [`child_process.execFile()`][]. When running on Windows, `.bat` @@ -433,7 +433,7 @@ child.on('error', (err) => { }); ``` -*Note: Certain platforms (OS X, Linux) will use the value of `argv[0]` for the +*Note: Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process title while others (Windows, SunOS) will use `command`.* *Note: Node.js currently overwrites `argv[0]` with `process.execPath` on diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 5f45c9b56e..450a250ea9 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -73,11 +73,11 @@ like `fs.open()`, will document that. The docs link to the corresponding man pages (short for manual pages) which describe how the syscalls work. **Caveat:** some syscalls, like lchown(2), are BSD-specific. That means, for -example, that `fs.lchown()` only works on Mac OS X and other BSD-derived systems, +example, that `fs.lchown()` only works on macOS and other BSD-derived systems, and is not available on Linux. Most Unix syscalls have Windows equivalents, but behavior may differ on Windows -relative to Linux and OS X. For an example of the subtle ways in which it's +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 issue 4760](https://github.com/nodejs/node/issues/4760). diff --git a/doc/api/errors.md b/doc/api/errors.md index 96409a5367..05758cf20b 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -523,7 +523,7 @@ found [here][online]. [file descriptors][] allowable on the system has been reached, and requests for another descriptor cannot be fulfilled until at least one has been closed. This is encountered when opening many files at once in - parallel, especially on systems (in particular, OS X) where there is a low + parallel, especially on systems (in particular, macOS) where there is a low file descriptor limit for processes. To remedy a low limit, run `ulimit -n 2048` in the same shell that will run the Node.js process. diff --git a/doc/api/fs.md b/doc/api/fs.md index 0105d35fc2..51f92be93e 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1099,7 +1099,7 @@ changes: Asynchronous lchmod(2). No arguments other than a possible exception are given to the completion callback. -Only available on Mac OS X. +Only available on macOS. ## fs.lchmodSync(path, mode) -On Linux and OS X systems, `fs.watch()` resolves the path to an [inode][] and +On Linux and macOS systems, `fs.watch()` resolves the path to an [inode][] and watches the inode. If the watched path is deleted and recreated, it is assigned a new inode. The watch will emit an event for the delete but will continue watching the *original* inode. Events for the new inode will not be emitted. @@ -1982,7 +1982,7 @@ In AIX, save and close of a file being watched causes two notifications - one for adding new content, and one for truncation. Moreover, save and close operations on some platforms cause inode changes that force watch operations to become invalid and ineffective. AIX retains inode for the -lifetime of a file, that way though this is different from Linux / OS X, +lifetime of a file, that way though this is different from Linux / macOS, this improves the usability of file watching. This is expected behavior. #### Filename Argument diff --git a/doc/api/net.md b/doc/api/net.md index f1df691185..4ca18c1379 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -25,7 +25,7 @@ sockets on other operating systems. On UNIX, the local domain is also known as the UNIX domain. The path is a filesystem path name. It gets truncated to `sizeof(sockaddr_un.sun_path) - 1`, which varies on different operating system between 91 and 107 bytes. -The typical values are 107 on Linux and 103 on OS X. The path is +The typical values are 107 on Linux and 103 on macOS. The path is subject to the same naming conventions and permissions checks as would be done on file creation. It will be visible in the filesystem, and will *persist until unlinked*. diff --git a/doc/api/os.md b/doc/api/os.md index 06779dbb37..480305a7e1 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -363,7 +363,7 @@ added: v0.3.3 * Returns: {string} The `os.type()` method returns a string identifying the operating system name -as returned by uname(3). For example `'Linux'` on Linux, `'Darwin'` on OS X and +as returned by uname(3). For example `'Linux'` on Linux, `'Darwin'` on macOS and `'Windows_NT'` on Windows. Please see https://en.wikipedia.org/wiki/Uname#Examples for additional diff --git a/doc/api/process.md b/doc/api/process.md index 16a301f965..2aea28545a 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1631,7 +1631,7 @@ the current value of `ps`. *Note*: When a new value is assigned, different platforms will impose different maximum length restrictions on the title. Usually such restrictions are quite -limited. For instance, on Linux and OS X, `process.title` is limited to the size +limited. For instance, on Linux and macOS, `process.title` is limited to the size of the binary name plus the length of the command line arguments because setting the `process.title` overwrites the `argv` memory of the process. Node.js v0.8 allowed for longer process title strings by also overwriting the `environ` diff --git a/test/README.md b/test/README.md index b6b21ef772..65c9797f1c 100644 --- a/test/README.md +++ b/test/README.md @@ -292,7 +292,7 @@ Platform check for Linux on PowerPC. ### isOSX * return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) -Platform check for OS X. +Platform check for macOS. ### isSunOS * return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)