Node: Should we replace the word "OS X" with "macOS"?

Created on 28 Mar 2017  Â·  6Comments  Â·  Source: nodejs/node

Last year,Apple update MacOS X 10.11 to macOS Sierra(10.12),so "OSX" "OS X" and "MACOSX" more and less are old.Should we update "OSX" "OS X" and "MACOSX" into "macOS" in our code?

doc good first issue macos question

Most helpful comment

@andmeics IMO, there's no point in littering the Git history (i.e., breaking git blame a little bit, potentially introducing conflicts etc.) for a kinda meaningless change that does not impact functionality, nor fixes a problem. Everyone understands what OS X means despite Mac OS X, OS X, macOS or whichever Apple may choose to rename it again in the future being the official name. Others may have different opinions, though. On the other hand, it seems a good change for the docs to me.

All 6 comments

I don't think it is a good idea to change that in the source code, but the documentation could be updated.


BUILDING.md

77:### Unix / OS X
86:On OS X, you will also need:
240:##### Unix / OS X:
257:##### Unix / OS X:
269:#### Use existing installed ICU (Unix / OS X only):
285:##### Unix / OS X


CONTRIBUTING.md

160:To run the tests on Unix / OS X:


doc/api/child_process.md

436:*Note: Certain platforms (OS X, Linux) will use the value of argv[0] for the


doc/api/documentation.md

76:example, that fs.lchown() only works on Mac OS X and other BSD-derived systems,
80:relative to Linux and OS X. For an example of the subtle ways in which it's


doc/api/errors.md

526: parallel, especially on systems (in particular, OS X) where there is a low


doc/api/fs.md

1102:Only available on Mac OS X.
1377:opening a directory on OS X and Linux with the 'a+' flag - see example below -
1382:// OS X and Linux
1946:The recursive option is only supported on OS X and Windows.
1957:* On OS X, this uses [kqueue] for files and [FSEvents] for directories.
1975:On Linux and OS X systems, fs.watch() resolves the path to an [inode][] and
1985:lifetime of a file, that way though this is different from Linux / OS X,


doc/api/net.md

28:The typical values are 107 on Linux and 103 on OS X. The path is


doc/api/os.md

366:as returned by uname(3). For example 'Linux' on Linux, 'Darwin' on OS X and


doc/api/process.md

1628:limited. For instance, on Linux and OS X, process.title is limited to the size


doc/releases.md

191:This is particularly recommended if there has been recent work relating to the OS X or Windows installers as they are not tested in any way by CI.
197:Use this opportunity particularly to test OS X and Windows installers if there are any concerns.
207:It is only necessary to have the main Linux (x64 and x86), OS X .pkg and .tar.gz, Windows (x64 and x86) .msi and .exe, source, headers and docs (both produced currently by an OS X slave).

Note: it might be a good opportunity to change the word "slave" there to something else too.


test/README.md

295:Platform check for OS X.


doc/api/child_process.md

78:systems (Unix, Linux, OSX) [child_process.execFile()][] can be more efficient


doc/STYLE_GUIDE.md

42:* When using dashes, use emdashes ("—", Ctrl+Alt+"-" on OSX) surrounded by

I think source code comment could be updated too

@andmeics IMO, there's no point in littering the Git history (i.e., breaking git blame a little bit, potentially introducing conflicts etc.) for a kinda meaningless change that does not impact functionality, nor fixes a problem. Everyone understands what OS X means despite Mac OS X, OS X, macOS or whichever Apple may choose to rename it again in the future being the official name. Others may have different opinions, though. On the other hand, it seems a good change for the docs to me.

I know,do it can help docs unified

@andmeics would you be interested in opening a PR for that? :)

Yeah let's just leave the source code. People will know what it means for _years_. IMO we should definitely update the docs though.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

danielstaleiny picture danielstaleiny  Â·  3Comments

seishun picture seishun  Â·  3Comments

filipesilvaa picture filipesilvaa  Â·  3Comments

stevenvachon picture stevenvachon  Â·  3Comments

srl295 picture srl295  Â·  3Comments