3.8.2/doc/cmake/html/module/ProcessorCount.html - platform/prebuilts/cmake/windows-x86 - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

   <title>ProcessorCount &mdash; CMake 3.8.2 Documentation</title>


     <link rel="stylesheet" href="../_static/cmake.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
         VERSION:     '3.8.2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
         SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../_static/cmake-favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="SelectLibraryConfigurations" href="SelectLibraryConfigurations.html" />
     <link rel="prev" title="MacroAddFileDependencies" href="MacroAddFileDependencies.html" />
   </head>
   <body role="document">
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
           <a href="SelectLibraryConfigurations.html" title="SelectLibraryConfigurations"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="MacroAddFileDependencies.html" title="MacroAddFileDependencies"
              accesskey="P">previous</a> |</li>
   <li>
     <img src="../_static/cmake-logo-16.png" alt=""
          style="vertical-align: middle; margin-top: -2px" />
   </li>
   <li>
     <a href="https://cmake.org/">CMake</a> &#187;
   </li>
   <li>
     <a href="../index.html">3.8.2 Documentation</a> &#187;
   </li>

           <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> &#187;</li>
       </ul>
     </div>

     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
           <div class="body" role="main">

   <div class="section" id="processorcount">
 <span id="module:ProcessorCount"></span><h1>ProcessorCount<a class="headerlink" href="#processorcount" title="Permalink to this headline">¶</a></h1>
 <p>ProcessorCount(var)</p>
 <p>Determine the number of processors/cores and save value in ${var}</p>
 <p>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, Mac OS X, QNX, Sun and
 Windows.</p>
 <p>This function is guaranteed to return a positive integer (&gt;=1) if it
 succeeds.  It returns 0 if there&#8217;s a problem determining the processor
 count.</p>
 <p>Example use, in a ctest -S dashboard script:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span>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()
 </pre></div>
 </div>
 <p>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&#8217;s full capacity all for yourself.</p>
 </div>


           </div>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <h4>Previous topic</h4>
   <p class="topless"><a href="MacroAddFileDependencies.html"
                         title="previous chapter">MacroAddFileDependencies</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="SelectLibraryConfigurations.html"
                         title="next chapter">SelectLibraryConfigurations</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
       <li><a href="../_sources/module/ProcessorCount.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
     <form class="search" action="../search.html" method="get">
       <div><input type="text" name="q" /></div>
       <div><input type="submit" value="Go" /></div>
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>
     </div>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
           <a href="SelectLibraryConfigurations.html" title="SelectLibraryConfigurations"
              >next</a> |</li>
         <li class="right" >
           <a href="MacroAddFileDependencies.html" title="MacroAddFileDependencies"
              >previous</a> |</li>
   <li>
     <img src="../_static/cmake-logo-16.png" alt=""
          style="vertical-align: middle; margin-top: -2px" />
   </li>
   <li>
     <a href="https://cmake.org/">CMake</a> &#187;
   </li>
   <li>
     <a href="../index.html">3.8.2 Documentation</a> &#187;
   </li>

           <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2000-2017 Kitware, Inc. and Contributors.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
     </div>
   </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

	<title>ProcessorCount — CMake 3.8.2 Documentation</title>


	<link rel="stylesheet" href="../_static/cmake.css" type="text/css" />
	<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

	<script type="text/javascript">
	var DOCUMENTATION_OPTIONS = {
	URL_ROOT: '../',
	VERSION: '3.8.2',
	COLLAPSE_INDEX: false,
	FILE_SUFFIX: '.html',
	HAS_SOURCE: true,
	SOURCELINK_SUFFIX: '.txt'
	};
	</script>
	<script type="text/javascript" src="../_static/jquery.js"></script>
	<script type="text/javascript" src="../_static/underscore.js"></script>
	<script type="text/javascript" src="../_static/doctools.js"></script>
	<link rel="shortcut icon" href="../_static/cmake-favicon.ico"/>
	<link rel="index" title="Index" href="../genindex.html" />
	<link rel="search" title="Search" href="../search.html" />
	<link rel="next" title="SelectLibraryConfigurations" href="SelectLibraryConfigurations.html" />
	<link rel="prev" title="MacroAddFileDependencies" href="MacroAddFileDependencies.html" />
	</head>
	<body role="document">
	<div class="related" role="navigation" aria-label="related navigation">
	<h3>Navigation</h3>
	<ul>
	<li class="right" style="margin-right: 10px">
	<a href="../genindex.html" title="General Index"
	accesskey="I">index</a></li>
	<li class="right" >
	<a href="SelectLibraryConfigurations.html" title="SelectLibraryConfigurations"
	accesskey="N">next</a> \|</li>
	<li class="right" >
	<a href="MacroAddFileDependencies.html" title="MacroAddFileDependencies"
	accesskey="P">previous</a> \|</li>
	<li>
	<img src="../_static/cmake-logo-16.png" alt=""
	style="vertical-align: middle; margin-top: -2px" />
	</li>
	<li>
	<a href="https://cmake.org/">CMake</a> »
	</li>
	<li>
	<a href="../index.html">3.8.2 Documentation</a> »
	</li>

	<li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> »</li>
	</ul>
	</div>

	<div class="document">
	<div class="documentwrapper">
	<div class="bodywrapper">
	<div class="body" role="main">

	<div class="section" id="processorcount">
	<span id="module:ProcessorCount"></span><h1>ProcessorCount<a class="headerlink" href="#processorcount" title="Permalink to this headline">¶</a></h1>
	<p>ProcessorCount(var)</p>
	<p>Determine the number of processors/cores and save value in ${var}</p>
	<p>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, Mac OS X, QNX, Sun and
	Windows.</p>
	<p>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.</p>
	<p>Example use, in a ctest -S dashboard script:</p>
	<div class="highlight-default"><div class="highlight"><pre><span></span>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()
	</pre></div>
	</div>
	<p>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.</p>
	</div>


	</div>
	</div>
	</div>
	<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
	<div class="sphinxsidebarwrapper">
	<h4>Previous topic</h4>
	<p class="topless"><a href="MacroAddFileDependencies.html"
	title="previous chapter">MacroAddFileDependencies</a></p>
	<h4>Next topic</h4>
	<p class="topless"><a href="SelectLibraryConfigurations.html"
	title="next chapter">SelectLibraryConfigurations</a></p>
	<div role="note" aria-label="source link">
	<h3>This Page</h3>
	<ul class="this-page-menu">
	<li><a href="../_sources/module/ProcessorCount.rst.txt"
	rel="nofollow">Show Source</a></li>
	</ul>
	</div>
	<div id="searchbox" style="display: none" role="search">
	<h3>Quick search</h3>
	<form class="search" action="../search.html" method="get">
	<div><input type="text" name="q" /></div>
	<div><input type="submit" value="Go" /></div>
	<input type="hidden" name="check_keywords" value="yes" />
	<input type="hidden" name="area" value="default" />
	</form>
	</div>
	<script type="text/javascript">$('#searchbox').show(0);</script>
	</div>
	</div>
	<div class="clearer"></div>
	</div>
	<div class="related" role="navigation" aria-label="related navigation">
	<h3>Navigation</h3>
	<ul>
	<li class="right" style="margin-right: 10px">
	<a href="../genindex.html" title="General Index"
	>index</a></li>
	<li class="right" >
	<a href="SelectLibraryConfigurations.html" title="SelectLibraryConfigurations"
	>next</a> \|</li>
	<li class="right" >
	<a href="MacroAddFileDependencies.html" title="MacroAddFileDependencies"
	>previous</a> \|</li>
	<li>
	<img src="../_static/cmake-logo-16.png" alt=""
	style="vertical-align: middle; margin-top: -2px" />
	</li>
	<li>
	<a href="https://cmake.org/">CMake</a> »
	</li>
	<li>
	<a href="../index.html">3.8.2 Documentation</a> »
	</li>

	<li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> »</li>
	</ul>
	</div>
	<div class="footer" role="contentinfo">
	© Copyright 2000-2017 Kitware, Inc. and Contributors.
	Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
	</div>
	</body>
	</html>