aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/assets-attribution.txt13
-rw-r--r--doc/bitcoin_logo_doxygen.pngbin5735 -> 4757 bytes
-rw-r--r--doc/build-osx.md173
-rw-r--r--doc/build-osx.txt54
-rw-r--r--doc/coding.txt3
-rw-r--r--doc/multiwallet-qt.txt53
-rw-r--r--doc/release-process.txt17
7 files changed, 246 insertions, 67 deletions
diff --git a/doc/assets-attribution.txt b/doc/assets-attribution.txt
index 0693d535c3..abcb9d8b3a 100644
--- a/doc/assets-attribution.txt
+++ b/doc/assets-attribution.txt
@@ -1,5 +1,8 @@
Icon: src/qt/res/icons/clock*.png, src/qt/res/icons/tx*.png,
- src/qt/res/src/*.svg
+ src/qt/res/src/clock_green.svg, src/qt/res/src/clock1.svg
+ src/qt/res/src/clock2.svg, src/qt/res/src/clock3.svg
+ src/qt/res/src/clock4.svg, src/qt/res/src/clock5.svg
+ src/qt/res/src/inout.svg, src/qt/res/src/questionmark.svg
Designer: Wladimir van der Laan
License: MIT
@@ -35,7 +38,7 @@ Designer: http://www.everaldo.com
Icon Pack: Crystal SVG
License: LGPL
-Icon: src/qt/res/icons/bitcoin.png, src/qt/res/icons/toolbar.png
+Icon: src/qt/res/icons/toolbar.png
Designer: Bitboy (optimized for 16x16 by Wladimir van der Laan)
License: Public Domain
Site: https://bitcointalk.org/?topic=1756.0
@@ -55,3 +58,9 @@ Icon: src/qt/res/icons/debugwindow.png
Designer: Vignoni David
Site: http://www.oxygen-icons.org/
License: Oxygen icon theme is dual licensed. You may copy it under the Creative Common Attribution-ShareAlike 3.0 License or the GNU Library General Public License.
+
+Icon: src/qt/res/icons/bitcoin.icns, src/qt/res/src/bitcoin.svg,
+ src/qt/res/src/bitcoin.ico, src/qt/res/src/bitcoin.png,
+ src/qt/res/src/bitcoin_testnet.png, docs/bitcoin_logo_doxygen.png
+Designer: Jonas Schnelli (based on the original bitcoin logo from Bitboy)
+License: MIT \ No newline at end of file
diff --git a/doc/bitcoin_logo_doxygen.png b/doc/bitcoin_logo_doxygen.png
index 5b41b02e18..2d62a8dc8a 100644
--- a/doc/bitcoin_logo_doxygen.png
+++ b/doc/bitcoin_logo_doxygen.png
Binary files differ
diff --git a/doc/build-osx.md b/doc/build-osx.md
new file mode 100644
index 0000000000..1ed593d5eb
--- /dev/null
+++ b/doc/build-osx.md
@@ -0,0 +1,173 @@
+Mac OS X bitcoind build instructions
+====================================
+
+Authors
+-------
+
+* Laszlo Hanyecz <solar@heliacal.net>
+* Douglas Huff <dhuff@jrbobdobbs.org>
+* Colin Dean <cad@cad.cx>
+* Gavin Andresen <gavinandresen@gmail.com>
+
+License
+-------
+
+Copyright (c) 2009-2012 Bitcoin Developers
+
+Distributed under the MIT/X11 software license, see the accompanying
+file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+This product includes software developed by the OpenSSL Project for use in
+the OpenSSL Toolkit (http://www.openssl.org/).
+
+This product includes cryptographic software written by
+Eric Young (eay@cryptsoft.com) and UPnP software written by Thomas Bernard.
+
+Notes
+-----
+
+See `doc/readme-qt.rst` for instructions on building Bitcoin-Qt, the
+graphical user interface.
+
+Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not
+supported because it is big-endian.
+
+All of the commands should be executed in a Terminal application. The
+built-in one is located in `/Applications/Utilities`.
+
+Preparation
+-----------
+
+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
+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
+Xcode 4.3 or later, you'll need to install its command line tools. This can
+be done in `Xcode > Preferences > Downloads > Components` and generally must
+be re-done or updated every time Xcode is updated.
+
+There's an assumption that you already have `git` installed, as well. If
+not, it's the path of least resistance to install Github for Mac
+(OS X 10.7+) or
+[Git for OS X](https://code.google.com/p/git-osx-installer/). It is also
+available via Homebrew or MacPorts.
+
+You will also need to install [Homebrew](http://mxcl.github.com/homebrew/)
+or [MacPorts](http://www.macports.org/) in order to install library
+dependencies. It's largely a religious decision which to choose, but, as of
+December 2012, MacPorts is a little easier because you can just install the
+dependencies immediately - no other work required. If you're unsure, read
+the instructions through first in order to assess what you want to do.
+Homebrew is a little more popular among those newer to OS X.
+
+The installation of the actual dependencies is covered in the Instructions
+sections below.
+
+Instructions: MacPorts
+----------------------
+
+### Install dependencies
+
+Installing the dependencies using MacPorts is very straightforward.
+
+ sudo port install boost db48@+no_java openssl miniupnpc
+
+### Building `bitcoind`
+
+1. Clone the github tree to get the source code and go into the directory.
+
+ git clone git@github.com:bitcoin/bitcoin.git bitcoin
+ cd bitcoin
+
+2. Build bitcoind:
+
+ cd src
+ make -f makefile.osx
+
+3. It is a good idea to build and run the unit tests, too:
+
+ make -f makefile.osx test
+
+Instructions: HomeBrew
+----------------------
+
+#### Install dependencies using Homebrew
+
+ brew install boost miniupnpc openssl berkeley-db4
+
+### Building `bitcoind`
+
+1. Clone the github tree to get the source code and go into the directory.
+
+ git clone git@github.com:bitcoin/bitcoin.git bitcoin
+ cd bitcoin
+
+2. Modify source in order to pick up the `openssl` library.
+
+ Edit `makefile.osx` to account for library location differences. There's a
+ diff in `contrib/homebrew/makefile.osx.patch` that shows what you need to
+ change, or you can just patch by doing
+
+ patch -p1 < contrib/homebrew/makefile.osx.patch
+
+3. Build bitcoind:
+
+ cd src
+ make -f makefile.osx
+
+4. It is a good idea to build and run the unit tests, too:
+
+ make -f makefile.osx test
+
+Creating a release build
+------------------------
+
+A bitcoind binary is not included in the Bitcoin-Qt.app bundle. You can ignore
+this section if you are building `bitcoind` for your own use.
+
+If you are building `bitcoind` for others, your build machine should be set up
+as follows for maximum compatibility:
+
+All dependencies should be compiled with these flags:
+
+ -mmacosx-version-min=10.5 -arch i386 -isysroot /Developer/SDKs/MacOSX10.5.sdk
+
+For MacPorts, that means editing your macports.conf and setting
+`macosx_deployment_target` and `build_arch`:
+
+ macosx_deployment_target=10.5
+ build_arch=i386
+
+... and then uninstalling and re-installing, or simply rebuilding, all ports.
+
+As of December 2012, the `boost` port does not obey `macosx_deployment_target`.
+Download `http://gavinandresen-bitcoin.s3.amazonaws.com/boost_macports_fix.zip`
+for a fix. Some ports also seem to obey either `build_arch` or
+`macosx_deployment_target`, but not both at the same time. For example, building
+on an OS X 10.6 64-bit machine fails. Official release builds of Bitcoin-Qt are
+compiled on an OS X 10.6 32-bit machine to workaround that problem.
+
+Once dependencies are compiled, creating `Bitcoin-Qt.app` is easy:
+
+ make -f Makefile.osx RELEASE=1
+
+Running
+-------
+
+It's now available at `./bitcoind`, provided that you are still in the `src`
+directory. We have to first create the RPC configuration file, though.
+
+Run `./bitcoind` to get the filename where it should be put, or just try these
+commands:
+
+ echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
+ chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
+
+When next you run it, it will start downloading the blockchain, but it won't
+output anything while it's doing this. This process may take several hours.
+
+Other commands:
+
+ ./bitcoind --help # for a list of command-line options.
+ ./bitcoind -daemon # to start the bitcoin daemon.
+ ./bitcoind help # When the daemon is running, to get a list of RPC commands
diff --git a/doc/build-osx.txt b/doc/build-osx.txt
deleted file mode 100644
index fd878043c0..0000000000
--- a/doc/build-osx.txt
+++ /dev/null
@@ -1,54 +0,0 @@
-Copyright (c) 2009-2012 Bitcoin Developers
-Distributed under the MIT/X11 software license, see the accompanying
-file COPYING or http://www.opensource.org/licenses/mit-license.php.
-This product includes software developed by the OpenSSL Project for use in
-the OpenSSL Toolkit (http://www.openssl.org/). This product includes
-cryptographic software written by Eric Young (eay@cryptsoft.com) and UPnP
-software written by Thomas Bernard.
-
-
-Mac OS X bitcoind build instructions
-Laszlo Hanyecz <solar@heliacal.net>
-Douglas Huff <dhuff@jrbobdobbs.org>
-
-
-See readme-qt.rst for instructions on building Bitcoin-Qt, the
-graphical user interface.
-
-Tested on 10.5, 10.6 and 10.7 intel. PPC is not supported because it's big-endian.
-
-All of the commands should be executed in Terminal.app.. it's in
-/Applications/Utilities
-
-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 available on your OS X
-install DVD, but if not, you can get the current version from https://developer.apple.com/xcode/
-
-
-1. Clone the github tree to get the source code:
-
-git clone git@github.com:bitcoin/bitcoin.git bitcoin
-
-2. Download and install MacPorts from http://www.macports.org/
-
-2a. (for 10.7 Lion)
- Edit /opt/local/etc/macports/macports.conf and uncomment "build_arch i386"
-
-3. Install dependencies from MacPorts
-
-sudo port install boost db48 openssl miniupnpc
-
-Optionally install qrencode (and set USE_QRCODE=1):
-sudo port install qrencode
-
-4. Now you should be able to build bitcoind:
-
-cd bitcoin/src
-make -f makefile.osx
-
-Run:
- ./bitcoind --help # for a list of command-line options.
-Run
- ./bitcoind -daemon # to start the bitcoin daemon.
-Run
- ./bitcoind help # When the daemon is running, to get a list of RPC commands
diff --git a/doc/coding.txt b/doc/coding.txt
index 0813105e73..427e388cfd 100644
--- a/doc/coding.txt
+++ b/doc/coding.txt
@@ -65,9 +65,6 @@ StartNode : Starts other threads.
ThreadGetMyExternalIP : Determines outside-the-firewall IP address,
sends addr message to connected peers when it determines it.
-ThreadIRCSeed : Joins IRC bootstrapping channel, watching for new
-peers and advertising this node's IP address.
-
ThreadSocketHandler : Sends/Receives data from peers on port 8333.
ThreadMessageHandler : Higher-level message handling (sending and
diff --git a/doc/multiwallet-qt.txt b/doc/multiwallet-qt.txt
new file mode 100644
index 0000000000..8394080db0
--- /dev/null
+++ b/doc/multiwallet-qt.txt
@@ -0,0 +1,53 @@
+Multiwallet Qt Development and Integration Strategy
+===================================================
+
+In order to support loading of multiple wallets in bitcoin-qt, a few changes in the UI architecture will be needed.
+Fortunately, only four of the files in the existing project are affected by this change.
+
+Three new classes have been implemented in three new .h/.cpp file pairs, with much of the functionality that was previously
+implemented in the BitcoinGUI class moved over to these new classes.
+
+The two existing files most affected, by far, are bitcoingui.h and bitcoingui.cpp, as the BitcoinGUI class will require
+some major retrofitting.
+
+Only requiring some minor changes is bitcoin.cpp.
+
+Finally, three new headers and source files will have to be added to bitcoin-qt.pro.
+
+Changes to class BitcoinGUI
+---------------------------
+The principal change to the BitcoinGUI class concerns the QStackedWidget instance called centralWidget.
+This widget owns five page views: overviewPage, transactionsPage, addressBookPage, receiveCoinsPage, and sendCoinsPage.
+
+A new class called *WalletView* inheriting from QStackedWidget has been written to handle all renderings and updates of
+these page views. In addition to owning these five page views, a WalletView also has a pointer to a WalletModel instance.
+This allows the construction of multiple WalletView objects, each rendering a distinct wallet.
+
+A second class called *WalletStack*, also inheriting from QStackedWidget, has been written to handle switching focus between
+different loaded wallets. In its current implementation, as a QStackedWidget, only one wallet can be viewed at a time -
+but this can be changed later.
+
+A third class called *WalletFrame* inheriting from QFrame has been written as a container for embedding all wallet-related
+controls into BitcoinGUI. At present it just contains a WalletStack instance and does little more than passing on messages
+from BitcoinGUI to the WalletStack, which in turn passes them to the individual WalletViews. It is a WalletFrame instance
+that takes the place of what used to be centralWidget in BitcoinGUI. The purpose of this class is to allow future
+refinements of the wallet controls with minimal need for further modifications to BitcoinGUI, thus greatly simplifying
+merges while reducing the risk of breaking top-level stuff.
+
+Changes to bitcoin.cpp
+----------------------
+bitcoin.cpp is the entry point into bitcoin-qt, and as such, will require some minor modifications to provide hooks for
+multiple wallet support. Most importantly will be the way it instantiates WalletModels and passes them to the
+singleton BitcoinGUI instance called window. Formerly, BitcoinGUI kept a pointer to a single instance of a WalletModel.
+The initial change required is very simple: rather than calling window.setWalletModel(&walletModel); we perform the
+following two steps:
+
+window.addWallet("~Default", &walletModel);
+window.setCurrentWallet("~Default");
+
+The string parameter is just an arbitrary name given to the default wallet. It's been prepended with a tilde to avoid name
+collisions in the future with additional wallets.
+
+The shutdown call window.setWalletModel(0) has also been removed. In its place is now:
+
+window.removeAllWallets();
diff --git a/doc/release-process.txt b/doc/release-process.txt
index 166f2aaf3c..29271ad224 100644
--- a/doc/release-process.txt
+++ b/doc/release-process.txt
@@ -1,25 +1,26 @@
-* update translations (ping tcatm on IRC for now)
+* update translations (ping wumpus, Diapolo or tcatm on IRC)
+ * see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
* update (commit) version in sources
bitcoin-qt.pro
- src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
- share/setup.nsi
- doc/README*
contrib/verifysfbinaries/verify.sh
+ doc/README*
+ share/setup.nsi
+ src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
* tag version in git
- git tag -a v0.5.1
+ git tag -a v0.8.0
-* write release notes. git shortlog helps a lot:
+* write release notes. git shortlog helps a lot, for example:
- git shortlog --no-merges v0.5.0..
+ git shortlog --no-merges v0.7.2..v0.8.0
* perform gitian builds
* From a directory containing the bitcoin source, gitian-builder and gitian.sigs
export SIGNER=(your gitian key, ie bluematt, sipa, etc)
- export VERSION=0.5.1
+ export VERSION=0.8.0
cd ./gitian-builder
* Fetch and build inputs: (first time, or when dependency versions change)