summaryrefslogtreecommitdiffstats
path: root/Modules/CMakeForceCompiler.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'Modules/CMakeForceCompiler.cmake')
-rw-r--r--Modules/CMakeForceCompiler.cmake47
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.