mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-04 12:49:36 -06:00
c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
59 lines
2.9 KiB
ReStructuredText
59 lines
2.9 KiB
ReStructuredText
cmake_host_system_information
|
|
-----------------------------
|
|
|
|
Query host system specific information.
|
|
|
|
.. code-block:: cmake
|
|
|
|
cmake_host_system_information(RESULT <variable> QUERY <key> ...)
|
|
|
|
Queries system information of the host system on which cmake runs.
|
|
One or more ``<key>`` can be provided to select the information to be
|
|
queried. The list of queried values is stored in ``<variable>``.
|
|
|
|
``<key>`` can be one of the following values:
|
|
|
|
============================= ================================================
|
|
Key Description
|
|
============================= ================================================
|
|
``NUMBER_OF_LOGICAL_CORES`` Number of logical cores
|
|
``NUMBER_OF_PHYSICAL_CORES`` Number of physical cores
|
|
``HOSTNAME`` Hostname
|
|
``FQDN`` Fully qualified domain name
|
|
``TOTAL_VIRTUAL_MEMORY`` Total virtual memory in MiB [#mebibytes]_
|
|
``AVAILABLE_VIRTUAL_MEMORY`` Available virtual memory in MiB [#mebibytes]_
|
|
``TOTAL_PHYSICAL_MEMORY`` Total physical memory in MiB [#mebibytes]_
|
|
``AVAILABLE_PHYSICAL_MEMORY`` Available physical memory in MiB [#mebibytes]_
|
|
============================= ================================================
|
|
|
|
.. versionadded:: 3.10
|
|
Additional ``<key>`` values are available:
|
|
|
|
============================= ================================================
|
|
Key Description
|
|
============================= ================================================
|
|
``IS_64BIT`` One if processor is 64Bit
|
|
``HAS_FPU`` One if processor has floating point unit
|
|
``HAS_MMX`` One if processor supports MMX instructions
|
|
``HAS_MMX_PLUS`` One if processor supports Ext. MMX instructions
|
|
``HAS_SSE`` One if processor supports SSE instructions
|
|
``HAS_SSE2`` One if processor supports SSE2 instructions
|
|
``HAS_SSE_FP`` One if processor supports SSE FP instructions
|
|
``HAS_SSE_MMX`` One if processor supports SSE MMX instructions
|
|
``HAS_AMD_3DNOW`` One if processor supports 3DNow instructions
|
|
``HAS_AMD_3DNOW_PLUS`` One if processor supports 3DNow+ instructions
|
|
``HAS_IA64`` One if IA64 processor emulating x86
|
|
``HAS_SERIAL_NUMBER`` One if processor has serial number
|
|
``PROCESSOR_SERIAL_NUMBER`` Processor serial number
|
|
``PROCESSOR_NAME`` Human readable processor name
|
|
``PROCESSOR_DESCRIPTION`` Human readable full processor description
|
|
``OS_NAME`` See :variable:`CMAKE_HOST_SYSTEM_NAME`
|
|
``OS_RELEASE`` The OS sub-type e.g. on Windows ``Professional``
|
|
``OS_VERSION`` The OS build ID
|
|
``OS_PLATFORM`` See :variable:`CMAKE_HOST_SYSTEM_PROCESSOR`
|
|
============================= ================================================
|
|
|
|
.. rubric:: Footnotes
|
|
|
|
.. [#mebibytes] One MiB (mebibyte) is equal to 1024x1024 bytes.
|