[Cmake-commits] [cmake-commits] king committed CheckCCompilerFlag.cmake 1.2 1.3 CheckCSourceCompiles.cmake 1.18 1.19 CheckCSourceRuns.cmake 1.11 1.12 CheckCXXCompilerFlag.cmake 1.1 1.2 CheckCXXSourceCompiles.cmake 1.15 1.16 CheckCXXSourceRuns.cmake 1.7 1.8

cmake-commits at cmake.org cmake-commits at cmake.org
Thu Sep 17 15:28:53 EDT 2009


Update of /cvsroot/CMake/CMake/Modules
In directory public:/mounts/ram/cvs-serv28791/Modules

Modified Files:
	CheckCCompilerFlag.cmake CheckCSourceCompiles.cmake 
	CheckCSourceRuns.cmake CheckCXXCompilerFlag.cmake 
	CheckCXXSourceCompiles.cmake CheckCXXSourceRuns.cmake 
Log Message:
Cleanup generic compiler check macro documentation

This commit improves formatting and style of the documentation for the
general-purpose compiler check macros:

  CHECK_C_COMPILER_FLAG
  CHECK_C_SOURCE_COMPILES
  CHECK_C_SOURCE_RUNS
  CHECK_CXX_COMPILER_FLAG
  CHECK_CXX_SOURCE_COMPILES
  CHECK_CXX_SOURCE_RUNS

This sytle is more consistent with CMake command documentation.
It also looks nicer in the generated documentation text files.


Index: CheckCXXSourceCompiles.cmake
===================================================================
RCS file: /cvsroot/CMake/CMake/Modules/CheckCXXSourceCompiles.cmake,v
retrieving revision 1.15
retrieving revision 1.16
diff -C 2 -d -r1.15 -r1.16
*** CheckCXXSourceCompiles.cmake	11 Mar 2009 22:13:52 -0000	1.15
--- CheckCXXSourceCompiles.cmake	17 Sep 2009 19:28:51 -0000	1.16
***************
*** 1,8 ****
! # - Check if the C++ source code provided in the SOURCE argument compiles.
! # CHECK_CXX_SOURCE_COMPILES(SOURCE VAR)
! #
! #  SOURCE - source code to try to compile
! #  VAR    - variable to store whether the source code compiled
! #
  # The following variables may be set before calling this macro to
  # modify the way the check is run:
--- 1,6 ----
! # - Check if the given C++ source code compiles.
! # CHECK_CXX_SOURCE_COMPILES(<code> <var>)
! #  <code>       - source code to try to compile
! #  <var>        - variable to store whether the source code compiled
  # The following variables may be set before calling this macro to
  # modify the way the check is run:

Index: CheckCSourceRuns.cmake
===================================================================
RCS file: /cvsroot/CMake/CMake/Modules/CheckCSourceRuns.cmake,v
retrieving revision 1.11
retrieving revision 1.12
diff -C 2 -d -r1.11 -r1.12
*** CheckCSourceRuns.cmake	11 Mar 2009 22:13:51 -0000	1.11
--- CheckCSourceRuns.cmake	17 Sep 2009 19:28:50 -0000	1.12
***************
*** 1,8 ****
! # - Check if the C source code provided in the SOURCE argument compiles and runs.
! # CHECK_C_SOURCE_RUNS(SOURCE VAR)
! #
! #  SOURCE   - source code to try to compile
! #  VAR      - variable to store the result, 1 for success, empty for failure
! #
  # The following variables may be set before calling this macro to
  # modify the way the check is run:
--- 1,7 ----
! # - Check if the given C source code compiles and runs.
! # CHECK_C_SOURCE_RUNS(<code> <var>)
! #  <code>   - source code to try to compile
! #  <var>    - variable to store the result
! #             (1 for success, empty for failure)
  # The following variables may be set before calling this macro to
  # modify the way the check is run:

Index: CheckCSourceCompiles.cmake
===================================================================
RCS file: /cvsroot/CMake/CMake/Modules/CheckCSourceCompiles.cmake,v
retrieving revision 1.18
retrieving revision 1.19
diff -C 2 -d -r1.18 -r1.19
*** CheckCSourceCompiles.cmake	11 Mar 2009 22:13:51 -0000	1.18
--- CheckCSourceCompiles.cmake	17 Sep 2009 19:28:50 -0000	1.19
***************
*** 1,8 ****
! # - Check if the C source code provided in the SOURCE argument compiles.
! # CHECK_C_SOURCE_COMPILES(SOURCE VAR)
! #
! #  SOURCE   - source code to try to compile
! #  VAR      - variable to store whether the source code compiled
! #
  # The following variables may be set before calling this macro to
  # modify the way the check is run:
