summaryrefslogtreecommitdiff
path: root/Modules/ProcessorCount.cmake
diff options
context:
space:
mode:
authorscivision <scivision@users.noreply.github.com>2023-01-16 15:29:26 -0500
committerscivision <scivision@users.noreply.github.com>2023-01-16 15:30:06 -0500
commit93624e4c3d7dbf3e1a2ad60566ec012624116409 (patch)
tree2d65d7709f3c1cc1727f3f39b391b2ee24fe4c39 /Modules/ProcessorCount.cmake
parent87d28dd804a51ffb980191dc18577bbb4331ee3d (diff)
downloadcmake-93624e4c3d7dbf3e1a2ad60566ec012624116409.tar.gz
Help:ProcessorCount: recommend cmake_host_system_information
closes #24277
Diffstat (limited to 'Modules/ProcessorCount.cmake')
-rw-r--r--Modules/ProcessorCount.cmake12
1 files changed, 9 insertions, 3 deletions
diff --git a/Modules/ProcessorCount.cmake b/Modules/ProcessorCount.cmake
index bda23ab682..47e266dcfb 100644
--- a/Modules/ProcessorCount.cmake
+++ b/Modules/ProcessorCount.cmake
@@ -22,9 +22,17 @@ This function is guaranteed to return a positive integer (>=1) if it
succeeds. It returns 0 if there's a problem determining the processor
count.
+More generally accurate physical CPU count can be obtained via
+:command:`cmake_host_system_information`:
+
+.. code-block:: cmake
+
+ cmake_host_system_information(RESULT N
+ QUERY NUMBER_OF_PHYSICAL_CORES)
+
Example use, in a ctest -S dashboard script:
-::
+.. code-block:: cmake
include(ProcessorCount)
ProcessorCount(N)
@@ -33,8 +41,6 @@ Example use, in a ctest -S dashboard script:
set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N})
endif()
-
-
This function is intended to offer an approximation of the value of
the number of compute cores available on the current machine, such
that you may use that value for parallel building and parallel