From d118617e292762989a0960f4b0a6cef4dd28d6d2 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Tue, 22 Mar 2022 11:09:25 -0500 Subject: [PATCH] added section on build types to install doc --- docs/source/usersguide/install.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 7aa1fdcff5..d5b1c7e41e 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -363,6 +363,27 @@ should be used: .. _usersguide_compile_mpi: +Specifying the Build Type ++++++++++++++++++++++++++ + +OpenMC can be configured for debug, release, or release with debug info by setting +the `CMAKE_BUILD_TYPE` option. + +Debug + Enable debug compiler flags with no optimization `-O0 -g`. + +Release + Disable debug and enable optimization `-O3 -DNDEBUG`. + +RelWithDebInfo + (Default if no type is specified.) Enable optimization and debug `-O2 -g`. + +Example of configuring for Debug mode: + +.. code-block:: sh + + cmake -DCMAKE_BUILD_TYPE=Debug /path/to/openmc + Compiling with MPI ++++++++++++++++++