--- 1,6 ----
! # - Check if the given C source code compiles.
! # CHECK_C_SOURCE_COMPILES(<code> <var>)
! #  <code>       - source code to try to compile
! #  <var>        - variable to store whether the source code compiled
  # The following variables may be set before calling this macro to
  # modify the way the check is run:

Index: CheckCXXSourceRuns.cmake
===================================================================
RCS file: /cvsroot/CMake/CMake/Modules/CheckCXXSourceRuns.cmake,v
retrieving revision 1.7
retrieving revision 1.8
diff -C 2 -d -r1.7 -r1.8
*** CheckCXXSourceRuns.cmake	11 Mar 2009 22:13:53 -0000	1.7
--- CheckCXXSourceRuns.cmake	17 Sep 2009 19:28:51 -0000	1.8
***************
*** 1,8 ****
! # - Check if the C++ source code provided in the SOURCE argument compiles and runs.
! # CHECK_CXX_SOURCE_RUNS(SOURCE VAR)
! #
! #  SOURCE - source code to try to compile
! #  VAR    - variable to store the result, 1 for success, empty for failure
! #
  # The following variables may be set before calling this macro to
  # modify the way the check is run:
--- 1,7 ----
! # - Check if the given C++ source code compiles and runs.
! # CHECK_CXX_SOURCE_RUNS(<code> <var>)
! #  <code>   - source code to try to compile
! #  <var>    - variable to store the result
! #             (1 for success, empty for failure)
  # The following variables may be set before calling this macro to
  # modify the way the check is run:

Index: CheckCXXCompilerFlag.cmake
===================================================================
RCS file: /cvsroot/CMake/CMake/Modules/CheckCXXCompilerFlag.cmake,v
retrieving revision 1.1
retrieving revision 1.2
diff -C 2 -d -r1.1 -r1.2
*** CheckCXXCompilerFlag.cmake	18 Sep 2006 21:55:22 -0000	1.1
--- CheckCXXCompilerFlag.cmake	17 Sep 2009 19:28:51 -0000	1.2
***************
*** 1,7 ****
  # - Check whether the CXX compiler supports a given flag.
! # CHECK_CXX_COMPILER_FLAG(FLAG VARIABLE)
! #
! #  FLAG - the compiler flag
! #  VARIABLE - variable to store the result
  
  # Copyright (c) 2006, Alexander Neundorf, <neundorf at kde.org>
--- 1,9 ----
  # - Check whether the CXX compiler supports a given flag.
! # CHECK_CXX_COMPILER_FLAG(<flag> <var>)
! #  <flag> - the compiler flag
! #  <var>  - variable to store the result
! # This internally calls the check_cxx_source_compiles macro.  See help
! # for CheckCXXSourceCompiles for a listing of variables that can
! # modify the build.
  
  # Copyright (c) 2006, Alexander Neundorf, <neundorf at kde.org>

Index: CheckCCompilerFlag.cmake
===================================================================
RCS file: /cvsroot/CMake/CMake/Modules/CheckCCompilerFlag.cmake,v
retrieving revision 1.2
retrieving revision 1.3
diff -C 2 -d -r1.2 -r1.3
*** CheckCCompilerFlag.cmake	9 Sep 2008 18:12:48 -0000	1.2
--- CheckCCompilerFlag.cmake	17 Sep 2009 19:28:50 -0000	1.3
***************
*** 1,11 ****
  # - Check whether the C compiler supports a given flag.
! # CHECK_C_COMPILER_FLAG(FLAG VARIABLE)
! #
! #  FLAG - the compiler flag
! #  VARIABLE - variable to store the result
! # 
! #  This actually calls the check_c_source_compiles macro.
! #  See help for CheckCSourceCompiles for a listing of variables
! #  that can modify the build.
  
  # Copyright (c) 2006, Alexander Neundorf, <neundorf at kde.org>
--- 1,9 ----
  # - 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.
! # See help for CheckCSourceCompiles for a listing of variables
! # that can modify the build.
  
  # Copyright (c) 2006, Alexander Neundorf, <neundorf at kde.org>



More information about the Cmake-commits mailing list