diff options
| author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-12 14:37:05 (GMT) |
|---|---|---|
| committer | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-23 08:39:34 (GMT) |
| commit | cb811d11cee1e2873cc2bf506cd081769e894ac3 (patch) | |
| tree | 6fa97b0fb931bfbc6faaf866c3e745a0fd5ea430 /Modules/CMakeForceCompiler.cmake | |
| parent | 4ff7706f2d7eaaffe3970da5f77d18f67771a4a8 (diff) | |
| download | CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.zip CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.gz CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.bz2 | |
Help: Improve description of modules
Diffstat (limited to 'Modules/CMakeForceCompiler.cmake')
| -rw-r--r-- | Modules/CMakeForceCompiler.cmake | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/Modules/CMakeForceCompiler.cmake b/Modules/CMakeForceCompiler.cmake index 7ac09dc..7048806 100644 --- a/Modules/CMakeForceCompiler.cmake +++ b/Modules/CMakeForceCompiler.cmake @@ -25,38 +25,41 @@ toolchain file instead. ------------------------------------------------------------------------- -Macro CMAKE_FORCE_C_COMPILER has the following signature: +Macro ``CMAKE_FORCE_C_COMPILER`` has the following signature: :: CMAKE_FORCE_C_COMPILER(<compiler> <compiler-id>) -It sets CMAKE_C_COMPILER to the given compiler and the cmake internal -variable CMAKE_C_COMPILER_ID to the given compiler-id. It also -bypasses the check for working compiler and basic compiler information -tests. +It sets :variable:`CMAKE_C_COMPILER <CMAKE_<LANG>_COMPILER>` to +the given compiler and the cmake internal variable +:variable:`CMAKE_C_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` to the given +compiler-id. It also bypasses the check for working compiler and basic +compiler information tests. -Macro CMAKE_FORCE_CXX_COMPILER has the following signature: +Macro ``CMAKE_FORCE_CXX_COMPILER`` has the following signature: :: CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>) -It sets CMAKE_CXX_COMPILER to the given compiler and the cmake -internal variable CMAKE_CXX_COMPILER_ID to the given compiler-id. It -also bypasses the check for working compiler and basic compiler -information tests. +It sets :variable:`CMAKE_CXX_COMPILER <CMAKE_<LANG>_COMPILER>` to +the given compiler and the cmake internal variable +:variable:`CMAKE_CXX_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` to the given +compiler-id. It also bypasses the check for working compiler and basic +compiler information tests. -Macro CMAKE_FORCE_Fortran_COMPILER has the following signature: +Macro ``CMAKE_FORCE_Fortran_COMPILER`` has the following signature: :: CMAKE_FORCE_Fortran_COMPILER(<compiler> <compiler-id>) -It sets CMAKE_Fortran_COMPILER to the given compiler and the cmake -internal variable CMAKE_Fortran_COMPILER_ID to the given compiler-id. -It also bypasses the check for working compiler and basic compiler -information tests. +It sets :variable:`CMAKE_Fortran_COMPILER <CMAKE_<LANG>_COMPILER>` to +the given compiler and the cmake internal variable +:variable:`CMAKE_Fortran_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` to the given +compiler-id. It also bypasses the check for working compiler and basic +compiler information tests. So a simple toolchain file could look like this: |