Merge topic 'doc-reStructuredText'

7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...

1 files changed, 30 insertions, 19 deletions

diff --git a/Modules/ProcessorCount.cmake b/Modules/ProcessorCount.cmake
index 0d1dfda..22ee776 100644
--- a/Modules/ProcessorCount.cmake
+++ b/Modules/ProcessorCount.cmake
@@ -1,30 +1,41 @@
-# - ProcessorCount(var)
+#.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, Mac OS X, QNX, Sun and Windows.
+# 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.
 #
 # 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.
+# 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()
+# ::
+#
+#    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.
+# 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