Skip to content

Commit fc41278

Browse files
committed
Merge pull request #6843
99963b9 Correct spelling mistakes in doc folder (Mitchell Cash)
2 parents 5888046 + 99963b9 commit fc41278

14 files changed

+99
-103
lines changed

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Setup
77

88
Running
99
---------------------
10-
The following are some helpful notes on how to run Bitcoin on your native platform.
10+
The following are some helpful notes on how to run Bitcoin on your native platform.
1111

1212
### Unix
1313

@@ -26,7 +26,7 @@ Unpack the files into a directory and run:
2626

2727
Unpack the files into a directory, and then run bitcoin-qt.exe.
2828

29-
### OSX
29+
### OS X
3030

3131
Drag Bitcoin-Qt to your applications folder, and then run Bitcoin-Qt.
3232

@@ -41,7 +41,7 @@ Building
4141
---------------------
4242
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.
4343

44-
- [OSX Build Notes](build-osx.md)
44+
- [OS X Build Notes](build-osx.md)
4545
- [Unix Build Notes](build-unix.md)
4646
- [Gitian Building Guide](gitian-building.md)
4747

doc/README_osx.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Deterministic OSX Dmg Notes.
1+
Deterministic OS X Dmg Notes.
22

3-
Working OSX DMGs are created in Linux by combining a recent clang,
3+
Working OS X DMGs are created in Linux by combining a recent clang,
44
the Apple's 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 OSX. A pre-compiled version of 3.2 is used because it was not
9+
when building for OS X. A pre-compiled version of 3.2 is used because it was not
1010
available in the Precise repositories at the time this work was started. In the
1111
future, it can be switched to use system packages instead.
1212

@@ -29,18 +29,18 @@ originally done in toolchain4.
2929

3030
To complicate things further, all builds must target an Apple SDK. These SDKs
3131
are free to download, but not redistributable.
32-
To obtain it, register for a developer account, then download the XCode 6.1.1 dmg:
32+
To obtain it, register for a developer account, then download the Xcode 6.1.1 dmg:
3333
https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
3434

3535
This file is several gigabytes in size, but only a single directory inside is
3636
needed: Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.9.sdk
3737

3838
Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file.
39-
To create a tarball suitable for gitian input, mount the dmg in OSX, then create it with:
39+
To create a tarball suitable for Gitian input, mount the dmg in OS X, then create it with:
4040
$ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk
4141

4242

43-
The gitian descriptors build 2 sets of files: Linux tools, then Apple binaries
43+
The Gitian descriptors build 2 sets of files: Linux tools, then Apple binaries
4444
which are created using these tools. The build process has been designed to
4545
avoid including the SDK's files in Gitian's outputs. All interim tarballs are
4646
fully deterministic and may be freely redistributed.
@@ -64,20 +64,20 @@ Ideally, the creation could be fixed and genisoimage would no longer be necessar
6464

6565
Background images and other features can be added to DMG files by inserting a
6666
.DS_Store before creation. The easiest way to create this file is to build a
67-
DMG without one, move it to a device running OSX, customize the layout, then
67+
DMG without one, move it to a device running OS X, customize the layout, then
6868
grab the .DS_Store file for later use. That is the approach taken here.
6969

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

75-
- Builders use gitian to create an unsigned release. This outputs an unsigned
75+
- Builders use Gitian to create an unsigned release. This outputs an unsigned
7676
dmg which users may choose to bless and run. It also outputs an unsigned app
7777
structure in the form of a tarball, which also contains all of the tools
7878
that have been previously (deterministically) built in order to create a
7979
final dmg.
8080
- The Apple keyholder uses this unsigned app to create a detached signature,
8181
using the script that is also included there.
82-
- Builders feed the unsigned app + detached signature back into gitian. It
82+
- Builders feed the unsigned app + detached signature back into Gitian. It
8383
uses the pre-built tools to recombine the pieces into a deterministic dmg.

doc/build-openbsd.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Do not use `pkg_add boost`! The boost version installed thus is compiled using t
3838

3939
test_bitcoin:/usr/lib/libstdc++.so.57.0: /usr/local/lib/libestdc++.so.17.0 : WARNING: symbol(_ZN11__gnu_debug17_S_debug_me ssagesE) size mismatch, relink your program
4040
...
41-
Segmentation fault (core dumped)
41+
Segmentation fault (core dumped)
4242

