highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-02-28 18:19:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Correct spelling mistakes in doc folder

Browse Source 
- OSX —> OS X
- XCode —> Xcode
- github —> GitHub
- homebrew —> Homebrew
- gitian —> Gitian
- Other miscellaneous obvious spelling fixes and whitespace removal
This commit is contained in:
Mitchell Cash
2015-10-17 20:10:45 +10:00
committed by Luke Dashjr
parent eae0350b9c
commit 256321ebd2
8 changed files with 72 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/README.md
View File

@@ -26,7 +26,7 @@ Unpack the files into a directory and run:
Unpack the files into a directory, and then run bitcoin-qt.exe. Unpack the files into a directory, and then run bitcoin-qt.exe.
### OSX ### OS X
Drag Bitcoin-Qt to your applications folder, and then run Bitcoin-Qt. Drag Bitcoin-Qt to your applications folder, and then run Bitcoin-Qt.
@@ -41,7 +41,7 @@ Building
--------------------- ---------------------
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. 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.
- [OSX Build Notes](build-osx.md) - [OS X Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md) - [Unix Build Notes](build-unix.md)
Development Development

18
doc/README_osx.txt
View File

@@ -1,12 +1,12 @@
Deterministic OSX Dmg Notes. Deterministic OS X Dmg Notes.
Working OSX DMG's are created in Linux by combining a recent clang, Working OS X DMGs are created in Linux by combining a recent clang,
the Apple's binutils (ld, ar, etc), and DMG authoring tools. the Apple's binutils (ld, ar, etc), and DMG authoring tools.
Apple uses clang extensively for development and has upstreamed the necessary Apple uses clang extensively for development and has upstreamed the necessary
functionality so that a vanilla clang can take advantage. It supports the use functionality so that a vanilla clang can take advantage. It supports the use
of -F, -target, -mmacosx-version-min, and --sysroot, which are all necessary of -F, -target, -mmacosx-version-min, and --sysroot, which are all necessary
when building for OSX. A pre-compiled version of 3.2 is used because it was not when building for OS X. A pre-compiled version of 3.2 is used because it was not
available in the Precise repositories at the time this work was started. In the available in the Precise repositories at the time this work was started. In the
future, it can be switched to use system packages instead. future, it can be switched to use system packages instead.
@@ -35,11 +35,11 @@ This file is several gigabytes in size, but only a single directory inside is
needed: Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.7.sdk needed: Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.7.sdk
Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file. Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file.
To create a tarball suitable for gitian input, mount the dmg in OSX, then create it with: To create a tarball suitable for Gitian input, mount the dmg in OS X, then create it with:
$ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.7.sdk.tar.gz MacOSX10.7.sdk $ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.7.sdk.tar.gz MacOSX10.7.sdk
The gitian descriptors build 2 sets of files: Linux tools, then Apple binaries The Gitian descriptors build 2 sets of files: Linux tools, then Apple binaries
which are created using these tools. The build process has been designed to which are created using these tools. The build process has been designed to
avoid including the SDK's files in Gitian's outputs. All interim tarballs are avoid including the SDK's files in Gitian's outputs. All interim tarballs are
fully deterministic and may be freely redistributed. fully deterministic and may be freely redistributed.
@@ -63,20 +63,20 @@ Ideally, the creation could be fixed and genisoimage would no longer be necessar
Background images and other features can be added to DMG files by inserting a Background images and other features can be added to DMG files by inserting a
.DS_Store before creation. The easiest way to create this file is to build a .DS_Store before creation. The easiest way to create this file is to build a
DMG without one, move it to a device running OSX, customize the layout, then DMG without one, move it to a device running OS X, customize the layout, then
grab the .DS_Store file for later use. That is the approach taken here. grab the .DS_Store file for later use. That is the approach taken here.
As of OSX Mavericks (10.9), using an Apple-blessed key to sign binaries is a As of OS X Mavericks (10.9), using an Apple-blessed key to sign binaries is a
requirement in order to satisfy the new Gatekeeper requirements. Because this requirement in order to satisfy the new Gatekeeper requirements. Because this
private key cannot be shared, we'll have to be a bit creative in order for the private key cannot be shared, we'll have to be a bit creative in order for the
build process to remain somewhat deterministic. Here's how it works: build process to remain somewhat deterministic. Here's how it works:
- Builders use gitian to create an unsigned release. This outputs an unsigned - Builders use Gitian to create an unsigned release. This outputs an unsigned
dmg which users may choose to bless and run. It also outputs an unsigned app dmg which users may choose to bless and run. It also outputs an unsigned app
structure in the form of a tarball, which also contains all of the tools structure in the form of a tarball, which also contains all of the tools
that have been previously (deterministically) built in order to create a that have been previously (deterministically) built in order to create a
final dmg. final dmg.
- The Apple keyholder uses this unsigned app to create a detached signature, - The Apple keyholder uses this unsigned app to create a detached signature,
using the script that is also included there. using the script that is also included there.
- Builders feed the unsigned app + detached signature back into gitian. It - Builders feed the unsigned app + detached signature back into Gitian. It
uses the pre-built tools to recombine the pieces into a deterministic dmg. uses the pre-built tools to recombine the pieces into a deterministic dmg.

