diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 15:17:36 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-15 18:12:03 (GMT) |
| commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
| tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/CMakeForceCompiler.cmake | |
| parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
| download | CMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2 | |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Modules/CMakeForceCompiler.cmake')
| -rw-r--r-- | Modules/CMakeForceCompiler.cmake | 47 |
1 files changed, 34 insertions, 13 deletions
diff --git a/Modules/CMakeForceCompiler.cmake b/Modules/CMakeForceCompiler.cmake index 207c8ad..0e6b5af 100644 --- a/Modules/CMakeForceCompiler.cmake +++ b/Modules/CMakeForceCompiler.cmake @@ -1,33 +1,54 @@ +#.rst: +# CMakeForceCompiler +# ------------------ +# +# +# # This module defines macros intended for use by cross-compiling # toolchain files when CMake is not able to automatically detect the # compiler identification. # # 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. +# +# :: +# +# 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. # # Macro CMAKE_FORCE_CXX_COMPILER has the following signature: -# CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>) +# +# :: +# +# 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 +# internal variable CMAKE_CXX_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: -# CMAKE_FORCE_Fortran_COMPILER(<compiler> <compiler-id>) +# +# :: +# +# 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. # # So a simple toolchain file could look like this: -# include (CMakeForceCompiler) -# set(CMAKE_SYSTEM_NAME Generic) -# CMAKE_FORCE_C_COMPILER (chc12 MetrowerksHicross) -# CMAKE_FORCE_CXX_COMPILER (chc12 MetrowerksHicross) +# +# :: +# +# include (CMakeForceCompiler) +# set(CMAKE_SYSTEM_NAME Generic) +# CMAKE_FORCE_C_COMPILER (chc12 MetrowerksHicross) +# CMAKE_FORCE_CXX_COMPILER (chc12 MetrowerksHicross) #============================================================================= # Copyright 2007-2009 Kitware, Inc. |