[mlpack-git] master: Update and clarify build tutorial, since DEBUG and PROFILE are OFF by default in releases. (5d06621)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40

>---------------------------------------------------------------

commit 5d06621272086fcb9928b012c6dcb4931d77bf30
Author: Ryan Curtin <ryan at ratml.org>
Date:   Thu Oct 9 20:41:50 2014 +0000

    Update and clarify build tutorial, since DEBUG and PROFILE are OFF by default in
    releases.


>---------------------------------------------------------------

5d06621272086fcb9928b012c6dcb4931d77bf30
 doc/guide/build.hpp | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/doc/guide/build.hpp b/doc/guide/build.hpp
index 7e8f15f..e2a388a 100644
--- a/doc/guide/build.hpp
+++ b/doc/guide/build.hpp
@@ -15,7 +15,7 @@ Download latest mlpack build from here : <a href="http://www.mlpack.org/files/ml
 Once the MLPACK source is unpacked, you should create a build directory.
 
 @code
-$ cd mlpack-1.0.7
+$ cd mlpack-1.0.10
 $ mkdir build
 @endcode
 
@@ -56,16 +56,19 @@ Fedora 16 and older.
 @section config Configuring CMake
 
 Running CMake is the equivalent to running `./configure` with autotools.  If you
-run CMake with no options, it will configure the project to build with debugging
-symbols and profiling information:
+are working with the svn trunk version of mlpack and run CMake with no options,
+it will configure the project to build with debugging symbols and profiling
+information:  If you are working with a release of mlpack, running CMake with no
+options will configure the project to build without debugging or profiling
+information (for speed).
 
 @code
 $ cd build
 $ cmake ../
 @endcode
 
-You can specify options to compile without debugging information and profiling
-information (i.e. as fast as possible):
+You can manually specify options to compile with or without debugging
+information and profiling information (i.e. as fast as possible):
 
 @code
 $ cd build
@@ -74,8 +77,10 @@ $ cmake -D DEBUG=OFF -D PROFILE=OFF ../
 
 The full list of options MLPACK allows:
 
- - DEBUG=(ON/OFF): compile with debugging symbols (default ON)
- - PROFILE=(ON/OFF): compile with profiling symbols (default ON)
+ - DEBUG=(ON/OFF): compile with debugging symbols (default ON in svn trunk, OFF
+   in releases)
+ - PROFILE=(ON/OFF): compile with profiling symbols (default ON in svn trunk,
+   OFF in releases)
  - ARMA_EXTRA_DEBUG=(ON/OFF): compile with extra Armadillo debugging symbols
        (default OFF)