Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00
Code Issues Projects Releases Wiki Activity

ProcessorCount: Add intro code block with include()

Browse Source 
- Added intro code block showing how to include this module in CMake.
- Used "command" instead of "function".
- Synced descriptions a bit.
This commit is contained in:
Peter Kokot
2025-05-14 18:23:42 +02:00
parent c4b4e26019
commit 7660e97e99
1 changed files with 22 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Modules/ProcessorCount.cmake
View File

@@ -5,24 +5,36 @@
ProcessorCount
--------------
This module provides the following function to determine the number of
processors/cores:
This module provides a command to determine the number of processors/cores.
Load this module in CMake with:
.. code-block:: cmake
include(ProcessorCount)
Commands
^^^^^^^^
This module provides the following command:
.. command:: ProcessorCount
Determines the number of logical CPU cores available on the machine:
.. code-block:: cmake
ProcessorCount(<variable>)
Sets a local variable named ``<variable>`` to the number of logical CPU cores
available on the machine, if the information can be determined. If
successful, the variable is guaranteed to be set to a positive integer (>=1).
If the processor count cannot be determined, it is set to 0.
This command sets a variable named ``<variable>`` to the number of logical
CPU cores available on the machine, if the information can be determined.
If successful, the variable is guaranteed to be set to a positive integer
(>=1). If the processor count cannot be determined, it is set to 0.
Currently, this functionality is implemented for AIX, Cygwin, FreeBSD, Haiku,
HPUX, Linux, macOS, QNX, Sun and Windows.
This function provides an approximation of the number of compute cores
This command provides an approximation of the number of compute cores
available on the current machine, making it useful for parallel building and
testing. It is meant to help utilize as much of the machine as seems
reasonable, though users should consider other workloads running on the
@@ -45,7 +57,9 @@ processors/cores:
Examples
^^^^^^^^
Using ``ProcessorCount`` module in a :option:`ctest -S` dashboard script:
In the following example this module is used in a :option:`ctest -S`
dashboard script to determine number of cores to use for a parallel
:ref:`CTest Build Step`:
.. code-block:: cmake