Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00
Code Issues Projects Releases Wiki Activity

CMAKE_COMPILER_IS_*: Add RST deprecation directives and update docs

Browse Source 
The `CMAKE_COMPILER_IS_*` variables have been documented as deprecated
since CMake 3.24, without emitting warnings.  This commit updates their
documentation to help users safely migrate to `CMAKE_<LANG>_COMPILER_ID`
variables. Also a RST deprecation directive is added to clarify their
status.
This commit is contained in:
Peter Kokot
2025-03-28 21:14:19 +01:00
parent e0b64aad53
commit 7db3f983b3
3 changed files with 117 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
Help/variable/CMAKE_COMPILER_IS_GNUCC.rst
View File

@@ -1,7 +1,47 @@
CMAKE_COMPILER_IS_GNUCC
-----------------------
True if the ``C`` compiler is GNU.
.. deprecated:: 3.24
This variable is deprecated. Use
:variable:`CMAKE_C_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead.
Use the :variable:`CMAKE_C_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` variable
instead.
The ``CMAKE_COMPILER_IS_*`` variables were used in early CMake versions before
the introduction of :variable:`CMAKE_<LANG>_COMPILER_ID` variables in CMake
2.6.
The ``CMAKE_COMPILER_IS_GNUCC`` variable is set to boolean true if the ``C``
compiler is GNU.
Examples
^^^^^^^^
In earlier versions of CMake, the ``CMAKE_COMPILER_IS_GNUCC`` variable was used
to check if the ``C`` compiler was GNU:
.. code-block:: cmake
if(CMAKE_COMPILER_IS_GNUCC)
# GNU C compiler-specific logic.
endif()
Starting with CMake 2.6, the ``CMAKE_C_COMPILER_ID`` variable should be used
instead:
.. code-block:: cmake
if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
# GNU C compiler-specific logic.
endif()
When upgrading code, consider whether additional ``C`` compilers should be
targeted beyond just ``GNU``. In the past, the ``LCC`` and ``QCC`` compilers
also had this variable set (see :policy:`CMP0047` and :policy:`CMP0129` policies
for details). To account for this, the following approach can be used:
.. code-block:: cmake
# Targeting GNU, LCC, and QCC compilers for C:
if(CMAKE_C_COMPILER_ID MATCHES "^(GNU|LCC|QCC)$")
# ...
endif()

46
Help/variable/CMAKE_COMPILER_IS_GNUCXX.rst
View File

@@ -1,7 +1,47 @@
CMAKE_COMPILER_IS_GNUCXX
------------------------
True if the C++ (``CXX``) compiler is GNU.
.. deprecated:: 3.24
This variable is deprecated. Use
:variable:`CMAKE_CXX_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead.
Use the :variable:`CMAKE_CXX_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` variable
instead.
The ``CMAKE_COMPILER_IS_*`` variables were used in early CMake versions before
the introduction of :variable:`CMAKE_<LANG>_COMPILER_ID` variables in CMake
2.6.
The ``CMAKE_COMPILER_IS_GNUCXX`` variable is set to boolean true if the C++
(``CXX``) compiler is GNU.
Examples
^^^^^^^^
In earlier versions of CMake, the ``CMAKE_COMPILER_IS_GNUCXX`` variable was used
to check if the ``CXX`` compiler was GNU:
.. code-block:: cmake
if(CMAKE_COMPILER_IS_GNUCXX)
# GNU C++ compiler-specific logic.
endif()
Starting with CMake 2.6, the ``CMAKE_CXX_COMPILER_ID`` variable should be used
instead:
.. code-block:: cmake
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
# GNU C++ compiler-specific logic.
endif()
When upgrading code, consider whether additional ``CXX`` compilers should be
targeted beyond just ``GNU``. In the past, the ``LCC`` and ``QCC`` compilers
also had this variable set (see :policy:`CMP0047` and :policy:`CMP0129` policies
for details). To account for this, the following approach can be used:
.. code-block:: cmake
# Targeting GNU, LCC, and QCC compilers for CXX:
if(CMAKE_CXX_COMPILER_ID MATCHES "^(GNU|LCC|QCC)$")
# ...
endif()

34
Help/variable/CMAKE_COMPILER_IS_GNUG77.rst
View File

@@ -1,7 +1,35 @@
CMAKE_COMPILER_IS_GNUG77
------------------------
True if the ``Fortran`` compiler is GNU.
.. deprecated:: 3.24
This variable is deprecated. Use
:variable:`CMAKE_Fortran_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead.
Use the :variable:`CMAKE_Fortran_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>`
variable instead.
The ``CMAKE_COMPILER_IS_*`` variables were used in early CMake versions before
the introduction of :variable:`CMAKE_<LANG>_COMPILER_ID` variables in CMake
2.6.
The ``CMAKE_COMPILER_IS_GNUG77`` variable is set to boolean true if the
``Fortran`` compiler is GNU.
Examples
^^^^^^^^
In earlier versions of CMake, the ``CMAKE_COMPILER_IS_GNUG77`` variable was used
to check if the ``Fortran`` compiler was GNU:
.. code-block:: cmake
if(CMAKE_COMPILER_IS_GNUG77)
# GNU Fortran compiler-specific logic.
endif()
Starting with CMake 2.6, the ``CMAKE_Fortran_COMPILER_ID`` variable should be
used instead:
.. code-block:: cmake
if(CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
# GNU Fortran compiler-specific logic.
endif()