[mlpack-git] master: Update build instructions to make testing more clear. (e801f30)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/d16d24f8675f17234087e9cbf0361c9914c656cb...e801f30fa86f8c7e40ab3b9c571e9350bebf8fcd

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

commit e801f30fa86f8c7e40ab3b9c571e9350bebf8fcd
Author: Ryan Curtin <ryan at ratml.org>
Date:   Wed Sep 7 16:09:09 2016 -0400

    Update build instructions to make testing more clear.


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

e801f30fa86f8c7e40ab3b9c571e9350bebf8fcd
 doc/guide/build.hpp | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/doc/guide/build.hpp b/doc/guide/build.hpp
index d62a12a..423092e 100644
--- a/doc/guide/build.hpp
+++ b/doc/guide/build.hpp
@@ -120,11 +120,26 @@ want to build everything in the library:
 $ make mlpack_pca mlpack_knn mlpack_kfn
 @endcode
 
-If the build fails and you cannot figure out why, register an account on Trac
-and submit a ticket and the mlpack developers will quickly help you figure it
+One particular component of interest is mlpack_test, which runs the mlpack test
+suite.  You can build this component with
+
+ at code
+$ make mlpack_test
+ at endcode
+
+and then run all of the tests, or an individual test suite:
+
+ at code
+$ bin/mlpack_test
+$ bin/mlpack_test -t KNNTest
+ at endcode
+
+If the build fails and you cannot figure out why, register an account on Github
+and submit an issue and the mlpack developers will quickly help you figure it
 out:
 
 http://mlpack.org/
+http://github.com/mlpack/mlpack
 
 Alternately, mlpack help can be found in IRC at \#mlpack on irc.freenode.net.