[mlpack-git] master: Update documentation. (2564cf4)

gitdub at mlpack.org gitdub at mlpack.org
Mon Apr 18 12:00:19 EDT 2016


Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/cf2b62565078ffd3eb6c814bf37f286838afabae...28ae007678c8867122094fdf072793b227690404

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

commit 2564cf4c51b11bcc8ee8c70d8dd217277888ffd1
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon Apr 18 09:00:19 2016 -0700

    Update documentation.


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

2564cf4c51b11bcc8ee8c70d8dd217277888ffd1
 CMakeLists.txt                    | 2 +-
 doc/guide/build.hpp               | 3 +++
 src/mlpack/methods/CMakeLists.txt | 4 +++-
 3 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index b41b4f7..1b09ba2 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -11,13 +11,13 @@ enable_cxx11()
 
 # First, define all the compilation options.
 # We default to debugging mode for developers.
-option(BUILD_CLI_EXECUTABLES "Build command-line executables" ON)
 option(DEBUG "Compile with debugging information" ON)
 option(PROFILE "Compile with profiling information" ON)
 option(ARMA_EXTRA_DEBUG "Compile with extra Armadillo debugging symbols." OFF)
 option(MATLAB_BINDINGS "Compile MATLAB bindings if MATLAB is found." OFF)
 option(TEST_VERBOSE "Run test cases with verbose output." OFF)
 option(BUILD_TESTS "Build tests." ON)
+option(BUILD_CLI_EXECUTABLES "Build command-line executables" ON)
 
 enable_testing ()
 
diff --git a/doc/guide/build.hpp b/doc/guide/build.hpp
index 9a7ed6e..3260baa 100644
--- a/doc/guide/build.hpp
+++ b/doc/guide/build.hpp
@@ -85,6 +85,9 @@ The full list of options mlpack allows:
  - 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)
+ - BUILD_CLI_EXECUTABLES=(ON/OFF): compile the mlpack command-line executables
+       (i.e. \c mlpack_knn, \c mlpack_kfn, \c mlpack_logistic_regression, etc.)
+       (default ON)
  - TEST_VERBOSE=(ON/OFF): run test cases in \c mlpack_test with verbose output
        (default OFF)
 
diff --git a/src/mlpack/methods/CMakeLists.txt b/src/mlpack/methods/CMakeLists.txt
index 7e2fa33..d0ea04c 100644
--- a/src/mlpack/methods/CMakeLists.txt
+++ b/src/mlpack/methods/CMakeLists.txt
@@ -1,4 +1,6 @@
-
+# This macro adds a command-line executable with the given name.  It assumes
+# that the file with main() is in <name>_main.cpp, and produces an output
+# program with the name mlpack_<name>.
 macro (add_cli_executable name)
 if (BUILD_CLI_EXECUTABLES)
   add_executable(mlpack_${name}




More information about the mlpack-git mailing list