10
doc/build-osx.md
View File

@@ -1,6 +1,6 @@
Mac OS X Build Instructions and Notes Mac OS X Build Instructions and Notes
==================================== ====================================
This guide will show you how to build bitcoind(headless client) for OSX. This guide will show you how to build bitcoind(headless client) for OS X.
Notes Notes
----- -----
@@ -13,8 +13,8 @@ built-in one is located in `/Applications/Utilities`.
Preparation Preparation
----------- -----------
You need to install XCode with all the options checked so that the compiler You need to install Xcode with all the options checked so that the compiler
and everything is available in /usr not just /Developer. XCode should be and everything is available in /usr not just /Developer. Xcode should be
available on your OS X installation media, but if not, you can get the available on your OS X installation media, but if not, you can get the
current version from https://developer.apple.com/xcode/. If you install current version from https://developer.apple.com/xcode/. If you install
Xcode 4.3 or later, you'll need to install its command line tools. This can Xcode 4.3 or later, you'll need to install its command line tools. This can
@@ -65,7 +65,7 @@ After exiting, you'll get a warning that the install is keg-only, which means it
### Building `bitcoind` ### Building `bitcoind`
1. Clone the github tree to get the source code and go into the directory. 1. Clone the GitHub tree to get the source code and go into the directory.
git clone https://github.com/bitcoin/bitcoin.git git clone https://github.com/bitcoin/bitcoin.git
cd bitcoin cd bitcoin
@@ -89,7 +89,7 @@ Use Qt Creator as IDE
You can use Qt Creator as IDE, for debugging and for manipulating forms, etc. You can use Qt Creator as IDE, for debugging and for manipulating forms, etc.
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). 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).
1. Make sure you installed everything through homebrew mentioned above 1. Make sure you installed everything through Homebrew mentioned above
2. Do a proper ./configure --with-gui=qt5 --enable-debug 2. Do a proper ./configure --with-gui=qt5 --enable-debug
3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project 3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
4. Enter "bitcoin-qt" as project name, enter src/qt as location 4. Enter "bitcoin-qt" as project name, enter src/qt as location

30
doc/gitian-building.md
View File

