Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 30074f7

Browse files
committedSep 7, 2019
Update docs to point to ioncoincore
Spelling error
1 parent 802f713 commit 30074f7

6 files changed

+51
-51
lines changed
 

‎gitian-building.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Gitian building
22
================
33

4-
*Setup instructions for a Gitian build of Bitcoin Core using a VM or physical system.*
4+
*Setup instructions for a Gitian build of Ioncoin Core using a VM or physical system.*
55

66
Gitian is the deterministic build process that is used to build the Bitcoin
77
Core executables. It provides a way to be reasonably sure that the
@@ -61,7 +61,7 @@ You can check the version with `lxc-execute --version`.
6161
On Debian you might have to compile a suitable version of lxc or you can use Ubuntu 18.04 or higher instead of Debian as the host.
6262

6363
## Non-Debian / Ubuntu, Manual and Offline Building
64-
The instructions below use the automated script [gitian-build.py](https://github.com/bitcoin/bitcoin/blob/master/contrib/gitian-build.py) which only works in Debian/Ubuntu. For manual steps and instructions for fully offline signing, see [this guide](./gitian-building/gitian-building-manual.md).
64+
The instructions below use the automated script [gitian-build.py](https://github.com/ioncoincore/ion/blob/master/contrib/gitian-build.py) which only works in Debian/Ubuntu. For manual steps and instructions for fully offline signing, see [this guide](./gitian-building/gitian-building-manual.md).
6565

6666
## MacOS code signing
6767
In order to sign builds for MacOS, you need to download the free SDK and extract a file. The steps are described [here](./gitian-building/gitian-building-mac-os-sdk.md). Alternatively, you can skip the OSX build by adding `--os=lw` below.
@@ -70,30 +70,30 @@ In order to sign builds for MacOS, you need to download the free SDK and extract
7070
The `gitian-build.py` script will checkout different release tags, so it's best to copy it:
7171

7272
```bash
73-
cp bitcoin/contrib/gitian-build.py .
73+
cp ion/contrib/gitian-build.py .
7474
```
7575

7676
You only need to do this once:
7777

7878
```
79-
./gitian-build.py --setup satoshi 0.17.0rc1
79+
./gitian-build.py --setup <pgp key> <version>
8080
```
8181

82-
Where `satoshi` is your Github name and `0.17.0rc1` is the most recent tag (without `v`).
82+
Where `pgp key` is your pgp key and `version` is the most recent tag (without `v`).
8383

8484
In order to sign gitian builds on your host machine, which has your PGP key, fork the gitian.sigs repository and clone it on your host machine:
8585

8686
```
87-
git clone git@github.com:bitcoin-core/gitian.sigs.git
88-
git remote add satoshi git@github.com:satoshi/gitian.sigs.git
87+
git clone git@github.com:ioncoincore/gitian.sigs.git
88+
git remote add ion-sigs git@github.com:<github username>/gitian.sigs.git
8989
```
9090

9191
## Build binaries
9292
Windows and OSX have code signed binaries, but those won't be available until a few developers have gitian signed the non-codesigned binaries.
9393

9494
### To build the most recent tag:
9595

96-
`./gitian-build.py --detach-sign --no-commit -b satoshi 0.17.0rc1`
96+
`./gitian-build.py --detach-sign --no-commit -b <pgp key> <version>`
9797

9898
To speed up the build, use `-j 5 -m 5000` as the first arguments, where `5` is the number of CPU's you allocated to the VM plus one, and 5000 is a little bit less than then the MB's of RAM you allocated.
9999

@@ -102,29 +102,29 @@ If all went well, this produces a number of (uncommited) `.assert` files in the
102102
You need to copy these uncommited changes to your host machine, where you can sign them:
103103

104104
```
105-
export NAME=satoshi
106-
gpg --output $VERSION-linux/$NAME/bitcoin-linux-0.17-build.assert.sig --detach-sign 0.17.0rc1-linux/$NAME/bitcoin-linux-0.17-build.assert
107-
gpg --output $VERSION-osx-unsigned/$NAME/bitcoin-osx-0.17-build.assert.sig --detach-sign 0.17.0rc1-osx-unsigned/$NAME/bitcoin-osx-0.17-build.assert
108-
gpg --output $VERSION-win-unsigned/$NAME/bitcoin-win-0.17-build.assert.sig --detach-sign 0.17.0rc1-win-unsigned/$NAME/bitcoin-win-0.17-build.assert
105+
export NAME=<github user name>
106+
gpg --output $VERSION-linux/$NAME/ion-linux-<version>-build.assert.sig --detach-sign <version>-linux/$NAME/ion-linux-<version>-build.assert
107+
gpg --output $VERSION-osx-unsigned/$NAME/ion-osx-<version>-build.assert.sig --detach-sign <version>-osx-unsigned/$NAME/ion-osx-<version>-build.assert
108+
gpg --output $VERSION-win-unsigned/$NAME/ion-win-<version>-build.assert.sig --detach-sign <version>-win-unsigned/$NAME/ion-win-<version>-build.assert
109109
```
110110

111111
### Make pull request
112112
Make a PR (both the `.assert` and `.assert.sig` files) to the
113-
[bitcoin-core/gitian.sigs](https://github.com/bitcoin-core/gitian.sigs/) repository:
113+
[ioncoincore/gitian.sigs](https://github.com/ioncoincore/gitian.sigs/) repository:
114114

115115
```
116-
git checkout -b 0.17.0rc1-not-codesigned
117-
git commit -S -a -m "Add $NAME 0.17.0rc non-code signed signatures"
118-
git push --set-upstream $NAME 0.17.0rc1
116+
git checkout -b <version>-not-codesigned
117+
git commit -S -a -m "Add $NAME <version> non-code signed signatures"
118+
git push --set-upstream $NAME <version>1
119119
```
120120

121121
### Email files
122-
You can also mail the files to Wladimir (laanwj@gmail.com) and he will commit them.
122+
You can also mail the files to the Devs (ioncoincore@gmail.com) and they will commit them.
123123

124124
```bash
125-
gpg --detach-sign ${VERSION}-linux/${SIGNER}/bitcoin-linux-*-build.assert
126-
gpg --detach-sign ${VERSION}-win-unsigned/${SIGNER}/bitcoin-win-*-build.assert
127-
gpg --detach-sign ${VERSION}-osx-unsigned/${SIGNER}/bitcoin-osx-*-build.assert
125+
gpg --detach-sign ${VERSION}-linux/${SIGNER}/ion-linux-*-build.assert
126+
gpg --detach-sign ${VERSION}-win-unsigned/${SIGNER}/ion-win-*-build.assert
127+
gpg --detach-sign ${VERSION}-osx-unsigned/${SIGNER}/ion-osx-*-build.assert
128128
```
129129

130130
### Other .assert files
@@ -134,6 +134,6 @@ This will create the `.sig` files that can be committed together with the `.asse
134134
Gitian build.
135135

136136

137-
`./gitian-build.py --detach-sign -s satoshi 0.17.0rc1 --nocommit`
137+
`./gitian-build.py --detach-sign -s <pgp key> <version> --nocommit`
138138

139139
Make another pull request for these.

‎gitian-building/gitian-building-mac-os-sdk.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Non-MacOS host:
2929
--------
3030

3131
Alternatively, you can use 7zip and SleuthKit to extract the files one by one.
32-
The script [extract-osx-sdk.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/macdeploy/extract-osx-sdk.sh) automates this. First ensure
32+
The script [extract-osx-sdk.sh](https://github.com/ioncoincore/ion/blob/master/contrib/macdeploy/extract-osx-sdk.sh) automates this. First ensure
3333
the dmg file is in the current directory, and then run the script.
3434

3535
You may wish to delete the intermediate 5.hfs file and MacOSX10.11.sdk (the directory) when
@@ -54,4 +54,4 @@ rm MacOSX10.11.sdk.tar.gz
5454

5555
Troubleshooting
5656
---------------
57-
See [README_osx.md](https://github.com/bitcoin/bitcoin/blob/master/doc/README_osx.md) for troubleshooting tips.
57+
See [README_osx.md](https://github.com/ioncoincore/ion/blob/master/doc/build-osx.md) for troubleshooting tips.

‎gitian-building/gitian-building-manual.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@ Getting and building the inputs
22
--------------------------------
33

44
- [Getting and building the inputs](#getting-and-building-the-inputs)
5-
- [Building Bitcoin Core](#building-bitcoin-core)
5+
- [Building Ioncoin Core](#building-ioncoin-core)
66
- [Building an alternative repository](#building-an-alternative-repository)
77
- [Building fully offline](#building-fully-offline)
88

99
At this point you have two options, you can either use the automated script (found in [https://github.com/bitcoin/bitcoin/blob/master/contrib/gitian-build.py](https://github.com/bitcoin/bitcoin/blob/master/contrib/gitian-build.py), only works in Debian/Ubuntu) or you could manually do everything by following this guide.
10-
If you are using the automated script, then run it with the `--setup` command. Afterwards, run it with the `--build` command (example: `contrib/gitian-build.py -b signer 0.17.0`). Otherwise ignore this.
10+
If you are using the automated script, then run it with the `--setup` command. Afterwards, run it with the `--build` command (example: `contrib/gitian-build.py -b signer 4.0.00`). Otherwise ignore this.
1111

1212
Follow the instructions in [https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md#fetch-and-create-inputs-first-time-or-when-dependency-versions-change)
1313
in the bitcoin repository under 'Fetch and create inputs' to install sources which require
1414
manual intervention. Also optionally follow the next step: 'Seed the Gitian sources cache
1515
and offline git repositories' which will fetch the remaining files required for building
1616
offline.
1717

18-
Building Bitcoin Core
18+
Building Ioncoin Core
1919
----------------
2020

21-
To build Bitcoin Core (for Linux, OS X and Windows) just follow the steps under 'perform
22-
Gitian builds' in [https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md#setup-and-perform-gitian-builds) in the bitcoin repository.
21+
To build Ioncoin Core (for Linux, OS X and Windows) just follow the steps under 'perform
22+
Gitian builds' in [https://github.com/ioncoin/ion/blob/master/doc/release-process.md](https://github.com/ioncoincore/ion/blob/master/doc/release-process.md#setup-and-perform-gitian-builds) in the ioncoincore repository.
2323

2424
This may take some time as it will build all the dependencies needed for each descriptor.
2525
These dependencies will be cached after a successful build to avoid rebuilding them when possible.
@@ -66,9 +66,9 @@ For example:
6666
```bash
6767
URL=https://github.com/laanwj/bitcoin.git
6868
COMMIT=2014_03_windows_unicode_path
69-
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
70-
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
71-
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
69+
./bin/gbuild --commit ion=${COMMIT} --url ion=${URL} ../ion/contrib/gitian-descriptors/gitian-linux.yml
70+
./bin/gbuild --commit ion=${COMMIT} --url ion=${URL} ../ion/contrib/gitian-descriptors/gitian-win.yml
71+
./bin/gbuild --commit ion=${COMMIT} --url ion=${URL} ../ion/contrib/gitian-descriptors/gitian-osx.yml
7272
```
7373

7474
Building fully offline
@@ -114,10 +114,10 @@ Then when building, override the remote URLs that gbuild would otherwise pull fr
114114
```bash
115115

116116
cd /some/root/path/
117-
git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git
117+
git clone https://github.com/ioncoincore/ion-detached-sigs.git
118118

119-
BTCPATH=/some/root/path/bitcoin
120-
SIGPATH=/some/root/path/bitcoin-detached-sigs
119+
BTCPATH=/some/root/path/ion
120+
SIGPATH=/some/root/path/ion-detached-sigs
121121

122-
./bin/gbuild --url bitcoin=${BTCPATH},signature=${SIGPATH} ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
122+
./bin/gbuild --url ion=${BTCPATH},signature=${SIGPATH} ../ion/contrib/gitian-descriptors/gitian-win-signer.yml
123123
```

‎gitian-building/gitian-building-setup-gitian-bionic.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ Installing Gitian
5454
Re-login as the user `gitianuser` that was created during installation.
5555
The rest of the steps in this guide will be performed as that user.
5656

57-
Clone the git repositories for bitcoin and Gitian.
57+
Clone the git repositories for ioncoin and Gitian.
5858

5959
```bash
6060
git clone https://github.com/devrandom/gitian-builder.git
61-
git clone https://github.com/bitcoin/bitcoin
62-
git clone https://github.com/bitcoin-core/gitian.sigs.git
63-
git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git
61+
git clone https://github.com/ioncoincore/ion
62+
git clone https://github.com/ioncoincore/gitian.sigs.git
63+
git clone https://github.com/ioncoincore/ion-detached-sigs.git
6464
```
6565

6666
Setting up the Gitian image

‎gitian-building/gitian-building-setup-gitian-debian.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ cd ..
6767

6868
**Note**: When sudo asks for a password, enter the password for the user `gitianuser` not for `root`.
6969

70-
Clone the git repositories for bitcoin and Gitian.
70+
Clone the git repositories for ioncoin and Gitian.
7171

7272
```bash
7373
git clone https://github.com/devrandom/gitian-builder.git
74-
git clone https://github.com/bitcoin/bitcoin
75-
git clone https://github.com/bitcoin-core/gitian.sigs.git
76-
git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git
74+
git clone https://github.com/ioncoincore/ion
75+
git clone https://github.com/ioncoincore/gitian.sigs.git
76+
git clone https://github.com/ioncoincore/bitcoin-detached-sigs.git
7777
```
7878

7979
Setting up the Gitian image
@@ -90,8 +90,8 @@ Execute the following as user `gitianuser`:
9090

9191
```bash
9292
cd gitian-builder
93-
bin/make-base-vm --lxc --arch amd64 --suite bionic # For releases after and including 0.17.0
94-
bin/make-base-vm --lxc --arch amd64 --suite trusty # For releases before 0.17.0
93+
bin/make-base-vm --lxc --arch amd64 --suite bionic # for versions 3.0.5 and above
94+
bin/make-base-vm --lxc --arch amd64 --suite trusty # for versions below 3.0.5
9595
```
9696

9797
There will be a lot of warnings printed during the build of the image. These can be ignored.

‎gitian-building/gitian-building-setup-gitian-fedora.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ Installing Gitian
4343
Login as the user `gitianuser` that was created during installation.
4444
The rest of the steps in this guide will be performed as that user.
4545

46-
Clone the git repositories for bitcoin and Gitian.
46+
Clone the git repositories for ioncoin and Gitian.
4747

4848
```bash
4949
git clone https://github.com/devrandom/gitian-builder.git
50-
git clone https://github.com/bitcoin/bitcoin
51-
git clone https://github.com/bitcoin-core/gitian.sigs.git
52-
git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git
50+
git clone https://github.com/ioncoincore/ion
51+
git clone https://github.com/ioncoincore/gitian.sigs.git
52+
git clone https://github.com/ioncoincore/bitcoin-detached-sigs.git
5353
```
5454

5555
Setting up the Gitian image
@@ -66,8 +66,8 @@ Execute the following as user `gitianuser`:
6666

6767
```bash
6868
cd gitian-builder
69-
bin/make-base-vm --docker --arch amd64 --suite bionic # For releases after and including 0.17.0
70-
bin/make-base-vm --docker --arch amd64 --suite trusty # For releases before 0.17.0
69+
bin/make-base-vm --docker --arch amd64 --suite bionic # For releases after and including 3.0.5
70+
bin/make-base-vm --docker --arch amd64 --suite trusty # For releases before 3.0.5
7171
```
7272

7373
**Note**: When sudo asks for a password, enter the password for the user `gitianuser` not for `root`.

0 commit comments

Comments
 (0)
Please sign in to comment.