mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-21 22:50:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Convert remaining modules to block-style comments

Browse Source
This commit is contained in:
Kitware Robot
2018-10-22 10:31:08 -04:00
committed by Kyle Edwards
parent 7115aa6c22
commit df4ed1e9ff
202 changed files with 10078 additions and 9868 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
Modules/ProcessorCount.cmake
View File

@@ -1,44 +1,45 @@
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
#.rst:
# ProcessorCount
# --------------
#
# ProcessorCount(var)
#
# Determine the number of processors/cores and save value in ${var}
#
# Sets the variable named ${var} to the number of physical cores
# available on the machine if the information can be determined.
# Otherwise it is set to 0. Currently this functionality is implemented
# for AIX, cygwin, FreeBSD, HPUX, IRIX, Linux, macOS, QNX, Sun and
# Windows.
#
# 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.
#
# Example use, in a ctest -S dashboard script:
#
# ::
#
# include(ProcessorCount)
# ProcessorCount(N)
# if(NOT N EQUAL 0)
# set(CTEST_BUILD_FLAGS -j${N})
# 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
# testing. It is meant to help utilize as much of the machine as seems
# reasonable. Of course, knowledge of what else might be running on the
# machine simultaneously should be used when deciding whether to request
# a machine's full capacity all for yourself.
#[=======================================================================[.rst:
ProcessorCount
--------------
ProcessorCount(var)
Determine the number of processors/cores and save value in ${var}
Sets the variable named ${var} to the number of physical cores
available on the machine if the information can be determined.
Otherwise it is set to 0. Currently this functionality is implemented
for AIX, cygwin, FreeBSD, HPUX, IRIX, Linux, macOS, QNX, Sun and
Windows.
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.
Example use, in a ctest -S dashboard script:
::
include(ProcessorCount)
ProcessorCount(N)
if(NOT N EQUAL 0)
set(CTEST_BUILD_FLAGS -j${N})
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
testing. It is meant to help utilize as much of the machine as seems
reasonable. Of course, knowledge of what else might be running on the
machine simultaneously should be used when deciding whether to request
a machine's full capacity all for yourself.
#]=======================================================================]
# A more reliable way might be to compile a small C program that uses the CPUID
# instruction, but that again requires compiler support or compiling assembler