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/CheckCCompilerFlag.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/CheckCCompilerFlag.cmake')
-rw-r--r-- | Modules/CheckCCompilerFlag.cmake | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake index dab5710..efdac20 100644 --- a/Modules/CheckCCompilerFlag.cmake +++ b/Modules/CheckCCompilerFlag.cmake @@ -1,14 +1,22 @@ -# - Check whether the C compiler supports a given flag. +#.rst: +# CheckCCompilerFlag +# ------------------ +# +# Check whether the C compiler supports a given flag. +# # CHECK_C_COMPILER_FLAG(<flag> <var>) -# <flag> - the compiler flag -# <var> - variable to store the result -# This internally calls the check_c_source_compiles macro and -# sets CMAKE_REQUIRED_DEFINITIONS to <flag>. -# See help for CheckCSourceCompiles for a listing of variables -# that can otherwise modify the build. -# The result only tells that the compiler does not give an error message when -# it encounters the flag. If the flag has any effect or even a specific one is -# beyond the scope of this module. +# +# :: +# +# <flag> - the compiler flag +# <var> - variable to store the result +# +# This internally calls the check_c_source_compiles macro and sets +# CMAKE_REQUIRED_DEFINITIONS to <flag>. See help for +# CheckCSourceCompiles for a listing of variables that can otherwise +# modify the build. The result only tells that the compiler does not +# give an error message when it encounters the flag. If the flag has +# any effect or even a specific one is beyond the scope of this module. #============================================================================= # Copyright 2006-2011 Kitware, Inc. |