From 1a7bbf54720a81b85def7d6da2f50636a7ca4542 Mon Sep 17 00:00:00 2001
From: Mark Liversedge
Date: Sun, 30 Dec 2012 17:13:11 +0000
Subject: [PATCH] remove boost from docs
.. it is no longer needed.
---
INSTALL-LINUX | 19 +-----------
INSTALL-MAC | 59 +++---------------------------------
INSTALL-WIN32 | 7 -----
doc/developers-guide.content | 16 +++-------
4 files changed, 9 insertions(+), 92 deletions(-)
diff --git a/INSTALL-LINUX b/INSTALL-LINUX
index 274430f1a..a5347dc2b 100644
--- a/INSTALL-LINUX
+++ b/INSTALL-LINUX
@@ -14,7 +14,6 @@ should be largely the same for any Linux distro.
CONTENTS
1. BASIC INSTALLATION WITH MANDATORY DEPENDENCIES
- - boost
- QT
- git
@@ -50,11 +49,6 @@ Run the Qt installer (need to chmod +x it first) and install to default location
Put qmake in path (e.g. sudo cp ~/QtSDK/Desktop/Qt/473/gcc/bin/qmake /usr/local/bin)
Test qmake is ok with: qmake --version (should report 4.7.0 or higher)
-Download Boost 1.46.1 from http://sourceforge.net/projects/boost/files/boost/1.46.1/
-Extract files with archive manager into home directory (~/boost_1_46_1/) or you
-may be able to install with
-$ sudo apt-get install libboost1.42-dev
-
Install git with:
$ sudo apt-get install git
Said Y to prompt about all git files installed (git-gui et al)
@@ -77,19 +71,8 @@ $ vi gcconfig.pri
Comment out the D2XX_INCLUDE and SRMIO_INSTALL lines for now (put # in first character of the line
to comment out), we will install that in a moment, if we need to.
-Adjust the boost location to the location we installed to (home), so it should read something
-like below (my home directory is markl)
-
-BOOST_INSTALL=/home/markl/boost_1_46_1
-
-also, BOOST_INCLUDE should not have a trailing include on it, this is a legacy setting
-that a lot of other users have used in the past, look for it towards the end if gcconfig.pri
-and it should read like this (take off trailing /include):
-
-BOOST_INCLUDE=$${BOOST_INSTALL)
-
If you are building for your local host you may find that you get better performance if
-compiling with gcc -O3 (tree vectorization can have a significat impact)
+compiling with gcc -O3 (tree vectorization can have a significat impact) [or -Ofast]
If so you might like to uncomment:
diff --git a/INSTALL-MAC b/INSTALL-MAC
index dc7f7e62f..26d0e0cab 100644
--- a/INSTALL-MAC
+++ b/INSTALL-MAC
@@ -16,7 +16,6 @@ CONTENTS
1. BASIC INSTALLATION WITH MANDATORY DEPENDENCIES
- Xcode
- Qt
- - boost
2. ADDING OPTIONAL DEPENDENCIES
- FTDI D2XX
@@ -156,54 +155,10 @@ with the following commands:
$ sudo port install qt4-mac
$ sudo port install qt4-mac-sqlite3-plugin
+1.6 DEPRECATED
+--------------
-
-1.6 Install Boost
------------------
-
-We still use boost in some parts of the code. We are looking to remove this
-dependency since it doesn't add much over QT for our purposes. You will need
-to install the latest there, currently that is 1.48.
-
-The URL for downloading it is: www.boost.org, click on the download right there
-on the front page and it will take you to sourceforge where the boost project
-is hosted. Click on the boost_1_48_0.tar.gz and let that download. It is typically
-around 50MB in size.
-
-I typically install boost in /usr/local, to do this from terminal change directory
-to /usr/local
-
-$ cd /usr/local
-
-If it complains that it does not exist, lets go ahead and create it, but we will
-need to do this with admin rights.
-
-$ sudo mkdir -p /usr/local
-$ cd /usr/local
-
-Now lets extract the boost files, you will need to make a note of where the file
-was downloaded to, I run Chrome and it was downloaded into ~/Downloads so
-
-$ sudo tar -xvzf ~/Downloads/boost_1_48_0.tar.gz
-
-This will extract all the boost files into /usr/local/boost_1_48_0, we need to
-remember that since we will be updating the GC build file to tell the build
-system where to find boost. More on that later.
-
-Before carrying on change directory back to the GC project diretory we created
-earlier - we don't want to get confused here.
-
-$ cd ~/Projects/GoldenCheetah
-$ ls
-
-You will be back where we were before, with the INSTALL docs and directories
-listed.
-
-We now have all the mandatory dependencies installed and can build GoldenCheetah
-for the first time!
-
-Lets go ahead and do that, then we can add optional dependencies as you decide
-which features you want to build GoldenCheetah with.
+No longer need this step (install boost)
1.7 Configure and Build GoldenCheetah (with no optional dependencies)
---------------------------------------------------------------------
@@ -220,13 +175,7 @@ $ vi gcconfig.pri
In that last step you can use whatever editor you feel most comfortable with.
-For the setup we have we need to set the directory that Boost was installed to
-by changing the following lines:
-
-BOOST_INSTALL = /usr/local/boost_1_48_0
-BOOST_INCLUDE = $${BOOST_INSTALL}
-
-and for now we will comment out some of the dependencies we have not installed
+For now we will comment out some of the dependencies we have not installed
support for yet:
#SRMIO_INSTALL = /usr/local/srmio
diff --git a/INSTALL-WIN32 b/INSTALL-WIN32
index 5f66fa317..5c3e738f0 100644
--- a/INSTALL-WIN32
+++ b/INSTALL-WIN32
@@ -20,11 +20,6 @@ Download Qt SDK from:
(File I am using is qt-sdk-win-opensource-2010.02.1.exe)
- Install in D:\Coding\Qt
-Download latest Boost from:
- http://sourceforge.net/projects/boost/files/boost/
- (File I am using is boost_1_42_0.zip)
-- Install in D:\Coding\Boost
-
Download the D2XX drivers:
http://www.ftdichip.com/Drivers/D2XX.htm
(File I am using is: CDM 202.06.00 WHQL Certified.zip)
@@ -59,10 +54,8 @@ Download GoldenCheetah source
Copy D:\Coding\GoldenCheetah\src\gccconfig.pri.in
to D:\Coding\GoldenCheetah\src\gccconfig.pri and edit
-- Set: BOOST_INSTALL = d:/coding/boost
- Set: D2XX_INCLUDE = d:/coding/D2XX
- Comment out #SRMIO_INSTALL
-- Set: BOOST_INCLUDE = $${BOOST_INSTALL}/
- Comment out: CONFIG += debug
- Uncomment: CONFIG += static
diff --git a/doc/developers-guide.content b/doc/developers-guide.content
index 88ac5457e..7488a8431 100644
--- a/doc/developers-guide.content
+++ b/doc/developers-guide.content
@@ -34,12 +34,6 @@ on GitHub.
qt4-mac |
libqt4-dev |
-
- | Boost |
- 1.38.0 or later |
- boost |
- libboost-dev |
-
| git |
any |
@@ -137,18 +131,16 @@ git show --color abcd0123
variable, declare it static within a .cpp file.
Only call C++'s operator new within the constructors and
-reset functions of std::auto_ptr,
-boost::scoped_pointer, etc. or when passing a parent pointer to a
-Qt class (so that the parent deletes the child). Never call
-delete explicitly.
+reset functions of std::auto_ptr etc.
+or when passing a parent pointer to a Qt class (so that the parent
+deletes the child). Never call delete explicitly.
Do not use malloc or free unless forced to by an
external C library.
Allocate large buffers on the heap, not on the stack.
-When the C++ standard library has an appropriate function, use it.
-Likewise for Qt and Boost.
+When the Qt or C++ standard library has an appropriate function, use it.
Only use external libraries with GPL-compatible licenses.