Skip to content

Commit 861de3b

Browse files
committed
Merge #13366: Docs: Rename “OS X” to the newer “macOS” convention
989c899 Rename “OS X” to the newer “macOS” convention (Giulio Lombardo) Pull request description: Since 2016, with [macOS 10.12 Sierra](https://en.wikipedia.org/wiki/MacOS_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. Tree-SHA512: 51b7d54bfc39a1a9d0773c64780817c7beca7094aded80481086287474dfa272bf0a1dfa6ef6e3cae91548aa127f65fa730003dddcb97147cdc8c249146aea22
2 parents 0de7cc8 + 989c899 commit 861de3b

File tree

10 files changed

+34
-34
lines changed

10 files changed

+34
-34
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ There are also [regression and integration tests](/test), written
5252
in Python, that are run automatically on the build server.
5353
These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py`
5454

55-
The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, and that unit/sanity tests are run automatically.
55+
The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.
5656

5757
### Manual Quality Assurance (QA) Testing
5858

contrib/init/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Upstart: bitcoind.conf
55
OpenRC: bitcoind.openrc
66
bitcoind.openrcconf
77
CentOS: bitcoind.init
8-
OS X: org.bitcoin.bitcoind.plist
8+
macOS: org.bitcoin.bitcoind.plist
99
```
1010
have been made available to assist packagers in creating node packages here.
1111

depends/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Common `host-platform-triplets` for cross compilation are:
2222

2323
- `i686-w64-mingw32` for Win32
2424
- `x86_64-w64-mingw32` for Win64
25-
- `x86_64-apple-darwin11` for MacOSX
25+
- `x86_64-apple-darwin11` for macOS
2626
- `arm-linux-gnueabihf` for Linux ARM 32 bit
2727
- `aarch64-linux-gnu` for Linux ARM 64 bit
2828

@@ -49,7 +49,7 @@ The following can be set when running make: make FOO=bar
4949

5050
SOURCES_PATH: downloaded sources will be placed here
5151
BASE_CACHE: built packages will be placed here
52-
SDK_PATH: Path where sdk's can be found (used by OSX)
52+
SDK_PATH: Path where sdk's can be found (used by macOS)
5353
FALLBACK_DOWNLOAD_PATH: If a source file can't be fetched, try here before giving up
5454
NO_QT: Don't download/build/cache qt and its dependencies
5555
NO_WALLET: Don't download/build/cache libs needed to enable the wallet
@@ -64,7 +64,7 @@ options will be passed to bitcoin's configure. In this case, `--disable-wallet`.
6464
Additional targets:
6565

6666
download: run 'make download' to fetch all sources without building them
67-
download-osx: run 'make download-osx' to fetch all sources needed for osx builds
67+
download-osx: run 'make download-osx' to fetch all sources needed for macOS builds
6868
download-win: run 'make download-win' to fetch all sources needed for win builds
6969
download-linux: run 'make download-linux' to fetch all sources needed for linux builds
7070

depends/description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ In theory, binaries for any target OS/architecture can be created, from a
77
builder running any OS/architecture. In practice, build-side tools must be
88
specified when the defaults don't fit, and packages must be amended to work
99
on new hosts. For now, a build architecture of x86_64 is assumed, either on
10-
Linux or OSX.
10+
Linux or macOS.
1111

1212
### No reliance on timestamps
1313

doc/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Unpack the files into a directory and run:
2222

2323
Unpack the files into a directory, and then run bitcoin-qt.exe.
2424

25-
### OS X
25+
### macOS
2626

2727
Drag Bitcoin-Core to your applications folder, and then run Bitcoin-Core.
2828

@@ -38,7 +38,7 @@ Building
3838
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.
3939

4040
- [Dependencies](dependencies.md)
41-
- [OS X Build Notes](build-osx.md)
41+
- [macOS Build Notes](build-osx.md)
4242
- [Unix Build Notes](build-unix.md)
4343
- [Windows Build Notes](build-windows.md)
4444
- [OpenBSD Build Notes](build-openbsd.md)

doc/README_osx.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Deterministic OS X DMG Notes.
1+
Deterministic macOS DMG Notes.
22

3-
Working OS X DMGs are created in Linux by combining a recent clang,
3+
Working macOS DMGs are created in Linux by combining a recent clang,
44
the Apple binutils (ld, ar, etc) and DMG authoring tools.
55

66
Apple uses clang extensively for development and has upstreamed the necessary
77
functionality so that a vanilla clang can take advantage. It supports the use
88
of -F, -target, -mmacosx-version-min, and --sysroot, which are all necessary
9-
when building for OS X.
9+
when building for macOS.
1010

1111
Apple's version of binutils (called cctools) contains lots of functionality
1212
missing in the FSF's binutils. In addition to extra linker options for
@@ -38,7 +38,7 @@ Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.1
3838
Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file.
3939
To create a tarball suitable for Gitian input, there are two options:
4040

41-
Using Mac OS X, you can mount the dmg, and then create it with:
41+
Using macOS, you can mount the dmg, and then create it with:
4242
```
4343
$ hdiutil attach Xcode_7.3.1.dmg
4444
$ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.11.sdk.tar.gz MacOSX10.11.sdk
@@ -81,7 +81,7 @@ Background images and other features can be added to DMG files by inserting a
8181
.DS_Store before creation. This is generated by the script
8282
contrib/macdeploy/custom_dsstore.py.
8383

84-
As of OS X Mavericks (10.9), using an Apple-blessed key to sign binaries is a
84+
As of OS X 10.9 Mavericks, using an Apple-blessed key to sign binaries is a
8585
requirement in order to satisfy the new Gatekeeper requirements. Because this
8686
private key cannot be shared, we'll have to be a bit creative in order for the
8787
build process to remain somewhat deterministic. Here's how it works:

doc/build-osx.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Mac OS X Build Instructions and Notes
1+
macOS Build Instructions and Notes
22
====================================
33
The commands in this guide should be executed in a Terminal application.
44
The built-in one is located in `/Applications/Utilities/Terminal.app`.
55

66
Preparation
77
-----------
8-
Install the OS X command line tools:
8+
Install the macOS command line tools:
99

1010
`xcode-select --install`
1111

@@ -93,6 +93,6 @@ Other commands:
9393
Notes
9494
-----
9595

96-
* Tested on OS X 10.8 through 10.13 on 64-bit Intel processors only.
96+
* Tested on OS X 10.8 Mountain Lion through macOS 10.13 High Sierra on 64-bit Intel processors only.
9797

9898
* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/issues/7714)

doc/init.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Service User
1515

1616
All three Linux startup configurations assume the existence of a "bitcoin" user
1717
and group. They must be created before attempting to use these scripts.
18-
The OS X configuration assumes bitcoind will be set up for the current user.
18+
The macOS configuration assumes bitcoind will be set up for the current user.
1919

2020
Configuration
2121
---------------------------------
@@ -65,7 +65,7 @@ reasons to make the configuration file and data directory only readable by the
6565
bitcoin user and group. Access to bitcoin-cli and other bitcoind rpc clients
6666
can then be controlled by group membership.
6767

68-
### Mac OS X
68+
### macOS
6969

7070
Binary: `/usr/local/bin/bitcoind`
7171
Configuration file: `~/Library/Application Support/Bitcoin/bitcoin.conf`
@@ -111,7 +111,7 @@ Using this script, you can adjust the path and flags to the bitcoind program by
111111
setting the BITCOIND and FLAGS environment variables in the file
112112
/etc/sysconfig/bitcoind. You can also use the DAEMONOPTS environment variable here.
113113

114-
### Mac OS X
114+
### macOS
115115

116116
Copy org.bitcoin.bitcoind.plist into ~/Library/LaunchAgents. Load the launch agent by
117117
running `launchctl load ~/Library/LaunchAgents/org.bitcoin.bitcoind.plist`.

doc/release-process.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Ensure gitian-builder is up-to-date:
8989
wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
9090
popd
9191

92-
Create the OS X SDK tarball, see the [OS X readme](README_osx.md) for details, and copy it into the inputs directory.
92+
Create the macOS SDK tarball, see the [macOS readme](README_osx.md) for details, and copy it into the inputs directory.
9393

9494
### Optional: Seed the Gitian sources cache and offline git repositories
9595

@@ -111,7 +111,7 @@ NOTE: Offline builds must use the --url flag to ensure Gitian fetches only from
111111

112112
The gbuild invocations below <b>DO NOT DO THIS</b> by default.
113113

114-
### Build and sign Bitcoin Core for Linux, Windows, and OS X:
114+
### Build and sign Bitcoin Core for Linux, Windows, and macOS:
115115

116116
pushd ./gitian-builder
117117
./bin/gbuild --num-make 2 --memory 3000 --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
@@ -134,7 +134,7 @@ Build output expected:
134134
1. source tarball (`bitcoin-${VERSION}.tar.gz`)
135135
2. linux 32-bit and 64-bit dist tarballs (`bitcoin-${VERSION}-linux[32|64].tar.gz`)
136136
3. windows 32-bit and 64-bit unsigned installers and dist zips (`bitcoin-${VERSION}-win[32|64]-setup-unsigned.exe`, `bitcoin-${VERSION}-win[32|64].zip`)
137-
4. OS X unsigned installer and dist tarball (`bitcoin-${VERSION}-osx-unsigned.dmg`, `bitcoin-${VERSION}-osx64.tar.gz`)
137+
4. macOS unsigned installer and dist tarball (`bitcoin-${VERSION}-osx-unsigned.dmg`, `bitcoin-${VERSION}-osx64.tar.gz`)
138138
5. Gitian signatures (in `gitian.sigs/${VERSION}-<linux|{win,osx}-unsigned>/(your Gitian key)/`)
139139

140140
### Verify other gitian builders signatures to your own. (Optional)
@@ -161,13 +161,13 @@ Commit your signature to gitian.sigs:
161161
git push # Assuming you can push to the gitian.sigs tree
162162
popd
163163

164-
Codesigner only: Create Windows/OS X detached signatures:
164+
Codesigner only: Create Windows/macOS detached signatures:
165165
- Only one person handles codesigning. Everyone else should skip to the next step.
166-
- Only once the Windows/OS X builds each have 3 matching signatures may they be signed with their respective release keys.
166+
- Only once the Windows/macOS builds each have 3 matching signatures may they be signed with their respective release keys.
167167

168-
Codesigner only: Sign the osx binary:
168+
Codesigner only: Sign the macOS binary:
169169

170-
transfer bitcoin-osx-unsigned.tar.gz to osx for signing
170+
transfer bitcoin-osx-unsigned.tar.gz to macOS for signing
171171
tar xf bitcoin-osx-unsigned.tar.gz
172172
./detached-sig-create.sh -s "Key ID"
173173
Enter the keychain password and authorize the signature
@@ -192,12 +192,12 @@ Codesigner only: Commit the detached codesign payloads:
192192
git tag -s v${VERSION} HEAD
193193
git push the current branch and new tag
194194

195-
Non-codesigners: wait for Windows/OS X detached signatures:
195+
Non-codesigners: wait for Windows/macOS detached signatures:
196196

197-
- Once the Windows/OS X builds each have 3 matching signatures, they will be signed with their respective release keys.
197+
- Once the Windows/macOS builds each have 3 matching signatures, they will be signed with their respective release keys.
198198
- Detached signatures will then be committed to the [bitcoin-detached-sigs](https://github.com/bitcoin-core/bitcoin-detached-sigs) repository, which can be combined with the unsigned apps to create signed binaries.
199199

200-
Create (and optionally verify) the signed OS X binary:
200+
Create (and optionally verify) the signed macOS binary:
201201

202202
pushd ./gitian-builder
203203
./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
@@ -216,7 +216,7 @@ Create (and optionally verify) the signed Windows binaries:
216216
mv build/out/bitcoin-*win32-setup.exe ../bitcoin-${VERSION}-win32-setup.exe
217217
popd
218218

219-
Commit your signature for the signed OS X/Windows binaries:
219+
Commit your signature for the signed macOS/Windows binaries:
220220

221221
pushd gitian.sigs
222222
git add ${VERSION}-osx-signed/"${SIGNER}"

src/qt/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The current precise version for Qt 5 is specified in [qt.mk](/depends/packages/q
44

55
## Compile and run
66

7-
See build instructions ([OSX](/doc/build-osx.md), [Windows](/doc/build-windows.md), [Unix](/doc/build-unix.md), etc).
7+
See build instructions ([macOS](/doc/build-osx.md), [Windows](/doc/build-windows.md), [Unix](/doc/build-unix.md), etc).
88

99
To run:
1010

@@ -65,7 +65,7 @@ Represents the view to a single wallet.
6565
* `guiconstants.h`: UI colors, app name, etc
6666
* `guiutil.h`: several helper functions
6767
* `macdockiconhandler.(h/cpp)`
68-
* `macdockiconhandler.(h/cpp)`: display notifications in OSX
68+
* `macdockiconhandler.(h/cpp)`: display notifications in macOS
6969

7070
## Contribute
7171

@@ -81,9 +81,9 @@ the UI layout.
8181
Download and install the community edition of [Qt Creator](https://www.qt.io/download/).
8282
Uncheck everything except Qt Creator during the installation process.
8383

84-
Instructions for OSX:
84+
Instructions for macOS:
8585

86-
1. Make sure you installed everything through Homebrew mentioned in the [OSX build instructions](/doc/build-osx.md)
86+
1. Make sure you installed everything through Homebrew mentioned in the [macOS build instructions](/doc/build-osx.md)
8787
2. Use `./configure` with the `--enable-debug` flag
8888
3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
8989
4. Enter "bitcoin-qt" as project name, enter src/qt as location

0 commit comments

Comments
 (0)