[mlpack-git] master: Document new CMake options. (31dd6c0)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/698248845c4fca0303d1fda6adf9df3af2433a0c...31dd6c033fea6afb9155192efd92557852562256

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

commit 31dd6c033fea6afb9155192efd92557852562256
Author: Ryan Curtin <ryan at ratml.org>
Date:   Fri Apr 15 14:12:28 2016 -0400

    Document new CMake options.


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

31dd6c033fea6afb9155192efd92557852562256
 doc/guide/build.hpp | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/guide/build.hpp b/doc/guide/build.hpp
index 9ee3ba6..9a7ed6e 100644
--- a/doc/guide/build.hpp
+++ b/doc/guide/build.hpp
@@ -84,6 +84,9 @@ The full list of options mlpack allows:
    OFF in releases)
  - ARMA_EXTRA_DEBUG=(ON/OFF): compile with extra Armadillo debugging symbols
        (default OFF)
+ - BUILD_TESTS=(ON/OFF): compile the \c mlpack_test program (default ON)
+ - TEST_VERBOSE=(ON/OFF): run test cases in \c mlpack_test with verbose output
+       (default OFF)
 
 Each option can be specified to CMake with the '-D' flag.  Other tools can also
 be used to configure CMake, but those are not documented here.
@@ -105,7 +108,7 @@ You can specify individual components which you want to build, if you do not
 want to build everything in the library:
 
 @code
-$ make pca allknn allkfn
+$ make mlpack_pca mlpack_allknn mlpack_allkfn
 @endcode
 
 If the build fails and you cannot figure out why, register an account on Trac