Merge pull request #1266 from junghans/cmake_doc

doc: add CMAKE_VERBOSE_MAKEFILE and CXX_COMPILER_LAUNCHER
This commit is contained in:
Axel Kohlmeyer 2018-12-29 12:09:06 -05:00 committed by GitHub
commit dd028e9071
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 2 deletions

View File

@ -24,7 +24,7 @@ tasks, act as a reference and provide examples of typical use cases.
* [Build directory vs. Source Directory](#build-directory-vs-source-directory)
* [Defining and using presets](#defining-and-using-presets)
* [Reference](#reference)
* [Common CMAKE Configuration Options](#common-cmake-configuration-options)
* [Common CMake Configuration Options](#common-cmake-configuration-options)
* [LAMMPS Configuration Options](#lammps-configuration-options)
* [Parallelization and Accelerator Packages](#parallelization-and-accelerator-packages)
* [Default Packages](#default-packages)
@ -179,7 +179,7 @@ cmake -C ../cmake/presets/std_nolib.cmake -D PKG_GPU=on ../cmake
# Reference
## Common CMAKE Configuration Options
## Common CMake Configuration Options
<table>
@ -208,6 +208,16 @@ cmake -C ../cmake/presets/std_nolib.cmake -D PKG_GPU=on ../cmake
</dl>
</td>
</tr>
<tr>
<td><code><CMAKE_VERBOSE_MAKEFILE/code></td>
<td>Enable verbose output from Makefile builds (useful for debugging), the same can be achived by adding `VERBOSE=1` to the `make` call.</td>
<td>
<dl>
<dt><code>off</code> (default)</dt>
<dt><code>on</code></dt>
</dl>
</td>
</tr>
</tbody>
</table>
@ -1729,6 +1739,13 @@ cache by setting the `CMAKE_C_COMPILER`, `CMAKE_CXX_COMPILER`,
value of `FC` environment variable at first `cmake` run
</td>
</tr>
<tr>
<td><code>CXX_COMPILER_LAUNCHER</code></td>
<td>CMake will run this tool and pass the compiler and its arguments to the tool. Some example tools are distcc and ccache.</td>
<td>
(empty)
</td>
</tr>
</tbody>
</table>