From 30074f7a8106c90670261e1e27936566f8e71634 Mon Sep 17 00:00:00 2001 From: ckti Date: Fri, 6 Sep 2019 16:42:47 +0100 Subject: [PATCH] Update docs to point to ioncoincore Spelling error --- gitian-building.md | 42 +++++++++---------- gitian-building/gitian-building-mac-os-sdk.md | 4 +- gitian-building/gitian-building-manual.md | 24 +++++------ .../gitian-building-setup-gitian-bionic.md | 8 ++-- .../gitian-building-setup-gitian-debian.md | 12 +++--- .../gitian-building-setup-gitian-fedora.md | 12 +++--- 6 files changed, 51 insertions(+), 51 deletions(-) diff --git a/gitian-building.md b/gitian-building.md index cdb8eab..0026713 100644 --- a/gitian-building.md +++ b/gitian-building.md @@ -1,7 +1,7 @@ Gitian building ================ -*Setup instructions for a Gitian build of Bitcoin Core using a VM or physical system.* +*Setup instructions for a Gitian build of Ioncoin Core using a VM or physical system.* 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 @@ -61,7 +61,7 @@ You can check the version with `lxc-execute --version`. 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. ## Non-Debian / Ubuntu, Manual and Offline Building -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). +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). ## MacOS code signing 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,22 +70,22 @@ In order to sign builds for MacOS, you need to download the free SDK and extract The `gitian-build.py` script will checkout different release tags, so it's best to copy it: ```bash -cp bitcoin/contrib/gitian-build.py . +cp ion/contrib/gitian-build.py . ``` You only need to do this once: ``` -./gitian-build.py --setup satoshi 0.17.0rc1 +./gitian-build.py --setup ``` -Where `satoshi` is your Github name and `0.17.0rc1` is the most recent tag (without `v`). +Where `pgp key` is your pgp key and `version` is the most recent tag (without `v`). 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: ``` -git clone git@github.com:bitcoin-core/gitian.sigs.git -git remote add satoshi git@github.com:satoshi/gitian.sigs.git +git clone git@github.com:ioncoincore/gitian.sigs.git +git remote add ion-sigs git@github.com:/gitian.sigs.git ``` ## Build binaries @@ -93,7 +93,7 @@ Windows and OSX have code signed binaries, but those won't be available until a ### To build the most recent tag: - `./gitian-build.py --detach-sign --no-commit -b satoshi 0.17.0rc1` + `./gitian-build.py --detach-sign --no-commit -b ` 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. @@ -102,29 +102,29 @@ If all went well, this produces a number of (uncommited) `.assert` files in the You need to copy these uncommited changes to your host machine, where you can sign them: ``` -export NAME=satoshi -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 -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 -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 +export NAME= +gpg --output $VERSION-linux/$NAME/ion-linux--build.assert.sig --detach-sign -linux/$NAME/ion-linux--build.assert +gpg --output $VERSION-osx-unsigned/$NAME/ion-osx--build.assert.sig --detach-sign -osx-unsigned/$NAME/ion-osx--build.assert +gpg --output $VERSION-win-unsigned/$NAME/ion-win--build.assert.sig --detach-sign -win-unsigned/$NAME/ion-win--build.assert ``` ### Make pull request Make a PR (both the `.assert` and `.assert.sig` files) to the -[bitcoin-core/gitian.sigs](https://github.com/bitcoin-core/gitian.sigs/) repository: +[ioncoincore/gitian.sigs](https://github.com/ioncoincore/gitian.sigs/) repository: ``` -git checkout -b 0.17.0rc1-not-codesigned -git commit -S -a -m "Add $NAME 0.17.0rc non-code signed signatures" -git push --set-upstream $NAME 0.17.0rc1 +git checkout -b -not-codesigned +git commit -S -a -m "Add $NAME non-code signed signatures" +git push --set-upstream $NAME 1 ``` ### Email files -You can also mail the files to Wladimir (laanwj@gmail.com) and he will commit them. +You can also mail the files to the Devs (ioncoincore@gmail.com) and they will commit them. ```bash - gpg --detach-sign ${VERSION}-linux/${SIGNER}/bitcoin-linux-*-build.assert - gpg --detach-sign ${VERSION}-win-unsigned/${SIGNER}/bitcoin-win-*-build.assert - gpg --detach-sign ${VERSION}-osx-unsigned/${SIGNER}/bitcoin-osx-*-build.assert + gpg --detach-sign ${VERSION}-linux/${SIGNER}/ion-linux-*-build.assert + gpg --detach-sign ${VERSION}-win-unsigned/${SIGNER}/ion-win-*-build.assert + gpg --detach-sign ${VERSION}-osx-unsigned/${SIGNER}/ion-osx-*-build.assert ``` ### Other .assert files @@ -134,6 +134,6 @@ This will create the `.sig` files that can be committed together with the `.asse Gitian build. - `./gitian-build.py --detach-sign -s satoshi 0.17.0rc1 --nocommit` + `./gitian-build.py --detach-sign -s --nocommit` Make another pull request for these. diff --git a/gitian-building/gitian-building-mac-os-sdk.md b/gitian-building/gitian-building-mac-os-sdk.md index 97a1566..57572a3 100755 --- a/gitian-building/gitian-building-mac-os-sdk.md +++ b/gitian-building/gitian-building-mac-os-sdk.md @@ -29,7 +29,7 @@ Non-MacOS host: -------- Alternatively, you can use 7zip and SleuthKit to extract the files one by one. -The script [extract-osx-sdk.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/macdeploy/extract-osx-sdk.sh) automates this. First ensure +The script [extract-osx-sdk.sh](https://github.com/ioncoincore/ion/blob/master/contrib/macdeploy/extract-osx-sdk.sh) automates this. First ensure the dmg file is in the current directory, and then run the script. 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 Troubleshooting --------------- -See [README_osx.md](https://github.com/bitcoin/bitcoin/blob/master/doc/README_osx.md) for troubleshooting tips. +See [README_osx.md](https://github.com/ioncoincore/ion/blob/master/doc/build-osx.md) for troubleshooting tips. diff --git a/gitian-building/gitian-building-manual.md b/gitian-building/gitian-building-manual.md index e2ed61f..1073210 100644 --- a/gitian-building/gitian-building-manual.md +++ b/gitian-building/gitian-building-manual.md @@ -2,12 +2,12 @@ Getting and building the inputs -------------------------------- - [Getting and building the inputs](#getting-and-building-the-inputs) -- [Building Bitcoin Core](#building-bitcoin-core) +- [Building Ioncoin Core](#building-ioncoin-core) - [Building an alternative repository](#building-an-alternative-repository) - [Building fully offline](#building-fully-offline) 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. -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. +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. 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) in the bitcoin repository under 'Fetch and create inputs' to install sources which require @@ -15,11 +15,11 @@ manual intervention. Also optionally follow the next step: 'Seed the Gitian sour and offline git repositories' which will fetch the remaining files required for building offline. -Building Bitcoin Core +Building Ioncoin Core ---------------- -To build Bitcoin Core (for Linux, OS X and Windows) just follow the steps under 'perform -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. +To build Ioncoin Core (for Linux, OS X and Windows) just follow the steps under 'perform +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. This may take some time as it will build all the dependencies needed for each descriptor. These dependencies will be cached after a successful build to avoid rebuilding them when possible. @@ -66,9 +66,9 @@ For example: ```bash URL=https://github.com/laanwj/bitcoin.git COMMIT=2014_03_windows_unicode_path -./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml -./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml -./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml +./bin/gbuild --commit ion=${COMMIT} --url ion=${URL} ../ion/contrib/gitian-descriptors/gitian-linux.yml +./bin/gbuild --commit ion=${COMMIT} --url ion=${URL} ../ion/contrib/gitian-descriptors/gitian-win.yml +./bin/gbuild --commit ion=${COMMIT} --url ion=${URL} ../ion/contrib/gitian-descriptors/gitian-osx.yml ``` Building fully offline @@ -114,10 +114,10 @@ Then when building, override the remote URLs that gbuild would otherwise pull fr ```bash cd /some/root/path/ -git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git +git clone https://github.com/ioncoincore/ion-detached-sigs.git -BTCPATH=/some/root/path/bitcoin -SIGPATH=/some/root/path/bitcoin-detached-sigs +BTCPATH=/some/root/path/ion +SIGPATH=/some/root/path/ion-detached-sigs -./bin/gbuild --url bitcoin=${BTCPATH},signature=${SIGPATH} ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml +./bin/gbuild --url ion=${BTCPATH},signature=${SIGPATH} ../ion/contrib/gitian-descriptors/gitian-win-signer.yml ``` diff --git a/gitian-building/gitian-building-setup-gitian-bionic.md b/gitian-building/gitian-building-setup-gitian-bionic.md index 4feedae..451ae01 100644 --- a/gitian-building/gitian-building-setup-gitian-bionic.md +++ b/gitian-building/gitian-building-setup-gitian-bionic.md @@ -54,13 +54,13 @@ Installing Gitian Re-login as the user `gitianuser` that was created during installation. The rest of the steps in this guide will be performed as that user. -Clone the git repositories for bitcoin and Gitian. +Clone the git repositories for ioncoin and Gitian. ```bash git clone https://github.com/devrandom/gitian-builder.git -git clone https://github.com/bitcoin/bitcoin -git clone https://github.com/bitcoin-core/gitian.sigs.git -git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git +git clone https://github.com/ioncoincore/ion +git clone https://github.com/ioncoincore/gitian.sigs.git +git clone https://github.com/ioncoincore/ion-detached-sigs.git ``` Setting up the Gitian image diff --git a/gitian-building/gitian-building-setup-gitian-debian.md b/gitian-building/gitian-building-setup-gitian-debian.md index 4764ca7..f45b5ca 100644 --- a/gitian-building/gitian-building-setup-gitian-debian.md +++ b/gitian-building/gitian-building-setup-gitian-debian.md @@ -67,13 +67,13 @@ cd .. **Note**: When sudo asks for a password, enter the password for the user `gitianuser` not for `root`. -Clone the git repositories for bitcoin and Gitian. +Clone the git repositories for ioncoin and Gitian. ```bash git clone https://github.com/devrandom/gitian-builder.git -git clone https://github.com/bitcoin/bitcoin -git clone https://github.com/bitcoin-core/gitian.sigs.git -git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git +git clone https://github.com/ioncoincore/ion +git clone https://github.com/ioncoincore/gitian.sigs.git +git clone https://github.com/ioncoincore/bitcoin-detached-sigs.git ``` Setting up the Gitian image @@ -90,8 +90,8 @@ Execute the following as user `gitianuser`: ```bash cd gitian-builder -bin/make-base-vm --lxc --arch amd64 --suite bionic # For releases after and including 0.17.0 -bin/make-base-vm --lxc --arch amd64 --suite trusty # For releases before 0.17.0 +bin/make-base-vm --lxc --arch amd64 --suite bionic # for versions 3.0.5 and above +bin/make-base-vm --lxc --arch amd64 --suite trusty # for versions below 3.0.5 ``` There will be a lot of warnings printed during the build of the image. These can be ignored. diff --git a/gitian-building/gitian-building-setup-gitian-fedora.md b/gitian-building/gitian-building-setup-gitian-fedora.md index 3421092..dbbbcd9 100644 --- a/gitian-building/gitian-building-setup-gitian-fedora.md +++ b/gitian-building/gitian-building-setup-gitian-fedora.md @@ -43,13 +43,13 @@ Installing Gitian Login as the user `gitianuser` that was created during installation. The rest of the steps in this guide will be performed as that user. -Clone the git repositories for bitcoin and Gitian. +Clone the git repositories for ioncoin and Gitian. ```bash git clone https://github.com/devrandom/gitian-builder.git -git clone https://github.com/bitcoin/bitcoin -git clone https://github.com/bitcoin-core/gitian.sigs.git -git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git +git clone https://github.com/ioncoincore/ion +git clone https://github.com/ioncoincore/gitian.sigs.git +git clone https://github.com/ioncoincore/bitcoin-detached-sigs.git ``` Setting up the Gitian image @@ -66,8 +66,8 @@ Execute the following as user `gitianuser`: ```bash cd gitian-builder -bin/make-base-vm --docker --arch amd64 --suite bionic # For releases after and including 0.17.0 -bin/make-base-vm --docker --arch amd64 --suite trusty # For releases before 0.17.0 +bin/make-base-vm --docker --arch amd64 --suite bionic # For releases after and including 3.0.5 +bin/make-base-vm --docker --arch amd64 --suite trusty # For releases before 3.0.5 ``` **Note**: When sudo asks for a password, enter the password for the user `gitianuser` not for `root`.