From fb7f92c27c671abb0af7c00d1fc698d9321daab3 Mon Sep 17 00:00:00 2001 From: zfb132 Date: Mon, 19 Sep 2022 11:43:10 +0800 Subject: [PATCH] fix typo and update documentation --- .../doc/Documentation/advanced/Configuration_variables.txt | 6 +++--- Documentation/doc/Documentation/advanced/Installation.txt | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/Documentation/doc/Documentation/advanced/Configuration_variables.txt b/Documentation/doc/Documentation/advanced/Configuration_variables.txt index f989032bbae..8434b496014 100644 --- a/Documentation/doc/Documentation/advanced/Configuration_variables.txt +++ b/Documentation/doc/Documentation/advanced/Configuration_variables.txt @@ -72,12 +72,12 @@ and will serverly limit performances. | Variable | Description | Type | %Default Value | | :- | :- | :- | :- | -| `CMAKE_BUILD_TYPE` | Indicates type of build. Possible values are 'Debug' or 'Release' | CMake | | -| `CMAKE_INSTALL_PREFIX`| Installation directory path | CMake | Debug | +| `CMAKE_BUILD_TYPE` | Indicates type of build. Possible values are 'Debug' or 'Release' | CMake | none | +| `CMAKE_INSTALL_PREFIX`| Installation directory path | CMake | platform-dependent | | `CMAKE_C_COMPILER` | Full-path to the executable corresponding to the C compiler to use. | CMake | platform-dependent | | `CMAKE_CXX_COMPILER` | Full-path to the executable corresponding to the C++ compiler to use. | CMake | platform-dependent | | `CXX` | Idem | Environment | Idem | -| `BUILD_SHARED_LIBS` | Whether to build shared or static libraries. | CMake | TRUE | +| `BUILD_SHARED_LIBS` | Whether to build shared or static libraries. | CMake | ON | \subsection installation_variables_building Variables Used Only When Building Programs (Such as Demos or Examples) diff --git a/Documentation/doc/Documentation/advanced/Installation.txt b/Documentation/doc/Documentation/advanced/Installation.txt index ab58f2a1083..9881e8548e3 100644 --- a/Documentation/doc/Documentation/advanced/Installation.txt +++ b/Documentation/doc/Documentation/advanced/Installation.txt @@ -78,7 +78,7 @@ might need these \cgal-libraries and thus their dependencies. See the page \subsection installation_debugrelease Debug vs. Release The CMake variable `CMAKE_BUILD_TYPE` indicates how to build the executables. -It accepts the values `Debug` or `Release`. Note that the default value is `Debug`, since it is +It accepts the values `Debug` or `Release`. Note that the default value is an empty string, since it is default value in `CMake`. If you do not plan on debugging, it is important to set the variable to `Release` for performance reasons. @@ -137,7 +137,9 @@ Providing information and pressing *Configure* goes on until all entries are grayed. You are now ready to press *Generate*. Once this is done, you can quit `cmake-gui`. -If you do not need to debug, you should set the variable `CMAKE_BUILD_TYPE` to `Release`. +Without an explicit `CMAKE_BUILD_TYPE`, `CMake` does not add any additional build flags. +This will result in a default build without any optimizations and without any debug symbols. +You should set the variable `CMAKE_BUILD_TYPE` to `Release` or `Debug` to enable optimizations or debug symbols. \subsection installation_configuring_cmd Configuring CGAL with the cmake Command-Line Tool