@@ -1,7 +1,7 @@
Gitian building Gitian building
================ ================
*Setup instructions for a gitian build of Bitcoin using a Debian VM or physical system.* *Setup instructions for a Gitian build of Bitcoin using a Debian VM or physical system.*
Gitian is the deterministic build process that is used to build the Bitcoin Gitian is the deterministic build process that is used to build the Bitcoin
Core executables. It provides a way to be reasonably sure that the Core executables. It provides a way to be reasonably sure that the
@@ -13,7 +13,7 @@ Multiple developers build the source code by following a specific descriptor
These results are compared and only if they match, the build is accepted and uploaded These results are compared and only if they match, the build is accepted and uploaded
to bitcoin.org. to bitcoin.org.
More independent gitian builders are needed, which is why I wrote this More independent Gitian builders are needed, which is why I wrote this
guide. It is preferred to follow these steps yourself instead of using someone else's guide. It is preferred to follow these steps yourself instead of using someone else's
VM image to avoid 'contaminating' the build. VM image to avoid 'contaminating' the build.
@@ -22,9 +22,9 @@ Table of Contents
- [Create a new VirtualBox VM](#create-a-new-virtualbox-vm) - [Create a new VirtualBox VM](#create-a-new-virtualbox-vm)
- [Connecting to the VM](#connecting-to-the-vm) - [Connecting to the VM](#connecting-to-the-vm)
- [Setting up Debian for gitian building](#setting-up-debian-for-gitian-building) - [Setting up Debian for Gitian building](#setting-up-debian-for-gitian-building)
- [Installing gitian](#installing-gitian) - [Installing Gitian](#installing-gitian)
- [Setting up gitian images](#setting-up-gitian-images) - [Setting up Gitian images](#setting-up-gitian-images)
- [Getting and building the inputs](#getting-and-building-the-inputs) - [Getting and building the inputs](#getting-and-building-the-inputs)
- [Building Bitcoin](#building-bitcoin) - [Building Bitcoin](#building-bitcoin)
- [Building an alternative repository](#building-an-alternative-repository) - [Building an alternative repository](#building-an-alternative-repository)
@@ -217,7 +217,7 @@ Replace `root` with `debian` to log in as user.
[1] http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html [1] http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
[2] http://winscp.net/eng/index.php [2] http://winscp.net/eng/index.php
Setting up Debian for gitian building Setting up Debian for Gitian building
-------------------------------------- --------------------------------------
In this section we will be setting up the Debian installation for Gitian building. In this section we will be setting up the Debian installation for Gitian building.
@@ -237,7 +237,7 @@ Then set up LXC and the rest with the following, which is a complex jumble of se
```bash ```bash
# the version of lxc-start in Debian 7.4 needs to run as root, so make sure # the version of lxc-start in Debian 7.4 needs to run as root, so make sure
# that the build script can exectute it without providing a password # that the build script can execute it without providing a password
echo "%sudo ALL=NOPASSWD: /usr/bin/lxc-start" > /etc/sudoers.d/gitian-lxc echo "%sudo ALL=NOPASSWD: /usr/bin/lxc-start" > /etc/sudoers.d/gitian-lxc
# add cgroup for LXC # add cgroup for LXC
echo "cgroup /sys/fs/cgroup cgroup defaults 0 0" >> /etc/fstab echo "cgroup /sys/fs/cgroup cgroup defaults 0 0" >> /etc/fstab
@@ -257,7 +257,7 @@ reboot
At the end the VM is rebooted to make sure that the changes take effect. The steps in this At the end the VM is rebooted to make sure that the changes take effect. The steps in this
section need only to be performed once. section need only to be performed once.
Installing gitian Installing Gitian
------------------ ------------------
Re-login as the user `debian` that was created during installation. Re-login as the user `debian` that was created during installation.
@@ -277,7 +277,7 @@ cd ..
**Note**: When sudo asks for a password, enter the password for the user *debian* not for *root*. **Note**: When sudo asks for a password, enter the password for the user *debian* not for *root*.
Clone the git repositories for bitcoin and gitian and then checkout the bitcoin version that you want to build. Clone the git repositories for bitcoin and Gitian and then checkout the bitcoin version that you want to build.
```bash ```bash
git clone https://github.com/devrandom/gitian-builder.git git clone https://github.com/devrandom/gitian-builder.git
@@ -287,7 +287,7 @@ git checkout v${VERSION}
cd .. cd ..
``` ```
Setting up gitian images Setting up Gitian images
------------------------- -------------------------
Gitian needs virtual images of the operating system to build in. Gitian needs virtual images of the operating system to build in.
@@ -313,13 +313,13 @@ Getting and building the inputs
Follow the instructions in [doc/release-process.md](release-process.md) in the bitcoin repository Follow the instructions in [doc/release-process.md](release-process.md) in the bitcoin repository
under 'Fetch and build inputs' to install sources which require manual intervention. Also follow under 'Fetch and build inputs' to install sources which require manual intervention. Also follow
the next step: 'Seed the Gitian sources cache', which will fetch all necessary source files allowing the next step: 'Seed the Gitian sources cache', which will fetch all necessary source files allowing
for gitian to work offline. for Gitian to work offline.
Building Bitcoin Building Bitcoin
---------------- ----------------
To build Bitcoin (for Linux, OSX and Windows) just follow the steps under 'perform To build Bitcoin (for Linux, OS X and Windows) just follow the steps under 'perform
gitian builds' in [doc/release-process.md](release-process.md) in the bitcoin repository. Gitian builds' in [doc/release-process.md](release-process.md) in the bitcoin repository.
This may take a long time as it also builds the dependencies needed for each descriptor. This may take a long time as it also builds the dependencies needed for each descriptor.
These dependencies will be cached after a successful build to avoid rebuilding them when possible. These dependencies will be cached after a successful build to avoid rebuilding them when possible.
@@ -358,7 +358,7 @@ Building an alternative repository
----------------------------------- -----------------------------------
If you want to do a test build of a pull on GitHub it can be useful to point If you want to do a test build of a pull on GitHub it can be useful to point
the gitian builder at an alternative repository, using the same descriptors the Gitian builder at an alternative repository, using the same descriptors
and inputs. and inputs.
For example: For example:
@@ -388,7 +388,7 @@ in `gitian.sigs` to your signing machine and do
``` ```
This will create the `.sig` files that can be committed together with the `.assert` files to assert your This will create the `.sig` files that can be committed together with the `.assert` files to assert your
gitian build. Gitian build.
Uploading signatures Uploading signatures
--------------------- ---------------------

4
doc/init.md
View File

@@ -34,7 +34,6 @@ generate one from the shell yourself like this:
bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo' bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'
Once you have a password in hand, set rpcpassword= in /etc/bitcoin/bitcoin.conf
For an example configuration file that describes the configuration settings, For an example configuration file that describes the configuration settings,
see contrib/debian/examples/bitcoin.conf. see contrib/debian/examples/bitcoin.conf.
@@ -81,7 +80,7 @@ Drop bitcoind.conf in /etc/init. Test by running "service bitcoind start"
it will automatically start on reboot. it will automatically start on reboot.
NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they
use old versions of Upstart and do not supply the start-stop-daemon uitility. use old versions of Upstart and do not supply the start-stop-daemon utility.
5. Auto-respawn 5. Auto-respawn
----------------------------------- -----------------------------------
@@ -89,4 +88,3 @@ use old versions of Upstart and do not supply the start-stop-daemon uitility.
Auto respawning is currently only configured for Upstart and systemd. Auto respawning is currently only configured for Upstart and systemd.
Reasonable defaults have been chosen but YMMV. Reasonable defaults have been chosen but YMMV.

24
doc/release-process.md
View File

@@ -23,15 +23,15 @@ Release Process
* * * * * *
###update gitian ###update Gitian
In order to take advantage of the new caching features in gitian, be sure to update to a recent version (e9741525c or higher is recommended) In order to take advantage of the new caching features in Gitian, be sure to update to a recent version (e9741525c or higher is recommended)
###perform gitian builds ###perform Gitian builds
From a directory containing the bitcoin source, gitian-builder and gitian.sigs From a directory containing the bitcoin source, gitian-builder and gitian.sigs
export SIGNER=(your gitian key, ie bluematt, sipa, etc) export SIGNER=(your Gitian key, ie bluematt, sipa, etc)
export VERSION=(new version, e.g. 0.8.0) export VERSION=(new version, e.g. 0.8.0)
pushd ./bitcoin pushd ./bitcoin
git checkout v${VERSION} git checkout v${VERSION}
@@ -42,7 +42,7 @@ Release Process
mkdir -p inputs mkdir -p inputs
Register and download the Apple SDK: (see OSX Readme for details) Register and download the Apple SDK: (see OS X Readme for details)
https://developer.apple.com/downloads/download.action?path=Developer_Tools/xcode_4.6.3/xcode4630916281a.dmg https://developer.apple.com/downloads/download.action?path=Developer_Tools/xcode_4.6.3/xcode4630916281a.dmg
@@ -52,7 +52,7 @@ Release Process
###Optional: Seed the Gitian sources cache ###Optional: Seed the Gitian sources cache
By default, gitian will fetch source files as needed. For offline builds, they can be fetched ahead of time: By default, Gitian will fetch source files as needed. For offline builds, they can be fetched ahead of time:
make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common
@@ -76,8 +76,8 @@ Release Process
1. source tarball (bitcoin-${VERSION}.tar.gz) 1. source tarball (bitcoin-${VERSION}.tar.gz)
2. linux 32-bit and 64-bit binaries dist tarballs (bitcoin-${VERSION}-linux[32|64].tar.gz) 2. linux 32-bit and 64-bit binaries dist tarballs (bitcoin-${VERSION}-linux[32|64].tar.gz)
3. windows 32-bit and 64-bit installers and dist zips (bitcoin-${VERSION}-win[32|64]-setup.exe, bitcoin-${VERSION}-win[32|64].zip) 3. windows 32-bit and 64-bit installers and dist zips (bitcoin-${VERSION}-win[32|64]-setup.exe, bitcoin-${VERSION}-win[32|64].zip)
4. OSX unsigned installer (bitcoin-${VERSION}-osx-unsigned.dmg) 4. OS X unsigned installer (bitcoin-${VERSION}-osx-unsigned.dmg)
5. Gitian signatures (in gitian.sigs/${VERSION}-<linux|win|osx-unsigned>/(your gitian key)/ 5. Gitian signatures (in gitian.sigs/${VERSION}-<linux|win|osx-unsigned>/(your Gitian key)/
###Next steps: ###Next steps:
@@ -91,11 +91,11 @@ Commit your signature to gitian.sigs:
git push # Assuming you can push to the gitian.sigs tree git push # Assuming you can push to the gitian.sigs tree
popd popd
Wait for OSX detached signature: Wait for OS X detached signature:
Once the OSX build has 3 matching signatures, Gavin will sign it with the apple App-Store key. Once the OS X build has 3 matching signatures, Gavin will sign it with the apple App-Store key.
He will then upload a detached signature to be combined with the unsigned app to create a signed binary. He will then upload a detached signature to be combined with the unsigned app to create a signed binary.
Create the signed OSX binary: Create the signed OS X binary:
pushd ./gitian-builder pushd ./gitian-builder
# Fetch the signature as instructed by Gavin # Fetch the signature as instructed by Gavin
@@ -105,7 +105,7 @@ Commit your signature to gitian.sigs:
mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg
popd popd
Commit your signature for the signed OSX binary: Commit your signature for the signed OS X binary:
pushd gitian.sigs pushd gitian.sigs
git add ${VERSION}-osx-signed/${SIGNER} git add ${VERSION}-osx-signed/${SIGNER}

1
doc/tor.md
View File

@@ -82,4 +82,3 @@ If you only want to use Tor to reach onion addresses, but not use it as a proxy
for normal IPv4/IPv6 communication, use: for normal IPv4/IPv6 communication, use:
./bitcoin -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover ./bitcoin -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover