CMakePrintSystemInformation: Update documentation

This commit is contained in:
Peter Kokot 2025-03-08 22:27:42 +01:00
parent 24a1a7ac5d
commit 457bf223e6
No known key found for this signature in database
GPG Key ID: A94800907AA79B36

View File

@ -5,10 +5,26 @@
CMakePrintSystemInformation
---------------------------
Print system information.
This module can be used for diagnostics to print system information.
This module serves diagnostic purposes. Just include it in a
project to see various internal CMake variables.
Examples
^^^^^^^^
Including this module in a project:
.. code-block:: cmake
include(CMakePrintSystemInformation)
prints various internal CMake variables. For example::
CMAKE_SYSTEM is Linux-6.11.0-17-generic Linux 6.11.0-17-generic x86_64
CMAKE_SYSTEM file is Platform/Linux
CMAKE_C_COMPILER is /usr/bin/cc
CMAKE_CXX_COMPILER is /usr/bin/c++
CMAKE_SHARED_LIBRARY_CREATE_C_FLAGS is -shared
CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS is -shared
...
#]=======================================================================]
message("CMAKE_SYSTEM is ${CMAKE_SYSTEM} ${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION} ${CMAKE_SYSTEM_PROCESSOR}")