diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/build-msw.txt | 112 | ||||
| -rw-r--r-- | doc/build-osx.txt | 261 | ||||
| -rw-r--r-- | doc/build-unix.txt | 107 | ||||
| -rw-r--r-- | doc/coding.txt | 41 |
4 files changed, 521 insertions, 0 deletions
diff --git a/doc/build-msw.txt b/doc/build-msw.txt new file mode 100644 index 0000000000..e30b4ee726 --- /dev/null +++ b/doc/build-msw.txt @@ -0,0 +1,112 @@ +Copyright (c) 2009-2011 Bitcoin Developers +Distributed under the MIT/X11 software license, see the accompanying +file license.txt 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. + + +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. + + +Dependencies +------------ +Libraries you need to download separately and build: + + default path download +wxWidgets \wxwidgets-2.9.1-mgw http://www.wxwidgets.org/downloads/ +OpenSSL \openssl-1.0.0c-mgw http://www.openssl.org/source/ +Berkeley DB \db-4.7.25.NC-mgw http://www.oracle.com/technology/software/products/berkeley-db/index.html +Boost \boost-1.43.0-mgw http://www.boost.org/users/download/ +miniupnpc \upnpc-exe-win32-20110215 http://miniupnp.tuxfamily.org/files/ + +Their licenses: +wxWidgets LGPL 2.1 with very liberal exceptions +OpenSSL Old BSD license with the problematic advertising requirement +Berkeley DB New BSD license with additional requirement that linked software must be free open source +Boost MIT-like license +miniupnpc New (3-clause) BSD license + +Versions used in this release: +wxWidgets 2.9.1 +OpenSSL 1.0.0c +Berkeley DB 4.7.25.NC +Boost 1.43.0 +miniupnpc 1.5-20110215 + + +Notes +----- +The UI layout is edited with wxFormBuilder. The project file is +uiproject.fbp. It generates uibase.cpp and uibase.h, which define base +classes that do the rote work of constructing all the UI elements. + +wxWidgets +--------- +DOS shell: +cd \wxWidgets-2.9.1-mgw\build\msw +mingw32-make -f makefile.gcc + +OpenSSL +------- +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.0c-mgw +./config +make + +perl util/mkdef.pl 32 libeay enable-static-engine > libeay32.def +dllwrap --dllname libeay32.dll --output-lib libeay32.a --def libeay32.def libcrypto.a -lws2_32 -lgdi32 + +after that openssl libeay is in main source dir (openssl-1.0.0c-mgw) + +Berkeley DB +----------- +MSYS shell: +cd /c/db-4.7.25.NC-mgw/build_unix +sh ../dist/configure --enable-mingw --enable-cxx +make + + +Boost +----- +DOS prompt: +downloaded boost jam 3.1.18 +cd \boost-1.43.0-mgw +bjam toolset=gcc --build-type=complete stage + +Note: +building with boost 1.45.0 failed because of boost ticket 4614, 4258 +builds fine with boost 1.43.0 + +MiniUPnPc +--------- +Building miniupnpc failed on Windows Server 2003, thus it is expected that a binary copy will be used. +See http://miniupnp.tuxfamily.org/forum/viewtopic.php?t=642 +UPnP support is optional, make with USE_UPNP= to disable it. + +Get upnpc-exe-win32-20110215.zip and unzip it to \upnpc-exe-win32-20110215 +Get miniupnpc-1.5.20110215.tar.gz and copy *.h to \upnpc-exe-win32-20110215\miniupnpc + +Bitcoin +------- +DOS prompt: +cd \bitcoin\src +mingw32-make bitcoin.exe bitcoind.exe -f makefile.mingw +strip bitcoin.exe +strip bitcoind.exe diff --git a/doc/build-osx.txt b/doc/build-osx.txt new file mode 100644 index 0000000000..79279838d3 --- /dev/null +++ b/doc/build-osx.txt @@ -0,0 +1,261 @@ +Copyright (c) 2010 Laszlo Hanyecz +Distributed under the MIT/X11 software license, see the accompanying +file license.txt 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 build instructions +Laszlo Hanyecz (solar@heliacal.net) + + +Tested on 10.5 and 10.6 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 +I think it comes on the DVD but you can get the current version from +http://developer.apple.com + + +1. Pick a directory to work inside.. something like ~/bitcoin works. The +structure I use looks like this: +(~ is your home directory) + +~/bitcoin +~/bitcoin/trunk # source code +~/bitcoin/deps # dependencies.. like libraries and headers needed to compile +~/bitcoin/Bitcoin.app # the application bundle where you can run the app + +Just execute: mkdir ~/bitcoin +This will create the top dir for you.. + +WARNING: do not use the ~ notation with the configure scripts.. use the full +name of the directory, for example /Users/james/bitcoin/deps for a user named +'james'. In my examples I am using 'macosuser' so make sure you change that. + +2. Check out the trunk version of the bitcoin code from subversion: + +cd ~/bitcoin +svn checkout https://bitcoin.svn.sourceforge.net/svnroot/bitcoin/trunk + +This will make ~/bitcoin/trunk for you with all the files from subversion. + +3. Get and build the dependencies + + +Boost +----- + +Download from http://www.boost.org/users/download/ +I'm assuming it ended up in ~/Downloads.. + +mkdir ~/bitcoin/deps +cd ~/bitcoin/deps +tar xvjf ~/Downloads/boost_1_42_0.tar.bz2 +cd boost_1_42_0 +./bootstrap.sh +./bjam architecture=combined address-model=32_64 macosx-version=10.5 macosx-version-min=10.5 link=static runtime-link=static --toolset=darwin --prefix=/Users/macosuser/bitcoin/deps install + +If you're using Snow Leopard, you will need to specify 10.6 as your Mac OS X +version instead of 10.5. + +This part takes a while.. use your judgement and fix it if something doesn't +build for some reason. + +Change the prefix to whatever your directory is (my username in this example +is macosuser). I'm also running on 10.6 so i have macosx-version=10.6 change +to 10.5 if you're using leopard. + +This is what my output looked like at the end: +...failed updating 2 targets... +...skipped 144 targets... +...updated 8074 targets... + + +OpenSSL +------- + +Download from http://www.openssl.org/source/ + +We would like to build this as a 32 bit/64 bit library so we actually build it +2 times and join it together here.. If you downloaded with safari it already +uncompressed it so it will just be a tar not a tar.gz + +cd ~/bitcoin/deps +tar xvf ~/Downloads/openssl-1.0.0.tar +mv openssl-1.0.0 openssl-1.0.0-i386 +tar xvf ~/Downloads/openssl-1.0.0.tar +mv openssl-1.0.0 openssl-1.0.0-x86_64 +# build i386 (32 bit intel) binary +cd openssl-1.0.0-i386 +./Configure --prefix=/Users/macosuser/bitcoin/deps --openssldir=/Users/macosuser/bitcoin/deps/openssl darwin-i386-cc && make +make install # only do this on one of the architectures, to install the headers +cd .. +# build x86_64 (64 bit intel) binary +cd openssl-1.0.0-x86_64 +./Configure --prefix=/Users/macosuser/bitcoin/deps --openssldir=/Users/macosuser/bitcoin/deps/openssl darwin64-x86_64-cc && make +cd .. + +# combine the libs +cd ~/bitcoin/deps +lipo -arch i386 openssl-1.0.0-i386/libcrypto.a -arch x86_64 openssl-1.0.0-x86_64/libcrypto.a -o lib/libcrypto.a -create +lipo -arch i386 openssl-1.0.0-i386/libssl.a -arch x86_64 openssl-1.0.0-x86_64/libssl.a -o lib/libssl.a -create + +Verify your binaries + +file lib/libcrypto.a + +output should look like this: + +lib/libcrypto.a: Mach-O universal binary with 2 architectures +lib/libcrypto.a (for architecture i386): current ar archive random library +lib/libcrypto.a (for architecture x86_64): current ar archive random library + + +miniupnpc +--------- + +The process for miniupnpc (optional) is similar to that of OpenSSL. + +Download from http://miniupnp.tuxfamily.org/files/. + +cd ~/bitcoin/deps +tar xvf ~/Downloads/miniupnpc-1.5.tar +mv miniupnpc-1.5 miniupnpc-1.5-x86_64 +tar xvf ~/Downloads/miniupnpc-1.5.tar +mv miniupnpc-1.5 miniupnpc-1.5-i386 +# build x86_64 (64 bit intel) binary +cd miniupnpc-1.5-x86_64 +export CFLAGS="-arch x86_64" +export LDFLAGS="-arch x86_64" +export PREFIX="/Users/macuser/bitcoin/deps" +make && make install +# build i386 (32 bit intel) binary +cd miniupnpc-1.5-i386 +export CFLAGS="-arch i386" +export LDFLAGS="-arch i386" +export PREFIX="/Users/macuser/bitcoin/deps" +make + +# combine the libs +cd ~/bitcoin/deps +lipo -arch i386 miniupnpc-1.5-i386/libminiupnpc.a -arch x86_64 miniupnpc-1.5-x86_64/libminiupnpc.a -o lib/libminiupnpc.a -create + +Verify your binaries + +file lib/libminiupnpc.a + +output should look like this: + +lib/libminiupnpc.a: Mach-O universal binary with 2 architectures +lib/libminiupnpc.a (for architecture i386): current ar archive random library +lib/libminiupnpc.a (for architecture x86_64): current ar archive random library + + +Berkeley DB +----------- + +Download from http://freshmeat.net/projects/berkeleydb/ + +cd ~/bitcoin/deps +tar xvf ~/Downloads/db-4.8.26.tar +cd db-4.8.26/build_unix +../dist/configure --prefix=/Users/macosuser/bitcoin/deps --enable-cxx && make && make install + + +wxWidgets +--------- + +This is the big one.. + +Check it out from svn + +cd ~/bitcoin/deps +svn checkout http://svn.wxwidgets.org/svn/wx/wxWidgets/trunk wxWidgets-trunk + +This will make a wxWidgets-trunk directory in deps. + +Use this script snippet, change your prefix to whatever your dir is: + +PREFIX=~/bitcoin/deps +SRCDIR="$PREFIX/wxWidgets-trunk" +BUILDDIR="$SRCDIR/macbuild" + +cd "$PREFIX" && +#svn checkout http://svn.wxwidgets.org/svn/wx/wxWidgets/trunk wxWidgets-trunk && +cd "$SRCDIR" && + +[ -f include/wx/hashmap.h.orig ] || cp include/wx/hashmap.h include/wx/hashmap.h.orig && +sed 's/if wxUSE_STL/if 0 \&\& wxUSE_STL/g' < include/wx/hashmap.h.orig > include/wx/hashmap.h && + +[ -f include/wx/hashset.h.orig ] || cp include/wx/hashset.h include/wx/hashset.h.orig && +sed 's/if wxUSE_STL/if 0 \&\& wxUSE_STL/g' < include/wx/hashset.h.orig > include/wx/hashset.h && + + + +rm -vrf "$BUILDDIR" && +mkdir "$BUILDDIR" && +cd "$BUILDDIR" && + +../configure --prefix="$PREFIX" \ +--with-osx_cocoa \ +--disable-shared \ +--disable-debug_flag \ +--with-macosx-version-min=10.5 \ +--enable-stl \ +--enable-utf8 \ +--enable-universal_binary \ +--with-libjpeg=builtin \ +--with-libpng=builtin \ +--with-regex=builtin \ +--with-libtiff=builtin \ +--with-zlib=builtin \ +--with-expat=builtin \ +--with-macosx-sdk=/Developer/SDKs/MacOSX10.5.sdk && + + +find . -name Makefile | +while read i; do + echo $i; + sed 's/-arch i386/-arch i386 -arch x86_64/g' < "$i" > "$i".new && + mv "$i" "$i".old && + mv "$i".new "$i"; +done + + + +make && +make install + + + +Now you should be able to build bitcoin + +cd ~/bitcoin/trunk +make -f makefile.osx bitcoin + +Before you can run it, you need to create an application bundle for Mac OS. +Create the directories in terminal using mkdir and copy the files into place. +They are available at http://heliacal.net/~solar/bitcoin/mac-build/ +You need the Info.plist and the .ins file. The Contents/MacOS/bitcoin file is +the output of the build. +Your directory structure should look like this: + +Bitcoin.app +Bitcoin.app/Contents +Bitcoin.app/Contents/Info.plist +Bitcoin.app/Contents/MacOS +Bitcoin.app/Contents/MacOS/bitcoin +Bitcoin.app/Contents/Resources +Bitcoin.app/Contents/Resources/BitcoinAppIcon.icns + +To run it you can just click the Bitcoin.app in Finder, or just do open +~/bitcoin/Bitcoin.app +If you want to run it with arguments you can just run it without backgrounding +by specifying the full name in terminal: +~/bitcoin/Bitcoin.app/Contents/MacOS/bitcoin -addnode=192.75.207.66 diff --git a/doc/build-unix.txt b/doc/build-unix.txt new file mode 100644 index 0000000000..4494c752da --- /dev/null +++ b/doc/build-unix.txt @@ -0,0 +1,107 @@ +Copyright (c) 2009-2010 Satoshi Nakamoto +Distributed under the MIT/X11 software license, see the accompanying +file license.txt 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. + + +UNIX BUILD NOTES +================ + +To Build +-------- + +cd src/ + +make -f makefile.unix # Bitcoin with wxWidgets GUI + or +make -f makefile.unix bitcoind # Headless bitcoin + + +Dependencies +------------ +sudo apt-get install build-essential +sudo apt-get install libgtk2.0-dev +sudo apt-get install libssl-dev +sudo apt-get install libdb4.7-dev +sudo apt-get install libdb4.7++-dev +Boost 1.40+: sudo apt-get install libboost-all-dev +or Boost 1.37: sudo apt-get install libboost1.37-dev + +If using Boost 1.37, append -mt to the boost libraries in the makefile. + +Requires wxWidgets 2.9.0 or greater, which uses UTF-8. Don't try 2.8, it +won't work. + +You need to download wxWidgets from http://www.wxwidgets.org/downloads/ +and build it yourself. See the build instructions and configure parameters +below. + +Requires miniupnpc for UPnP port mapping. To compile with UPnP support, +install miniupnpc and compile after setting USE_UPNP. It can be downloaded +from http://miniupnp.tuxfamily.org/files/. + +Licenses of statically linked libraries: +wxWidgets LGPL 2.1 with very liberal exceptions +Berkeley DB New BSD license with additional requirement that linked software must be free open source +Boost MIT-like license +miniupnpc New (3-clause) BSD license + +Versions used in this release: +GCC 4.3.3 +OpenSSL 0.9.8g +wxWidgets 2.9.0 +Berkeley DB 4.7.25.NC +Boost 1.37 +miniupnpc 1.5 + + +Notes +----- +The UI layout is edited with wxFormBuilder. The project file is +uiproject.fbp. It generates uibase.cpp and uibase.h, which define base +classes that do the rote work of constructing all the UI elements. + +The release is built with GCC and then "strip bitcoin" to strip the debug +symbols, which reduces the executable size by about 90%. + + +wxWidgets +--------- +cd /usr/local +tar -xzvf wxWidgets-2.9.0.tar.gz +cd wxWidgets-2.9.0 +mkdir buildgtk +cd buildgtk +../configure --with-gtk --enable-debug --disable-shared --enable-monolithic +make +sudo su +make install +ldconfig + + +miniupnpc +--------- +tar -xzvf miniupnpc-1.5.tar.gz +cd miniupnpc-1.5 +make +sudo su +make install + + +Berkeley DB +----------- +You need Berkeley DB 4.7. Don't use 4.8, the database/log0000* files +are incompatible. If you have to build Berkeley DB yourself: +../dist/configure --enable-cxx +make + + +Boost +----- +If you need to build Boost yourself: +sudo su +./bootstrap.sh +./bjam install diff --git a/doc/coding.txt b/doc/coding.txt new file mode 100644 index 0000000000..4707476697 --- /dev/null +++ b/doc/coding.txt @@ -0,0 +1,41 @@ +Please be consistent with the existing coding style.
+
+Block style:
+
+bool Function(char* psz, int n)
+{
+ // Comment summarising what this section of code does
+ for (int i = 0; i < n; i++)
+ {
+ // When something fails, return early
+ if (!Something())
+ return false;
+ ...
+ }
+
+ // Success return is usually at the end
+ return true;
+}
+
+- ANSI/Allman block style
+- 4 space indenting, no tabs
+- No extra spaces inside parenthesis; please don't do ( this )
+- No space after function names, one space after if, for and while
+
+Variable names begin with the type in lowercase, like nSomeVariable.
+Please don't put the first word of the variable name in lowercase like
+someVariable.
+
+Common types:
+n integer number: short, unsigned short, int, unsigned int,
+ int64, uint64, sometimes char if used as a number
+d double, float
+f flag
+hash uint256
+p pointer or array, one p for each level of indirection
+psz pointer to null terminated string
+str string object
+v vector or similar list objects
+map map or multimap
+set set or multiset
+bn CBigNum
|