Docs: Rename “OS X” to the newer “macOS” convention #13366

pull giulio92 wants to merge 1 commits into bitcoin:master from giulio92:osx-renaming changing 10 files +34 −34

giulio92 commented at 12:55 pm on June 1, 2018: contributor

Since 2016, with macOS 10.12 Sierra, Mac OS X has been renamed in macOS. It would be a nice if Bitcoin’s macOS build instructions follow this naming convention to avoid misunderstandings.
fanquake added the label Docs on Jun 1, 2018
fanquake added the label macOS on Jun 1, 2018
in doc/build-macOS.md:96 in d8bc1a45af outdated
92@@ -93,6 +93,6 @@ Other commands: 93 Notes 94 ----- 95 96-* Tested on OS X 10.8 through 10.13 on 64-bit Intel processors only. 97+* Tested on OS X 10.8 Mountain Lion through macOS 10.13 High Sierra on 64-bit Intel processors only.
Empact commented at 1:20 pm on June 1, 2018:

nit: I would refer to both as macOS here
giulio92 commented at 1:29 pm on June 1, 2018:

I checked the official name for both the macOS releases and Mac OS X 10.8 Mountain Lion was renamed OS X 10.8 Mountain Lion after the macOS introduction. But I agree with you because it may improve readability.

Wikipedia for reference:

OS X Mountain Lion

macOS High Sierra

in doc/README.md:41 in e8cf4ba6d0 outdated

37@@ -38,7 +38,7 @@ Building
38 The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
39 
40 - [Dependencies](dependencies.md)
41-- [OS X Build Notes](build-osx.md)
42+- [macOS Build Notes](build-macOS.md)

MarcoFalke commented at 1:56 pm on June 1, 2018:

No need to rename the file every time apple changes the name of the operating system. This will break all external links.

giulio92 commented at 2:05 pm on June 1, 2018:

Good point! 👍 I have reverted the change in 2d7a92c

practicalswift commented at 2:44 pm on June 1, 2018: contributor

utACK aa975f93710724565ab762333fc6bd9aae861f65 but please squash into one commit :-)
giulio92 commented at 3:15 pm on June 1, 2018: contributor

Sorry, will do now ☺️
practicalswift commented at 4:52 pm on June 1, 2018: contributor

@giulio92 Still three commits instead of one :-)
giulio92 commented at 5:24 pm on June 1, 2018: contributor

Done! 😉
practicalswift commented at 5:44 pm on June 1, 2018: contributor

ACK ea9665eacbfc1d3d55b80753d1cde321f9dcb274
jonasschnelli commented at 10:49 am on June 3, 2018: contributor

The question is where to stop this… (change source code comments, variable names, depends compile system, etc.)

The next level (before the actual source code level) would be to change the “API”, … IMO there is only one thing that could be changed: -uiplatform from maxosx to macos.
giulio92 commented at 11:46 am on June 3, 2018: contributor

I agree with @jonasschnelli but we need to take in count that this can lead to some problems (softwares that use the current API naming won’t work with the first bitcoin version including the new API).

If we agree on the API renaming, should it be part of a separate PR?
laanwj commented at 6:52 am on June 4, 2018: member

Concept ACK. This is good for clarity. Please makes sure that the changes are complete; I’m not looking forward to 20 follow-up PRs that all change a left-over occurrence (I think that’s part of @jonasschnelli’s point too).

If we agree on the API renaming, should it be part of a separate PR?

That should definitely be a separate PR from one that makes harmless changes to the docs.
giulio92 commented at 9:03 am on June 4, 2018: contributor
I agree with you @laanwj, in fact I have checked the whole bitcoin project looking for OS X,osx, Mac OS X, etc. occurrences one more time and these are the files I have changed so far:
- README.md
- contrib/init/README.md
- depends/README.md
- depends/description.md
- doc/README.md
- doc/README_osx.md
- doc/build-osx.md
- doc/release-process.md
- src/qt/README.md
laanwj commented at 10:35 am on June 4, 2018: member

Seems you’ve been very thorough. thanks! Looks like init.md still contains some mentions of “X”. The other mentions I could find are all in source files, build system, or historical release notes.
giulio92 commented at 10:56 am on June 4, 2018: contributor

I have also updated doc/init.md to remove any Mac OS X occurrence. Thank you for finding them!
Rename “OS X” to the newer “macOS” convention 989c8990bb
laanwj commented at 1:48 pm on June 5, 2018: member

utACK 989c8990bb765eef45c8ee471f084ca81a0bead4,
laanwj merged this on Jun 5, 2018
laanwj closed this on Jun 5, 2018
laanwj referenced this in commit 861de3b518 on Jun 5, 2018
giulio92 deleted the branch on Jun 5, 2018
NickIAm referenced this in commit e6dc3e4087 on Apr 18, 2021
UdjinM6 referenced this in commit 2cf0b5284a on Jun 19, 2021
UdjinM6 referenced this in commit d55a67a278 on Jun 24, 2021
UdjinM6 referenced this in commit 04a4b34d54 on Jun 26, 2021
UdjinM6 referenced this in commit 5572e1759b on Jun 26, 2021
UdjinM6 referenced this in commit 8e23a74c36 on Jun 28, 2021
DrahtBot locked this on Sep 8, 2021

Contributors
giulio92 Empact MarcoFalke practicalswift jonasschnelli laanwj

Labels
Docs macOS