diff options
| author | Taylor Holberton <taylorcholberton@gmail.com> | 2018-09-02 14:16:56 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-09-10 07:55:07 (GMT) |
| commit | 228a2b0d825712d6648f7bdf920850c7f38ed2b4 (patch) | |
| tree | 2c0eaab4dae75567db3d2da085334b9c5218ba6b /Help/command/cmake_host_system_information.rst | |
| parent | d5a12cc84dd671288eae8b81ba4e8bac29755bb8 (diff) | |
| download | CMake-228a2b0d825712d6648f7bdf920850c7f38ed2b4.zip CMake-228a2b0d825712d6648f7bdf920850c7f38ed2b4.tar.gz CMake-228a2b0d825712d6648f7bdf920850c7f38ed2b4.tar.bz2 | |
Help: Clarify cmake_host_system_information memory units
The memory size query implementations report in units of one mebibyte
(2^20). Clarify the unit in the documentation because "megabyte" might
also be interpreted as 10^6.
Diffstat (limited to 'Help/command/cmake_host_system_information.rst')
| -rw-r--r-- | Help/command/cmake_host_system_information.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/Help/command/cmake_host_system_information.rst b/Help/command/cmake_host_system_information.rst index 9893151..2dee93a 100644 --- a/Help/command/cmake_host_system_information.rst +++ b/Help/command/cmake_host_system_information.rst @@ -20,10 +20,10 @@ Key Description ``NUMBER_OF_PHYSICAL_CORES`` Number of physical cores ``HOSTNAME`` Hostname ``FQDN`` Fully qualified domain name -``TOTAL_VIRTUAL_MEMORY`` Total virtual memory in megabytes -``AVAILABLE_VIRTUAL_MEMORY`` Available virtual memory in megabytes -``TOTAL_PHYSICAL_MEMORY`` Total physical memory in megabytes -``AVAILABLE_PHYSICAL_MEMORY`` Available physical memory in megabytes +``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]_ ``IS_64BIT`` One if processor is 64Bit ``HAS_FPU`` One if processor has floating point unit ``HAS_MMX`` One if processor supports MMX instructions @@ -44,3 +44,7 @@ Key Description ``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. |