Browse Source

Merge topic 'docpc'

93624e4c3d Help:ProcessorCount: recommend cmake_host_system_information

Acked-by: Kitware Robot <[email protected]>
Merge-request: !8077
Brad King 2 years ago
parent
commit
427538b78e
1 changed files with 9 additions and 3 deletions
  1. 9 3
      Modules/ProcessorCount.cmake

+ 9 - 3
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