summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2020-08-23 09:17:25 +0200
committerGitHub <noreply@github.com>2020-08-23 09:17:25 +0200
commit89b1806f83542b68b4e395c26026dbf90629e825 (patch)
tree816a09a3d7eee8577a9267a23f9e13560695315f
parent0e620832b3b6d2e1027ead9730dce872983dd2ce (diff)
parent3845d669233afda0cb50270e3204c87d2814626f (diff)
Merge pull request #384 from VincentRouvreau/cmake_release_build_type_doc
Add -DCMAKE_BUILD_TYPE=Release on installation doc
-rw-r--r--src/common/doc/installation.h10
-rw-r--r--src/python/doc/installation.rst2
2 files changed, 6 insertions, 6 deletions
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h
index ce2c5448..6af645e2 100644
--- a/src/common/doc/installation.h
+++ b/src/common/doc/installation.h
@@ -14,13 +14,13 @@
\verbatim cd /path-to-gudhi/
mkdir build
cd build/
-cmake ..
+cmake -DCMAKE_BUILD_TYPE=Release ..
make \endverbatim
* By default, examples are disabled. You can activate their compilation with
* <a href="https://cmake.org/cmake/help/v3.0/manual/ccmake.1.html">ccmake</a> (on Linux and Mac OSX),
* <a href="https://cmake.org/cmake/help/v3.0/manual/cmake-gui.1.html">cmake-gui</a> (on Windows) or by modifying the
* cmake command as follows :
-\verbatim cmake -DWITH_GUDHI_EXAMPLE=ON ..
+\verbatim cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_EXAMPLE=ON ..
make \endverbatim
* A list of utilities and examples is available <a href="examples.html">here</a>.
*
@@ -66,9 +66,9 @@ make doxygen
* Some GUDHI modules (cf. \ref main_page "modules list"), and few examples require CGAL, a C++ library that provides
* easy access to efficient and reliable geometric algorithms.
*
- * \note There is no need to install CGAL, you can just <CODE>cmake . && make</CODE> CGAL (or even
- * <CODE>cmake -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to compile
- * GUDHI by calling <CODE>cmake -DCGAL_DIR=/your/path/to/CGAL-X.Y .. && make</CODE>
+ * \note There is no need to install CGAL, you can just <CODE>cmake -DCMAKE_BUILD_TYPE=Release . && make</CODE> CGAL
+ * (or even <CODE>cmake -DCMAKE_BUILD_TYPE=Release -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to
+ * compile GUDHI by calling <CODE>cmake -DCMAKE_BUILD_TYPE=Release -DCGAL_DIR=/your/path/to/CGAL-X.Y .. && make</CODE>
*
* The procedure to install this library according to
* your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html
diff --git a/src/python/doc/installation.rst b/src/python/doc/installation.rst
index 78e1af73..4cc31d5c 100644
--- a/src/python/doc/installation.rst
+++ b/src/python/doc/installation.rst
@@ -65,7 +65,7 @@ one can build the GUDHI Python module, by running the following commands in a te
cd /path-to-gudhi/
mkdir build
cd build/
- cmake ..
+ cmake -DCMAKE_BUILD_TYPE=Release ..
cd python
make