From 0655e7392960758efa2791c80a245620b4590bb1 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Mon, 21 Mar 2022 15:51:19 -0500 Subject: [PATCH] removed debug and optimize options from install docs --- docs/source/usersguide/install.rst | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index fb721c7ce9..ebcd20eb48 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -331,17 +331,9 @@ CMakeLists.txt Options The following options are available in the CMakeLists.txt file: -debug - Enables debugging when compiling. The flags added are dependent on which - compiler is used. - profile Enables profiling using the GNU profiler, gprof. -optimize - Enables high-optimization using compiler-dependent flags. For gcc and - Intel C++, this compiles with -O3. - openmp Enables shared-memory parallelism using the OpenMP API. The C++ compiler being used must support OpenMP. (Default: on) @@ -360,12 +352,12 @@ coverage Compile and link code instrumented for coverage analysis. This is typically used in conjunction with gcov_. -To set any of these options (e.g. turning on debug mode), the following form +To set any of these options (e.g. turning on profiling), the following form should be used: .. code-block:: sh - cmake -Ddebug=on /path/to/openmc + cmake -Dprofile=on /path/to/openmc .. _gcov: https://gcc.gnu.org/onlinedocs/gcc/Gcov.html