4343
This makes it necessary to build boost, or at least the parts used by Bitcoin Core, manually:
4444

@@ -57,7 +57,7 @@ tar -xjf boost_1_59_0.tar.bz2
5757
# Boost 1.59 needs two small patches for OpenBSD
5858
cd boost_1_59_0
5959
# Also here: https://gist.githubusercontent.com/laanwj/bf359281dc319b8ff2e1/raw/92250de8404b97bb99d72ab898f4a8cb35ae1ea3/patch-boost_test_impl_execution_monitor_ipp.patch
60-
patch -p0 < /usr/ports/devel/boost/patches/patch-boost_test_impl_execution_monitor_ipp
60+
patch -p0 < /usr/ports/devel/boost/patches/patch-boost_test_impl_execution_monitor_ipp
6161
# https://github.com/boostorg/filesystem/commit/90517e459681790a091566dce27ca3acabf9a70c
6262
sed 's/__OPEN_BSD__/__OpenBSD__/g' < libs/filesystem/src/path.cpp > libs/filesystem/src/path.cpp.tmp
6363
mv libs/filesystem/src/path.cpp.tmp libs/filesystem/src/path.cpp
@@ -92,7 +92,7 @@ tar -xzf db-4.8.30.NC.tar.gz
9292
# Build the library and install to specified prefix
9393
cd db-4.8.30.NC/build_unix/
9494
# Note: Do a static build so that it can be embedded into the executable, instead of having to find a .so at runtime
95-
../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX CC=egcc CXX=eg++ CPP=ecpp
95+
../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX CC=egcc CXX=eg++ CPP=ecpp
9696
make install
9797
```
9898

@@ -160,4 +160,3 @@ version installed by OpenBSD 5.7:
160160
- https://llvm.org/bugs/show_bug.cgi?id=9758
161161

162162
There is no known workaround for this.
163-

doc/build-osx.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Mac OS X Build Instructions and Notes
22
====================================
3-
This guide will show you how to build bitcoind (headless client) for OSX.
3+
This guide will show you how to build bitcoind (headless client) for OS X.
44

55
Notes
66
-----
@@ -13,8 +13,8 @@ built-in one is located in `/Applications/Utilities`.
1313
Preparation
1414
-----------
1515

16-
You need to install XCode with all the options checked so that the compiler
17-
and everything is available in /usr not just /Developer. XCode should be
16+
You need to install Xcode with all the options checked so that the compiler
17+
and everything is available in /usr not just /Developer. Xcode should be
1818
available on your OS X installation media, but if not, you can get the
1919
current version from https://developer.apple.com/xcode/. If you install
2020
Xcode 4.3 or later, you'll need to install its command line tools. This can
@@ -38,7 +38,7 @@ NOTE: Building with Qt4 is still supported, however, could result in a broken UI
3838

3939
### Building `bitcoind`
4040

41-
1. Clone the github tree to get the source code and go into the directory.
41+
1. Clone the GitHub tree to get the source code and go into the directory.
4242

4343
git clone https://github.com/bitcoin/bitcoin.git
4444
cd bitcoin
@@ -62,7 +62,7 @@ Use Qt Creator as IDE
6262
You can use Qt Creator as IDE, for debugging and for manipulating forms, etc.
6363
Download Qt Creator from http://www.qt.io/download/. Download the "community edition" and only install Qt Creator (uncheck the rest during the installation process).
6464

65-
1. Make sure you installed everything through homebrew mentioned above
65+
1. Make sure you installed everything through Homebrew mentioned above
6666
2. Do a proper ./configure --with-gui=qt5 --enable-debug
6767
3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
6868
4. Enter "bitcoin-qt" as project name, enter src/qt as location

doc/developer-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this cas
5757

5858
To describe a class use the same construct above the class definition:
5959
```c++
60-
/**
60+
/**
6161
* Alerts are for notifying old versions if they become too obsolete and
6262
* need to upgrade. The message is displayed in the status bar.
6363
* @see GetWarnings()

doc/dnsseed-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ As such, DNS seeds must be run by entities which have some minimum
77
level of trust within the Bitcoin community.
88

99
Other implementations of Bitcoin software may also use the same
10-
seeds and may be more exposed. In light of this exposure, this
10+
seeds and may be more exposed. In light of this exposure, this
1111
document establishes some basic expectations for operating dnsseeds.
1212

1313
0. A DNS seed operating organization or person is expected to follow good

0 commit comments

Comments
 (0)