diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README | 95 | ||||
| -rw-r--r-- | doc/README_windows.txt | 9 | ||||
| -rw-r--r-- | doc/build-msw.txt | 16 | ||||
| -rw-r--r-- | doc/readme-qt.rst | 22 | ||||
| -rw-r--r-- | doc/release-process.txt | 135 |
5 files changed, 110 insertions, 167 deletions
diff --git a/doc/README b/doc/README index 789cc9fb87..01b1d40050 100644 --- a/doc/README +++ b/doc/README @@ -1,4 +1,4 @@ -Bitcoin 0.4.1 BETA +Bitcoin 0.5.0 BETA Copyright (c) 2009-2011 Bitcoin Developers Distributed under the MIT/X11 software license, see the accompanying @@ -19,99 +19,12 @@ with each other, with the help of a P2P network to check for double-spending. Setup ----- Unpack the files into a directory and run: - bin/32/bitcoin (GUI, 32-bit) + bin/32/bitcoin-qt (GUI, 32-bit) bin/32/bitcoind (headless, 32-bit) - bin/64/bitcoin (GUI, 64-bit) + bin/64/bitcoin-qt (GUI, 64-bit) bin/64/bitcoind (headless, 64-bit) -Wallet Encryption ------------------ -Bitcoin supports native wallet encryption so that people who steal your -wallet file don't automatically get access to all of your Bitcoins. -In order to enable this feature, chose "Encrypt Wallet" from the -Options menu. You will be prompted to enter a passphrase, which -will be used as the key to encrypt your wallet and will be needed -every time you wish to send Bitcoins. If you lose this passphrase, -you will lose access to spend all of the bitcoins in your wallet, -no one, not even the Bitcoin developers can recover your Bitcoins. -This means you are responsible for your own security, store your -passphrase in a secure location and do not forget it. - -Remember that the encryption built into bitcoin only encrypts the -actual keys which are required to send your bitcoins, not the full -wallet. This means that someone who steals your wallet file will -be able to see all the addresses which belong to you, as well as the -relevant transactions, you are only protected from someone spending -your coins. - -It is recommended that you backup your wallet file before you -encrypt your wallet. To do this, close the Bitcoin client and -copy the wallet.dat file from ~/.bitcoin/ on Linux, /Users/(user -name)/Application Support/Bitcoin/ on Mac OSX, and %APPDATA%/Bitcoin/ -on Windows (that is /Users/(user name)/AppData/Roaming/Bitcoin on -Windows Vista and 7 and /Documents and Settings/(user name)/Application -Data/Bitcoin on Windows XP). Once you have copied that file to a -safe location, reopen the Bitcoin client and Encrypt your wallet. -If everything goes fine, delete the backup and enjoy your encrypted -wallet. Note that once you encrypt your wallet, you will never be -able to go back to a version of the Bitcoin client older than 0.4. - -Keep in mind that you are always responsible for your own security. -All it takes is a slightly more advanced wallet-stealing trojan which -installs a keylogger to steal your wallet passphrase as you enter it -in addition to your wallet file and you have lost all your Bitcoins. -Wallet encryption cannot keep you safe if you do not practice -good security, such as running up-to-date antivirus software, only -entering your wallet passphrase in the Bitcoin client and using the -same passphrase only as your wallet passphrase. - - -Technical details of wallet encryption --------------------------------------- -Wallet encryption uses AES-256-CBC to encrypt only the private keys -that are held in a wallet. The keys are encrypted with a master key -which is entirely random. This master key is then encrypted with -AES-256-CBC with a key derived from the passphrase using SHA512 and -OpenSSL's EVP_BytesToKey and a dynamic number of rounds determined by -the speed of the machine which does the initial encryption (and is -updated based on the speed of a computer which does a subsequent -passphrase change). Although the underlying code supports multiple -encrypted copies of the same master key (and thus multiple passphrases) -the client does not yet have a method to add additional passphrases. - -At runtime, the client loads the wallet as it normally would, however -the keystore stores the keys in encrypted form. When the passphrase -is required (to top up keypool or send coins) it will either be queried -by a GUI prompt, or must first be entered with the walletpassphrase -RPC command. This will change the wallet to "unlocked" state where the -unencrypted master key is stored in memory (in the case of GUI, only for -long enough to complete the requested operation, in RPC, for as long as -is specified by the second parameter to walletpassphrase). The wallet is -then locked (or can be manually locked using the walletlock RPC command) -and the unencrypted master key is removed from memory. - -Implementation details of wallet encryption -------------------------------------------- -When the wallet is locked, calls to sendtoaddress, sendfrom, sendmany, -and keypoolrefill will return Error -13: "Error: Please enter the wallet -passphrase with walletpassphrase first." - -When the wallet is unlocked, calls to walletpassphrase will fail. - -When a wallet is encrypted, the passphrase is required to top up the -keypool, thus, if the passphrase is rarely entered, it is possible that -keypool might run out. In this case, the default key will be used as the -target for payouts for mining, and calls to getnewaddress and getaccount -address will return an error. In order to prevent such cases, the keypool -is automatically refilled when walletpassphrase is called with a correct -passphrase and when topupkeypool is called (while the wallet is unlocked). -Note that the keypool continues to be topped up on various occasions when -a new key from pool is used and the wallet is unlocked (or unencrypted). - - - See the documentation at the bitcoin wiki: https://en.bitcoin.it/wiki/Main_Page - -... for help and more information. +for help and more information. diff --git a/doc/README_windows.txt b/doc/README_windows.txt index 7ff8834920..ea2f14c42a 100644 --- a/doc/README_windows.txt +++ b/doc/README_windows.txt @@ -1,4 +1,4 @@ -Bitcoin 0.4.1 BETA
+Bitcoin 0.5.0 BETA
Copyright (c) 2009-2011 Bitcoin Developers
Distributed under the MIT/X11 software license, see the accompanying
@@ -18,7 +18,7 @@ with each other, with the help of a P2P network to check for double-spending. Setup
-----
-Unpack the files into a directory and run bitcoin.exe.
+Unpack the files into a directory and run bitcoin-qt.exe.
If you have Microsoft Security Essentials, you need to add bitcoin.exe to its
"Excluded processes" list. Microsoft Security Essentials->Settings tab,
@@ -27,8 +27,9 @@ select Excluded processes, press Add, select bitcoin.exe, OK, Save changes. The software automatically finds other nodes to connect to. You can
enable Universal Plug and Play using a menu entry or set your firewall
to forward port 8333 (TCP) to your computer so you can receive
-incoming connections. Bitcoin work without incoming connections,
+incoming connections. Bitcoin works without incoming connections,
but allowing incoming connections helps the Bitcoin network.
-See the bitcoin wiki at: https://en.bitcoin.it/wiki/Main_Page
+See the bitcoin wiki at:
+ https://en.bitcoin.it/wiki/Main_Page
for more help and information.
diff --git a/doc/build-msw.txt b/doc/build-msw.txt index f3150e086e..346be75f56 100644 --- a/doc/build-msw.txt +++ b/doc/build-msw.txt @@ -15,14 +15,8 @@ WINDOWS BUILD NOTES Compilers Supported ------------------- -MinGW GCC http://tdm-gcc.tdragon.net/ - TDM-GCC with gcc 4.5.1 was used to build this release. -MSYS 1.0.11 was also used (sh needed to compile some dependencies) - - -Candidate releases were built with MSVC 10.0 (2010), but -compiling with Visual C++ caused rendering artifacts when -bitcoin was run. +TODO: What works? +Note: releases are cross-compiled using mingw running on Linux. Dependencies @@ -42,7 +36,7 @@ Boost MIT-like license miniupnpc New (3-clause) BSD license Versions used in this release: -OpenSSL 1.0.0d +OpenSSL 1.0.0e Berkeley DB 4.8.30.NC Boost 1.47.0 miniupnpc 1.6 @@ -54,7 +48,7 @@ MSYS shell: un-tar sources with MSYS 'tar xfz' to avoid issue with symlinks (OpenSSL ticket 2377) change 'MAKE' env. variable from 'C:\MinGW32\bin\mingw32-make.exe' to '/c/MinGW32/bin/mingw32-make.exe' -cd /c/openssl-1.0.0d-mgw +cd /c/openssl-1.0.0e-mgw ./config make @@ -86,5 +80,5 @@ Bitcoin ------- DOS prompt: cd \bitcoin\src -mingw32-make bitcoind.exe -f makefile.mingw +mingw32-make -f makefile.mingw strip bitcoind.exe diff --git a/doc/readme-qt.rst b/doc/readme-qt.rst index b7f0d2c1f8..090177321e 100644 --- a/doc/readme-qt.rst +++ b/doc/readme-qt.rst @@ -1,5 +1,5 @@ -Bitcoin-qt: Qt4 based GUI replacement for Bitcoin -================================================= +Bitcoin-qt: Qt4 GUI for Bitcoin +=============================== Features ======== @@ -150,7 +150,7 @@ Berkely DB version warning A warning for people using the *static binary* version of Bitcoin on a Linux/UNIX-ish system (tl;dr: **Berkely DB databases are not forward compatible**). -The static binary version of Bitcoin is linked against libdb4.7 or libdb4.8 (see also `this Debian issue`_). +The static binary version of Bitcoin is linked against libdb4.8 (see also `this Debian issue`_). Now the nasty thing is that databases from 5.X are not compatible with 4.X. @@ -160,3 +160,19 @@ and 4.X cannot open the new format. This means that you cannot go back to the ol significant hassle! .. _`this Debian issue`: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=621425 + +Ubuntu 11.10 warning +==================== + +Ubuntu 11.10 has a package called 'qt-at-spi' installed by default. At the time of writing, having that package +installed causes bitcoin-qt to crash intermittently. The issue has been reported as `launchpad bug 857790`_, but +isn't yet fixed. + +Until the bug is fixed, you can remove the qt-at-spi package to work around the problem, though this will presumably +disable screen reader functionality for Qt apps: + +:: + + sudo apt-get remove qt-at-spi + +.. _`launchpad bug 857790`: https://bugs.launchpad.net/ubuntu/+source/qt-at-spi/+bug/857790 diff --git a/doc/release-process.txt b/doc/release-process.txt index 4d06627006..f0e1ca28ca 100644 --- a/doc/release-process.txt +++ b/doc/release-process.txt @@ -5,38 +5,53 @@ * update (commit) version in OSX app bundle contrib/Bitcoin.app/Contents/Info.plist - * CFBundleShortVersionString should have value like 0.3.23 - * CFBundleVersion should have value like 323 + * CFBundleShortVersionString should have value like 0.5.0 + * CFBundleVersion should have value like 500 * tag version in git - $ git tag -a v0.3.23 + git tag -a v0.5.0 * write release notes. git shortlog helps a lot: - $ git shortlog --no-merges v0.3.22.. + git shortlog --no-merges v0.4.0.. * create source-only archive - $ git archive --format=tar --prefix=bitcoin-0.3.23/ HEAD | \ - gzip -9c > ~/tmp/bitcoin-0.3.23-src.tar.gz + git archive --format=tar --prefix=bitcoin-0.5.0/ HEAD | \ + gzip -9c > ~/tmp/bitcoin-0.5.0-src.tar.gz * perform gitian builds * From a directory containing the bitcoin source, gitian-builder and gitian.sigs - $ export VERSION=0.3.23 - $ cd ./gitian-builder - $ ./bin/gbuild --commit bitcoin=v$VERSION ../bitcoin/contrib/gitian-descriptors/gitian.yml - $ ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml - $ cd build/out - $ zip bitcoin-$VERSION-linux-gitian.zip * - $ mv bitcoin-$VERSION-linux-gitian.zip ../../ - $ ./bin/gbuild --commit bitcoin=v$VERSION ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml - $ ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION-win32 --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml - $ cd build/out - $ zip bitcoin-$VERSION-win32-gitian.zip * - $ mv bitcoin-$VERSION-win32-gitian.zip ../../ - + export VERSION=0.5.0 + cd ./gitian-builder + + * Fetch and build inputs: + mkdir -p inputs; cd inputs/ + wget 'http://miniupnp.free.fr/files/download.php?file=miniupnpc-1.6.tar.gz' -O miniupnpc-1.6.tar.gz + wget 'http://www.openssl.org/source/openssl-1.0.0e.tar.gz' + wget 'http://download.oracle.com/berkeley-db/db-4.8.30.NC.tar.gz' + wget 'http://downloads.sourceforge.net/project/boost/boost/1.47.0/boost_1_47_0.tar.bz2' + wget 'http://download.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.4.tar.gz' + cd .. + ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-win32.yml + cp build/out/boost-win32-1.47.0-gitian.zip inputs/ + ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/qt-win32.yml + cp build/out/qt-win32-4.7.4-gitian.zip inputs/ + + * Build bitcoind and bitcoin-qt on Linux32, Linux64, and Win32: + ./bin/gbuild --commit bitcoin=v$VERSION ../bitcoin/contrib/gitian-descriptors/gitian.yml + ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml + cd build/out + zip bitcoin-$VERSION-linux-gitian.zip * + mv bitcoin-$VERSION-linux-gitian.zip ../../ + ./bin/gbuild --commit bitcoin=v$VERSION ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml + ./bin/gsign --signer (your gitian key, ie bluematt, sipa, etc) --release $VERSION-win32 --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml + cd build/out + zip bitcoin-$VERSION-win32-gitian.zip * + mv bitcoin-$VERSION-win32-gitian.zip ../../ + Build output expected: 1. linux 32-bit and 64-bit binaries + source (bitcoin-$VERSION-linux-gitian.zip) 2. windows 32-bit binary, installer + source (bitcoin-$VERSION-win32-gitian.zip) @@ -44,26 +59,30 @@ * repackage gitian builds for release as stand-alone zip/tar/installer exe + * Linux .tar.gz: + mkdir bitcoin-$VERSION-linux + cd bitcoin-$VERSION-linux + unzip bitcoin-$VERSION-linux-gitian.zip + cd ..; tar czvf bitcoin-$VERSION-linux.tar.gz bitcoin-$VERSION-linux + * Windows .zip and setup.exe: - $ mkdir bitcoin-$VERSION-win32 - $ cd bitcoin-$VERSION-win32 - $ unzip bitcoin-$VERSION-win32-gitian.zip - $ mv bitcoin-$VERSION-win32-setup.exe .. - $ cd ..; zip bitcoin-$VERSION-win32.zip bitcoin-$VERSION-win32 + mkdir bitcoin-$VERSION-win32 + cd bitcoin-$VERSION-win32 + unzip bitcoin-$VERSION-win32-gitian.zip + mv bitcoin-$VERSION-win32-setup.exe .. + cd ..; zip bitcoin-$VERSION-win32.zip bitcoin-$VERSION-win32 - * Linux .tar.gz: - $ mkdir bitcoin-$VERSION-linux - $ cd bitcoin-$VERSION-linux - $ unzip bitcoin-$VERSION-linux-gitian.zip - $ cd ..; tar czvf bitcoin-$VERSION-linux.tar.gz bitcoin-$VERSION-linux * perform Mac build - * From the bitcoin source dir - $ cd contrib - $ ./create_osx_dmg.sh - $ mv Bitcoin.dmg bitcoin-$VERSION-macosx.dmg + qmake USE_SSL=1 USE_UPNP=1 bitcoin-qt.pro + make + export QTDIR=/opt/local/share/qt4 + contrib/macdeploy/macdeployqtplus Bitcoin-Qt.app -add-qt-tr de,ru -dmg -fancy contrib/macdeploy/fancy.plist + + Build output expected: + Bitcoin-Qt.dmg -* upload source and builds to SF +* upload source and builds to SourceForge * create SHA1SUMS for builds, and PGP-sign it @@ -80,29 +99,29 @@ * Collect enough gitian signatures to meet minimum_weight (see contrib/gitian-downloader/*-download-config) * From a directory containing bitcoin source, gitian.sigs and gitian zips - $ export VERSION=0.3.23 - $ mkdir bitcoin-$VERSION-win32-gitian; cd bitcoin-$VERSION-win32-gitian - $ unzip ../bitcoin-$VERSION-win32-gitian.zip - $ mkdir gitian - $ cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ - $ for file in `ls ../gitian.sigs/$VERSION-win32/`; do - $ cp ../gitian.sigs/$VERSION-win32/$file/bitcoin-build.assert ./gitian/$file-build.assert - $ cp ../gitian.sigs/$VERSION-win32/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig - $ done - $ zip bitcoin-$VERSION-win32-gitian.zip * - $ cp bitcoin-$VERSION-win32-gitian.zip ../ - $ cd .. - $ mkdir bitcoin-$VERSION-linux-gitian; cd bitcoin-$VERSION-linux-gitian - $ unzip ../bitcoin-$VERSION-linux-gitian.zip - $ mkdir gitian - $ cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ - $ for file in `ls ../gitian.sigs/$VERSION/`; do - $ cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert ./gitian/$file-build.assert - $ cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig - $ done - $ zip bitcoin-$VERSION-linux-gitian.zip * - $ cp bitcoin-$VERSION-linux-gitian.zip ../ - - * Upload gitian zips to SF + export VERSION=0.5.0 + mkdir bitcoin-$VERSION-linux-gitian; cd bitcoin-$VERSION-linux-gitian + unzip ../bitcoin-$VERSION-linux-gitian.zip + mkdir gitian + cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ + for file in `ls ../gitian.sigs/$VERSION/`; do + cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert ./gitian/$file-build.assert + cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig + done + zip bitcoin-$VERSION-linux-gitian.zip * + cp bitcoin-$VERSION-linux-gitian.zip ../ + cd .. + mkdir bitcoin-$VERSION-linux-gitian; cd bitcoin-$VERSION-linux-gitian + unzip ../bitcoin-$VERSION-linux-gitian.zip + mkdir gitian + cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ + for file in `ls ../gitian.sigs/$VERSION/`; do + cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert ./gitian/$file-build.assert + cp ../gitian.sigs/$VERSION/$file/bitcoin-build.assert.sig ./gitian/$file-build.assert.sig + done + zip bitcoin-$VERSION-linux-gitian.zip * + cp bitcoin-$VERSION-linux-gitian.zip ../ + + * Upload gitian zips to SourceForge |