Check{,C,CXX,OBJC,OBJCXX,Fortran}SourceCompiles: Update documentation

Changes:

- Added intro code blocks showing how to include these modules.
- Added examples sections.
- Used "command" instead of "macro".
- Commands sections added to have a clearer overview of the modules at
  first encounter.
- Reworded commands arguments a bit.
- Added a rubric title for variables that affect the checks.
- CheckFortranSourceCompiles: Added CMake version when SRC_EXT option
  was introduced.
- Listed CMAKE_TRY_COMPILE_TARGET_TYPE variable in the rubric together
  with CMAKE_REQUIRED_* variables and added an include RST file for it.
- Used lowercase style for check_fortran_source_compiles().
This commit is contained in:
Peter Kokot
2025-05-26 02:35:45 +02:00
parent cfcff29087
commit e6f9ebbbe1
12 changed files with 501 additions and 143 deletions
@@ -0,0 +1,6 @@
:variable:`CMAKE_TRY_COMPILE_TARGET_TYPE`
Internally, the :command:`try_compile` command is used to perform the
check, and this variable controls the type of target it creates. If this
variable is set to ``EXECUTABLE`` (the default), the check compiles and
links the test source code as an executable program. If set to
``STATIC_LIBRARY``, the test source code is compiled but not linked.