Bladeren bron

Modules: Update documentation formatting

Bartosz Kosiorek 6 jaren geleden
bovenliggende
commit
cb33befe2d

+ 6 - 6
Help/command/find_package.rst

@@ -234,7 +234,7 @@ Each entry is meant for installation trees following Windows (``W``), UNIX
   <prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/               (W/U)
   <prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/               (W/U)
   <prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/ (W/U)
   <prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/ (W/U)
 
 
-On systems supporting macOS :prop_tgt:`FRAMEWORK`s and :prop_tgt:`BUNDLE`s the
+On systems supporting macOS :prop_tgt:`FRAMEWORK` and :prop_tgt:`BUNDLE`, the
 following directories are searched for Frameworks or Application Bundles
 following directories are searched for Frameworks or Application Bundles
 containing a configuration file::
 containing a configuration file::
 
 
@@ -262,16 +262,16 @@ that order).
 * The ``lib`` path is always searched.
 * The ``lib`` path is always searched.
 
 
 If ``PATH_SUFFIXES`` is specified, the suffixes are appended to each
 If ``PATH_SUFFIXES`` is specified, the suffixes are appended to each
-(W) or (U) directory entry one-by-one.
+(``W``) or (``U``) directory entry one-by-one.
 
 
 This set of directories is intended to work in cooperation with
 This set of directories is intended to work in cooperation with
 projects that provide configuration files in their installation trees.
 projects that provide configuration files in their installation trees.
-Directories above marked with (W) are intended for installations on
+Directories above marked with (``W``) are intended for installations on
 Windows where the prefix may point at the top of an application's
 Windows where the prefix may point at the top of an application's
-installation directory.  Those marked with (U) are intended for
+installation directory.  Those marked with (``U``) are intended for
 installations on UNIX platforms where the prefix is shared by multiple
 installations on UNIX platforms where the prefix is shared by multiple
-packages.  This is merely a convention, so all (W) and (U) directories
-are still searched on all platforms.  Directories marked with (A) are
+packages.  This is merely a convention, so all (``W``) and (``U``) directories
+are still searched on all platforms.  Directories marked with (``A``) are
 intended for installations on Apple platforms.  The
 intended for installations on Apple platforms.  The
 :variable:`CMAKE_FIND_FRAMEWORK` and :variable:`CMAKE_FIND_APPBUNDLE`
 :variable:`CMAKE_FIND_FRAMEWORK` and :variable:`CMAKE_FIND_APPBUNDLE`
 variables determine the order of preference.
 variables determine the order of preference.

+ 6 - 6
Help/cpack_gen/nsis.rst

@@ -54,7 +54,7 @@ on Windows Nullsoft Scriptable Install System.
 
 
 .. variable:: CPACK_NSIS_COMPRESSOR
 .. variable:: CPACK_NSIS_COMPRESSOR
 
 
- The arguments that will be passed to the NSIS `SetCompressor command.
+ The arguments that will be passed to the NSIS `SetCompressor` command.
 
 
 .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
 .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
 
 
@@ -71,8 +71,8 @@ on Windows Nullsoft Scriptable Install System.
 
 
 .. variable:: CPACK_NSIS_DISPLAY_NAME
 .. variable:: CPACK_NSIS_DISPLAY_NAME
 
 
- The display name string that appears in the Windows `Add/Remove Program`
- control panel
+ The display name string that appears in the Windows `Apps & features`
+ in `Control Panel`
 
 
 .. variable:: CPACK_NSIS_PACKAGE_NAME
 .. variable:: CPACK_NSIS_PACKAGE_NAME
 
 
@@ -102,15 +102,15 @@ on Windows Nullsoft Scriptable Install System.
 
 
 .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
 .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
 
 
- Additional NSIS commands for creating start menu shortcuts.
+ Additional NSIS commands for creating `Start Menu` shortcuts.
 
 
 .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
 .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
 
 
- Additional NSIS commands to uninstall start menu shortcuts.
+ Additional NSIS commands to uninstall `Start Menu` shortcuts.
 
 
 .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
 .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
 
 
- Creating NSIS start menu links assumes that they are in ``bin`` unless this
+ Creating NSIS `Start Menu` links assumes that they are in ``bin`` unless this
  variable is set.  For example, you would set this to ``exec`` if your
  variable is set.  For example, you would set this to ``exec`` if your
  executables are in an exec directory.
  executables are in an exec directory.
 
 

+ 1 - 1
Help/envvar/ASM_DIALECT.rst

@@ -5,7 +5,7 @@ ASM<DIALECT>
 
 
 Preferred executable for compiling a specific dialect of assembly language
 Preferred executable for compiling a specific dialect of assembly language
 files. ``ASM<DIALECT>`` can be ``ASM``, ``ASM_NASM`` (Netwide Assembler),
 files. ``ASM<DIALECT>`` can be ``ASM``, ``ASM_NASM`` (Netwide Assembler),
-``ASM_MASM`` (Microsoft Assembler) or ``ASM-ATT`` (Asembler AT&T).
+``ASM_MASM`` (Microsoft Assembler) or ``ASM-ATT`` (Assembler AT&T).
 Will only be used by CMake on the first configuration to determine
 Will only be used by CMake on the first configuration to determine
 ``ASM<DIALECT>`` compiler, after which the value for ``ASM<DIALECT>`` is stored
 ``ASM<DIALECT>`` compiler, after which the value for ``ASM<DIALECT>`` is stored
 in the cache as
 in the cache as

+ 3 - 3
Help/envvar/ASM_DIALECTFLAGS.rst

@@ -7,7 +7,7 @@ Default compilation flags to be used when compiling a specific dialect of an
 assembly language. ``ASM<DIALECT>FLAGS`` can be ``ASMFLAGS``, ``ASM_NASMFLAGS``,
 assembly language. ``ASM<DIALECT>FLAGS`` can be ``ASMFLAGS``, ``ASM_NASMFLAGS``,
 ``ASM_MASMFLAGS`` or ``ASM-ATTFLAGS``. Will only be used by CMake on the
 ``ASM_MASMFLAGS`` or ``ASM-ATTFLAGS``. Will only be used by CMake on the
 first configuration to determine ``ASM_<DIALECT>`` default compilation
 first configuration to determine ``ASM_<DIALECT>`` default compilation
-flags, after which the value for ``ASM<DIALECT>FLAGS`` is stored in the cache as
-``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>``. For any configuration
-run (including the first), the environment variable will be ignored if the
+flags, after which the value for ``ASM<DIALECT>FLAGS`` is stored in the cache
+as ``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>``.  For any configuration
+run (including the first), the environment variable will be ignored, if the
 ``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>`` variable is defined.
 ``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>`` variable is defined.

+ 4 - 4
Help/manual/ctest.1.rst

@@ -369,11 +369,11 @@ is computed as::
 
 
 where:
 where:
 
 
-* ``raw_test_time[j,i]``: Wall-clock time for the ``i``th test
-  for the ``j``th label or subproject
+* ``raw_test_time[j,i]``: Wall-clock time for the ``i`` test
+  for the ``j`` label or subproject
 * ``num_processors[j,i]``: Value of the CTest :prop_test:`PROCESSORS` property
 * ``num_processors[j,i]``: Value of the CTest :prop_test:`PROCESSORS` property
-  for the ``i``th test for the ``j``th label or subproject
-* ``num_tests[j]``: Number of tests associated with the ``j``th label or subproject
+  for the ``i`` test for the ``j`` label or subproject
+* ``num_tests[j]``: Number of tests associated with the ``j`` label or subproject
 * ``total``: Total number of labels or subprojects that have at least one test run
 * ``total``: Total number of labels or subprojects that have at least one test run
 
 
 Therefore, the weighted time summary for each label or subproject represents
 Therefore, the weighted time summary for each label or subproject represents

+ 1 - 1
Help/prop_sf/VS_DEPLOYMENT_CONTENT.rst

@@ -3,7 +3,7 @@ VS_DEPLOYMENT_CONTENT
 
 
 Mark a source file as content for deployment with a Windows Phone or
 Mark a source file as content for deployment with a Windows Phone or
 Windows Store application when built with a
 Windows Store application when built with a
- :manual:`Visual Studio generators <cmake-generators(7)>`.
+:manual:`Visual Studio generators <cmake-generators(7)>`.
 The value must evaluate to either ``1`` or ``0`` and may use
 The value must evaluate to either ``1`` or ``0`` and may use
 :manual:`generator expressions <cmake-generator-expressions(7)>`
 :manual:`generator expressions <cmake-generator-expressions(7)>`
 to make the choice based on the build configuration.
 to make the choice based on the build configuration.

+ 1 - 1
Help/variable/CMAKE_STAGING_PREFIX.rst

@@ -6,7 +6,7 @@ be useful if the path in :variable:`CMAKE_SYSROOT` is read-only, or otherwise
 should remain pristine.
 should remain pristine.
 
 
 The :variable:`CMAKE_STAGING_PREFIX` location is also used as a search prefix
 The :variable:`CMAKE_STAGING_PREFIX` location is also used as a search prefix
- by the ``find_*`` commands. This can be controlled by setting the
+by the ``find_*`` commands. This can be controlled by setting the
 :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable.
 :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable.
 
 
 If any ``RPATH``/``RUNPATH`` entries passed to the linker contain the
 If any ``RPATH``/``RUNPATH`` entries passed to the linker contain the

+ 1 - 1
Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst

@@ -5,7 +5,7 @@ Ask CPack to error out as soon as a file with absolute ``INSTALL DESTINATION``
 is encountered.
 is encountered.
 
 
 The fatal error is emitted before the installation of the offending
 The fatal error is emitted before the installation of the offending
-file takes place.  Some CPack generators, like :cpack_gen:`nsis`, enforce this
+file takes place.  Some CPack generators, like ``NSIS``, enforce this
 internally.  This variable triggers the definition
 internally.  This variable triggers the definition
 of :variable:`CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION` when CPack
 of :variable:`CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION` when CPack
 runs.
 runs.

+ 65 - 61
Modules/BundleUtilities.cmake

@@ -7,7 +7,7 @@ BundleUtilities
 
 
 Functions to help assemble a standalone bundle application.
 Functions to help assemble a standalone bundle application.
 
 
-A collection of CMake utility functions useful for dealing with .app
+A collection of CMake utility functions useful for dealing with ``.app``
 bundles on the Mac and bundle-like directories on any OS.
 bundles on the Mac and bundle-like directories on any OS.
 
 
 The following functions are provided by this module:
 The following functions are provided by this module:
@@ -33,7 +33,7 @@ The following functions are provided by this module:
    verify_bundle_symlinks
    verify_bundle_symlinks
 
 
 Requires CMake 2.6 or greater because it uses function, break and
 Requires CMake 2.6 or greater because it uses function, break and
-PARENT_SCOPE.  Also depends on GetPrerequisites.cmake.
+``PARENT_SCOPE``.  Also depends on ``GetPrerequisites.cmake``.
 
 
 DO NOT USE THESE FUNCTIONS AT CONFIGURE TIME (from ``CMakeLists.txt``)!
 DO NOT USE THESE FUNCTIONS AT CONFIGURE TIME (from ``CMakeLists.txt``)!
 Instead, invoke them from an :command:`install(CODE)` or
 Instead, invoke them from an :command:`install(CODE)` or
@@ -43,55 +43,57 @@ Instead, invoke them from an :command:`install(CODE)` or
 
 
   fixup_bundle(<app> <libs> <dirs>)
   fixup_bundle(<app> <libs> <dirs>)
 
 
-Fix up a bundle in-place and make it standalone, such that it can be
+Fix up ``<app>`` bundle in-place and make it standalone, such that it can be
 drag-n-drop copied to another machine and run on that machine as long
 drag-n-drop copied to another machine and run on that machine as long
 as all of the system libraries are compatible.
 as all of the system libraries are compatible.
 
 
-If you pass plugins to fixup_bundle as the libs parameter, you should
-install them or copy them into the bundle before calling fixup_bundle.
-The "libs" parameter is a list of libraries that must be fixed up, but
-that cannot be determined by otool output analysis.  (i.e., plugins)
+If you pass plugins to ``fixup_bundle`` as the libs parameter, you should
+install them or copy them into the bundle before calling ``fixup_bundle``.
+The ``<libs>`` parameter is a list of libraries that must be fixed up, but
+that cannot be determined by ``otool`` output analysis  (i.e. ``plugins``).
 
 
 Gather all the keys for all the executables and libraries in a bundle,
 Gather all the keys for all the executables and libraries in a bundle,
 and then, for each key, copy each prerequisite into the bundle.  Then
 and then, for each key, copy each prerequisite into the bundle.  Then
 fix each one up according to its own list of prerequisites.
 fix each one up according to its own list of prerequisites.
 
 
-Then clear all the keys and call verify_app on the final bundle to
+Then clear all the keys and call ``verify_app`` on the final bundle to
 ensure that it is truly standalone.
 ensure that it is truly standalone.
 
 
-As an optional parameter (IGNORE_ITEM) a list of file names can be passed,
-which are then ignored (e.g. IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")
+As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+which are then ignored
+(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   copy_and_fixup_bundle(<src> <dst> <libs> <dirs>)
   copy_and_fixup_bundle(<src> <dst> <libs> <dirs>)
 
 
-Makes a copy of the bundle <src> at location <dst> and then fixes up
-the new copied bundle in-place at <dst>...
+Makes a copy of the bundle ``<src>`` at location ``<dst>`` and then fixes up
+the new copied bundle in-place at ``<dst>``.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   verify_app(<app>)
   verify_app(<app>)
 
 
-Verifies that an application <app> appears valid based on running
-analysis tools on it.  Calls "message(FATAL_ERROR" if the application
+Verifies that an application ``<app>`` appears valid based on running
+analysis tools on it.  Calls :command:`message(FATAL_ERROR)` if the application
 is not verified.
 is not verified.
 
 
-As an optional parameter (IGNORE_ITEM) a list of file names can be passed,
-which are then ignored (e.g. IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")
+As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+which are then ignored
+(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   get_bundle_main_executable(<bundle> <result_var>)
   get_bundle_main_executable(<bundle> <result_var>)
 
 
 The result will be the full path name of the bundle's main executable
 The result will be the full path name of the bundle's main executable
-file or an "error:" prefixed string if it could not be determined.
+file or an ``error:`` prefixed string if it could not be determined.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   get_dotapp_dir(<exe> <dotapp_dir_var>)
   get_dotapp_dir(<exe> <dotapp_dir_var>)
 
 
-Returns the nearest parent dir whose name ends with ".app" given the
+Returns the nearest parent dir whose name ends with ``.app`` given the
 full path to an executable.  If there is no such parent dir, then
 full path to an executable.  If there is no such parent dir, then
 simply return the dir containing the executable.
 simply return the dir containing the executable.
 
 
@@ -101,26 +103,26 @@ The returned directory may or may not exist.
 
 
   get_bundle_and_executable(<app> <bundle_var> <executable_var> <valid_var>)
   get_bundle_and_executable(<app> <bundle_var> <executable_var> <valid_var>)
 
 
-Takes either a ".app" directory name or the name of an executable
-nested inside a ".app" directory and returns the path to the ".app"
-directory in <bundle_var> and the path to its main executable in
-<executable_var>
+Takes either a ``.app`` directory name or the name of an executable
+nested inside a ``.app`` directory and returns the path to the ``.app``
+directory in ``<bundle_var>`` and the path to its main executable in
+``<executable_var>``.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   get_bundle_all_executables(<bundle> <exes_var>)
   get_bundle_all_executables(<bundle> <exes_var>)
 
 
-Scans the given bundle recursively for all executable files and
-accumulates them into a variable.
+Scans ``<bundle>`` bundle recursively for all ``<exes_var>`` executable
+files and accumulates them into a variable.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   get_item_key(<item> <key_var>)
   get_item_key(<item> <key_var>)
 
 
-Given a file (item) name, generate a key that should be unique
+Given ``<item>`` file name, generate ``<key_var>`` key that should be unique
 considering the set of libraries that need copying or fixing up to
 considering the set of libraries that need copying or fixing up to
 make a bundle standalone.  This is essentially the file name including
 make a bundle standalone.  This is essentially the file name including
-extension with "." replaced by "_"
+extension with ``.`` replaced by ``_``
 
 
 This key is used as a prefix for CMake variables so that we can
 This key is used as a prefix for CMake variables so that we can
 associate a set of variables with a given item based on its key.
 associate a set of variables with a given item based on its key.
@@ -129,10 +131,10 @@ associate a set of variables with a given item based on its key.
 
 
   clear_bundle_keys(<keys_var>)
   clear_bundle_keys(<keys_var>)
 
 
-Loop over the list of keys, clearing all the variables associated with
-each key.  After the loop, clear the list of keys itself.
+Loop over the ``<keys_var>`` list of keys, clearing all the variables
+associated with each key.  After the loop, clear the list of keys itself.
 
 
-Caller of get_bundle_keys should call clear_bundle_keys when done with
+Caller of ``get_bundle_keys`` should call ``clear_bundle_keys`` when done with
 list of keys.
 list of keys.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
@@ -140,86 +142,88 @@ list of keys.
   set_bundle_key_values(<keys_var> <context> <item> <exepath> <dirs>
   set_bundle_key_values(<keys_var> <context> <item> <exepath> <dirs>
                         <copyflag> [<rpaths>])
                         <copyflag> [<rpaths>])
 
 
-Add a key to the list (if necessary) for the given item.  If added,
-also set all the variables associated with that key.
+Add ``<keys_var>`` key to the list (if necessary) for the given item.
+If added, also set all the variables associated with that key.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   get_bundle_keys(<app> <libs> <dirs> <keys_var>)
   get_bundle_keys(<app> <libs> <dirs> <keys_var>)
 
 
-Loop over all the executable and library files within the bundle (and
-given as extra <libs>) and accumulate a list of keys representing
+Loop over all the executable and library files within ``<app>`` bundle (and
+given as extra ``<libs>``) and accumulate a list of keys representing
 them.  Set values associated with each key such that we can loop over
 them.  Set values associated with each key such that we can loop over
 all of them and copy prerequisite libs into the bundle and then do
 all of them and copy prerequisite libs into the bundle and then do
-appropriate install_name_tool fixups.
+appropriate ``install_name_tool`` fixups.
 
 
-As an optional parameter (IGNORE_ITEM) a list of file names can be passed,
-which are then ignored (e.g. IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")
+As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+which are then ignored
+(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   copy_resolved_item_into_bundle(<resolved_item> <resolved_embedded_item>)
   copy_resolved_item_into_bundle(<resolved_item> <resolved_embedded_item>)
 
 
-Copy a resolved item into the bundle if necessary.  Copy is not
-necessary if the resolved_item is "the same as" the
-resolved_embedded_item.
+Copy a resolved item into the bundle if necessary.
+Copy is not necessary, if the ``<resolved_item>`` is "the same as" the
+``<resolved_embedded_item>``.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   copy_resolved_framework_into_bundle(<resolved_item> <resolved_embedded_item>)
   copy_resolved_framework_into_bundle(<resolved_item> <resolved_embedded_item>)
 
 
-Copy a resolved framework into the bundle if necessary.  Copy is not
-necessary if the resolved_item is "the same as" the
-resolved_embedded_item.
+Copy a resolved framework into the bundle if necessary.
+Copy is not necessary, if the ``<resolved_item>`` is "the same as" the
+``<resolved_embedded_item>``.
 
 
-By default, BU_COPY_FULL_FRAMEWORK_CONTENTS is not set.  If you want
+By default, ``BU_COPY_FULL_FRAMEWORK_CONTENTS`` is not set.  If you want
 full frameworks embedded in your bundles, set
 full frameworks embedded in your bundles, set
-BU_COPY_FULL_FRAMEWORK_CONTENTS to ON before calling fixup_bundle.  By
-default, COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE copies the framework
-dylib itself plus the framework Resources directory.
+``BU_COPY_FULL_FRAMEWORK_CONTENTS`` to ``ON`` before calling fixup_bundle.  By
+default, ``COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE`` copies the framework
+dylib itself plus the framework ``Resources`` directory.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   fixup_bundle_item(<resolved_embedded_item> <exepath> <dirs>)
   fixup_bundle_item(<resolved_embedded_item> <exepath> <dirs>)
 
 
-Get the direct/non-system prerequisites of the resolved embedded item.
+Get the direct/non-system prerequisites of the ``<resolved_embedded_item>``.
 For each prerequisite, change the way it is referenced to the value of
 For each prerequisite, change the way it is referenced to the value of
-the _EMBEDDED_ITEM keyed variable for that prerequisite.  (Most likely
-changing to an "@executable_path" style reference.)
+the ``_EMBEDDED_ITEM`` keyed variable for that prerequisite.  (Most likely
+changing to an ``@executable_path`` style reference.)
 
 
-This function requires that the resolved_embedded_item be "inside" the
-bundle already.  In other words, if you pass plugins to fixup_bundle
+This function requires that the ``<resolved_embedded_item>`` be ``inside``
+the bundle already.  In other words, if you pass plugins to ``fixup_bundle``
 as the libs parameter, you should install them or copy them into the
 as the libs parameter, you should install them or copy them into the
-bundle before calling fixup_bundle.  The "libs" parameter is a list of
+bundle before calling ``fixup_bundle``.  The ``libs`` parameter is a list of
 libraries that must be fixed up, but that cannot be determined by
 libraries that must be fixed up, but that cannot be determined by
-otool output analysis.  (i.e., plugins)
+otool output analysis.  (i.e., ``plugins``)
 
 
 Also, change the id of the item being fixed up to its own
 Also, change the id of the item being fixed up to its own
-_EMBEDDED_ITEM value.
+``_EMBEDDED_ITEM`` value.
 
 
 Accumulate changes in a local variable and make *one* call to
 Accumulate changes in a local variable and make *one* call to
-install_name_tool at the end of the function with all the changes at
+``install_name_tool`` at the end of the function with all the changes at
 once.
 once.
 
 
-If the BU_CHMOD_BUNDLE_ITEMS variable is set then bundle items will be
-marked writable before install_name_tool tries to change them.
+If the ``BU_CHMOD_BUNDLE_ITEMS`` variable is set then bundle items will be
+marked writable before ``install_name_tool`` tries to change them.
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   verify_bundle_prerequisites(<bundle> <result_var> <info_var>)
   verify_bundle_prerequisites(<bundle> <result_var> <info_var>)
 
 
 Verifies that the sum of all prerequisites of all files inside the
 Verifies that the sum of all prerequisites of all files inside the
-bundle are contained within the bundle or are "system" libraries,
+bundle are contained within the bundle or are ``system`` libraries,
 presumed to exist everywhere.
 presumed to exist everywhere.
 
 
-As an optional parameter (IGNORE_ITEM) a list of file names can be passed,
-which are then ignored (e.g. IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")
+As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+which are then ignored
+(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
 
 
 .. code-block:: cmake
 .. code-block:: cmake
 
 
   verify_bundle_symlinks(<bundle> <result_var> <info_var>)
   verify_bundle_symlinks(<bundle> <result_var> <info_var>)
 
 
-Verifies that any symlinks found in the bundle point to other files
+Verifies that any symlinks found in the ``<bundle>`` bundle point to other files
 that are already also in the bundle...  Anything that points to an
 that are already also in the bundle...  Anything that points to an
 external file causes this function to fail the verification.
 external file causes this function to fail the verification.
 #]=======================================================================]
 #]=======================================================================]

+ 10 - 9
Modules/ExternalProject.cmake

@@ -202,23 +202,24 @@ External Project Definition
         :command:`file(DOWNLOAD)`)
         :command:`file(DOWNLOAD)`)
 
 
       ``NETRC <level>``
       ``NETRC <level>``
-        Specify whether the .netrc file is to be used for operation. If this
-        option is not specified, the value of the ``CMAKE_NETRC`` variable
-        will be used instead (see :command:`file(DOWNLOAD)`)
+        Specify whether the ``.netrc`` file is to be used for operation.
+        If this option is not specified, the value of the ``CMAKE_NETRC``
+        variable will be used instead (see :command:`file(DOWNLOAD)`)
         Valid levels are:
         Valid levels are:
 
 
         ``IGNORED``
         ``IGNORED``
-          The .netrc file is ignored.
+          The ``.netrc`` file is ignored.
           This is the default.
           This is the default.
         ``OPTIONAL``
         ``OPTIONAL``
-          The .netrc file is optional, and information in the URL is preferred.
-          The file will be scanned to find which ever information is not specified
-          in the URL.
+          The ``.netrc`` file is optional, and information in the URL
+          is preferred.  The file will be scanned to find which ever
+          information is not specified in the URL.
         ``REQUIRED``
         ``REQUIRED``
-          The .netrc file is required, and information in the URL is ignored.
+          The ``.netrc`` file is required, and information in the URL
+          is ignored.
 
 
       ``NETRC_FILE <file>``
       ``NETRC_FILE <file>``
-        Specify an alternative .netrc file to the one in your home directory
+        Specify an alternative ``.netrc`` file to the one in your home directory
         if the ``NETRC`` level is ``OPTIONAL`` or ``REQUIRED``. If this option
         if the ``NETRC`` level is ``OPTIONAL`` or ``REQUIRED``. If this option
         is not specified, the value of the ``CMAKE_NETRC_FILE`` variable will
         is not specified, the value of the ``CMAKE_NETRC_FILE`` variable will
         be used instead (see :command:`file(DOWNLOAD)`)
         be used instead (see :command:`file(DOWNLOAD)`)

+ 2 - 2
Modules/FindBISON.cmake

@@ -19,7 +19,7 @@ The module defines the following variables:
   true if the program was found
   true if the program was found
 
 
 The minimum required version of ``bison`` can be specified using the
 The minimum required version of ``bison`` can be specified using the
-standard CMake syntax, e.g.  ``find_package(BISON 2.1.3)``.
+standard CMake syntax, e.g.  :command:`find_package(BISON 2.1.3)`.
 
 
 If ``bison`` is found, the module defines the macro::
 If ``bison`` is found, the module defines the macro::
 
 
@@ -55,7 +55,7 @@ The options are:
 The macro defines the following variables:
 The macro defines the following variables:
 
 
 ``BISON_<Name>_DEFINED``
 ``BISON_<Name>_DEFINED``
-  true is the macro ran successfully
+  ``True`` is the macro ran successfully
 
 
 ``BISON_<Name>_INPUT``
 ``BISON_<Name>_INPUT``
   The input source file, an alias for <YaccInput>
   The input source file, an alias for <YaccInput>

+ 7 - 7
Modules/FindBLAS.cmake

@@ -5,12 +5,12 @@
 FindBLAS
 FindBLAS
 --------
 --------
 
 
-Find BLAS library
+Find Basic Linear Algebra Subprograms (BLAS) library
 
 
-This module finds an installed fortran library that implements the
+This module finds an installed Fortran library that implements the
 BLAS linear-algebra interface (see http://www.netlib.org/blas/).  The
 BLAS linear-algebra interface (see http://www.netlib.org/blas/).  The
-list of libraries searched for is taken from the autoconf macro file,
-acx_blas.m4 (distributed at
+list of libraries searched for is taken from the ``autoconf`` macro file,
+``acx_blas.m4`` (distributed at
 http://ac-archive.sourceforge.net/ac-archive/acx_blas.html).
 http://ac-archive.sourceforge.net/ac-archive/acx_blas.html).
 
 
 Input Variables
 Input Variables
@@ -52,7 +52,7 @@ The following variables may be set to influence this module's behavior:
   if ``ON`` tries to find the BLAS95 interfaces
   if ``ON`` tries to find the BLAS95 interfaces
 
 
 ``BLA_PREFER_PKGCONFIG``
 ``BLA_PREFER_PKGCONFIG``
-  if set pkg-config will be used to search for a BLAS library first
+  if set ``pkg-config`` will be used to search for a BLAS library first
   and if one is found that is preferred
   and if one is found that is preferred
 
 
 Result Variables
 Result Variables
@@ -63,7 +63,7 @@ This module defines the following variables:
 ``BLAS_FOUND``
 ``BLAS_FOUND``
   library implementing the BLAS interface is found
   library implementing the BLAS interface is found
 ``BLAS_LINKER_FLAGS``
 ``BLAS_LINKER_FLAGS``
-  uncached list of required linker flags (excluding -l and -L).
+  uncached list of required linker flags (excluding ``-l`` and ``-L``).
 ``BLAS_LIBRARIES``
 ``BLAS_LIBRARIES``
   uncached list of libraries (using full path name) to link against
   uncached list of libraries (using full path name) to link against
   to use BLAS (may be empty if compiler implicitly links BLAS)
   to use BLAS (may be empty if compiler implicitly links BLAS)
@@ -75,7 +75,7 @@ This module defines the following variables:
 
 
 .. note::
 .. note::
 
 
-  C or CXX must be enabled to use Intel MKL
+  C or CXX must be enabled to use Intel Math Kernel Library (MKL)
 
 
   For example, to use Intel MKL libraries and/or Intel compiler:
   For example, to use Intel MKL libraries and/or Intel compiler:
 
 

+ 20 - 20
Modules/FindBoost.cmake

@@ -85,33 +85,33 @@ The following :prop_tgt:`IMPORTED` targets are also defined::
   Boost::dynamic_linking        - interface target to enable dynamic linking
   Boost::dynamic_linking        - interface target to enable dynamic linking
                                   linking with MSVC (adds BOOST_ALL_DYN_LINK)
                                   linking with MSVC (adds BOOST_ALL_DYN_LINK)
 
 
-Implicit dependencies such as Boost::filesystem requiring
-Boost::system will be automatically detected and satisfied, even
-if system is not specified when using find_package and if
-Boost::system is not added to target_link_libraries.  If using
-Boost::thread, then Threads::Threads will also be added automatically.
+Implicit dependencies such as ``Boost::filesystem`` requiring
+``Boost::system`` will be automatically detected and satisfied, even
+if system is not specified when using :command:`find_package` and if
+``Boost::system`` is not added to :command:`target_link_libraries`.  If using
+``Boost::thread``, then ``Threads::Threads`` will also be added automatically.
 
 
 It is important to note that the imported targets behave differently
 It is important to note that the imported targets behave differently
 than variables created by this module: multiple calls to
 than variables created by this module: multiple calls to
-find_package(Boost) in the same directory or sub-directories with
+:command:`find_package(Boost)` in the same directory or sub-directories with
 different options (e.g. static or shared) will not override the
 different options (e.g. static or shared) will not override the
 values of the targets created by the first call.
 values of the targets created by the first call.
 
 
-Users may set these hints or results as cache entries.  Projects
+Users may set these hints or results as ``CACHE`` entries.  Projects
 should not read these entries directly but instead use the above
 should not read these entries directly but instead use the above
 result variables.  Note that some hint names start in upper-case
 result variables.  Note that some hint names start in upper-case
 "BOOST".  One may specify these as environment variables if they are
 "BOOST".  One may specify these as environment variables if they are
 not specified as CMake variables or cache entries.
 not specified as CMake variables or cache entries.
 
 
-This module first searches for the Boost header files using the above
-hint variables (excluding BOOST_LIBRARYDIR) and saves the result in
-Boost_INCLUDE_DIR.  Then it searches for requested component libraries
-using the above hints (excluding BOOST_INCLUDEDIR and
-Boost_ADDITIONAL_VERSIONS), "lib" directories near Boost_INCLUDE_DIR,
+This module first searches for the ``Boost`` header files using the above
+hint variables (excluding ``BOOST_LIBRARYDIR``) and saves the result in
+``Boost_INCLUDE_DIR``.  Then it searches for requested component libraries
+using the above hints (excluding ``BOOST_INCLUDEDIR`` and
+``Boost_ADDITIONAL_VERSIONS``), "lib" directories near ``Boost_INCLUDE_DIR``,
 and the library name configuration settings below.  It saves the
 and the library name configuration settings below.  It saves the
-library directories in Boost_LIBRARY_DIR_DEBUG and
-Boost_LIBRARY_DIR_RELEASE and individual library
-locations in Boost_<C>_LIBRARY_DEBUG and Boost_<C>_LIBRARY_RELEASE.
+library directories in ``Boost_LIBRARY_DIR_DEBUG`` and
+``Boost_LIBRARY_DIR_RELEASE`` and individual library
+locations in ``Boost_<C>_LIBRARY_DEBUG`` and ``Boost_<C>_LIBRARY_RELEASE``.
 When one changes settings used by previous searches in the same build
 When one changes settings used by previous searches in the same build
 tree (excluding environment variables) this module discards previous
 tree (excluding environment variables) this module discards previous
 search results affected by the changes and searches again.
 search results affected by the changes and searches again.
@@ -179,9 +179,9 @@ Other variables one may set to control this module are::
 On Visual Studio and Borland compilers Boost headers request automatic
 On Visual Studio and Borland compilers Boost headers request automatic
 linking to corresponding libraries.  This requires matching libraries
 linking to corresponding libraries.  This requires matching libraries
 to be linked explicitly or available in the link library search path.
 to be linked explicitly or available in the link library search path.
-In this case setting Boost_USE_STATIC_LIBS to OFF may not achieve
+In this case setting ``Boost_USE_STATIC_LIBS`` to ``OFF`` may not achieve
 dynamic linking.  Boost automatic linking typically requests static
 dynamic linking.  Boost automatic linking typically requests static
-libraries with a few exceptions (such as Boost.Python).  Use::
+libraries with a few exceptions (such as ``Boost.Python``).  Use::
 
 
   add_definitions(${Boost_LIB_DIAGNOSTIC_DEFINITIONS})
   add_definitions(${Boost_LIB_DIAGNOSTIC_DEFINITIONS})
 
 
@@ -230,12 +230,12 @@ Boost CMake
 If Boost was built using the boost-cmake project it provides a package
 If Boost was built using the boost-cmake project it provides a package
 configuration file for use with find_package's Config mode.  This
 configuration file for use with find_package's Config mode.  This
 module looks for the package configuration file called
 module looks for the package configuration file called
-BoostConfig.cmake or boost-config.cmake and stores the result in cache
-entry "Boost_DIR".  If found, the package configuration file is loaded
+``BoostConfig.cmake`` or ``boost-config.cmake`` and stores the result in
+``CACHE`` entry "Boost_DIR".  If found, the package configuration file is loaded
 and this module returns with no further action.  See documentation of
 and this module returns with no further action.  See documentation of
 the Boost CMake package configuration for details on what it provides.
 the Boost CMake package configuration for details on what it provides.
 
 
-Set Boost_NO_BOOST_CMAKE to ON to disable the search for boost-cmake.
+Set ``Boost_NO_BOOST_CMAKE`` to ``ON``, to disable the search for boost-cmake.
 #]=======================================================================]
 #]=======================================================================]
 
 
 # Save project's policies
 # Save project's policies

+ 2 - 2
Modules/FindCups.cmake

@@ -7,8 +7,8 @@ FindCups
 
 
 Find the CUPS printing system.
 Find the CUPS printing system.
 
 
-Set CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE to TRUE if you need a version which
-features this function (i.e. at least 1.1.19)
+Set ``CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE`` to ``TRUE`` if you need a version which
+features this function (i.e. at least ``1.1.19``)
 
 
 Imported targets
 Imported targets
 ^^^^^^^^^^^^^^^^
 ^^^^^^^^^^^^^^^^

+ 6 - 6
Modules/FindFLEX.cmake

@@ -13,7 +13,7 @@ The module defines the following variables:
 
 
 ::
 ::
 
 
-  FLEX_FOUND - true is flex executable is found
+  FLEX_FOUND - True is flex executable is found
   FLEX_EXECUTABLE - the path to the flex executable
   FLEX_EXECUTABLE - the path to the flex executable
   FLEX_VERSION - the version of flex
   FLEX_VERSION - the version of flex
   FLEX_LIBRARIES - The flex libraries
   FLEX_LIBRARIES - The flex libraries
@@ -35,10 +35,10 @@ If flex is found on the system, the module provides the macro:
               [DEFINES_FILE <string>]
               [DEFINES_FILE <string>]
               )
               )
 
 
-which creates a custom command to generate the <FlexOutput> file from
-the <FlexInput> file.  If COMPILE_FLAGS option is specified, the next
+which creates a custom command to generate the ``FlexOutput`` file from
+the ``FlexInput`` file.  If ``COMPILE_FLAGS`` option is specified, the next
 parameter is added to the flex command line. If flex is configured to
 parameter is added to the flex command line. If flex is configured to
-output a header file, the DEFINES_FILE option may be used to specify its
+output a header file, the ``DEFINES_FILE`` option may be used to specify its
 name. Name is an alias used to get details of this custom command.
 name. Name is an alias used to get details of this custom command.
 Indeed the macro defines the following variables:
 Indeed the macro defines the following variables:
 
 
@@ -61,8 +61,8 @@ defines a macro:
   ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget)
   ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget)
 
 
 which adds the required dependency between a scanner and a parser
 which adds the required dependency between a scanner and a parser
-where <FlexTarget> and <BisonTarget> are the first parameters of
-respectively FLEX_TARGET and BISON_TARGET macros.
+where ``FlexTarget`` and ``BisonTarget`` are the first parameters of
+respectively ``FLEX_TARGET`` and ``BISON_TARGET`` macros.
 
 
 ::
 ::
 
 

+ 3 - 3
Modules/FindSWIG.cmake

@@ -19,11 +19,11 @@ This module finds an installed SWIG.  It sets the following variables:
 
 
 
 
 The minimum required version of SWIG can be specified using the
 The minimum required version of SWIG can be specified using the
-standard syntax, e.g.  find_package(SWIG 1.1)
+standard syntax, e.g.   :command:`find_package(SWIG 1.1)`
 
 
-All information is collected from the SWIG_EXECUTABLE so the version
+All information is collected from the ``SWIG_EXECUTABLE``, so the version
 to be found can be changed from the command line by means of setting
 to be found can be changed from the command line by means of setting
-SWIG_EXECUTABLE
+``SWIG_EXECUTABLE``
 #]=======================================================================]
 #]=======================================================================]
 
 
 find_program(SWIG_EXECUTABLE NAMES swig3.0 swig2.0 swig)
 find_program(SWIG_EXECUTABLE NAMES swig3.0 swig2.0 swig)

+ 1 - 1
Modules/FindTIFF.cmake

@@ -5,7 +5,7 @@
 FindTIFF
 FindTIFF
 --------
 --------
 
 
-Find the TIFF library (libtiff).
+Find the TIFF library (``libtiff``).
 
 
 Imported targets
 Imported targets
 ^^^^^^^^^^^^^^^^
 ^^^^^^^^^^^^^^^^

+ 3 - 2
Modules/FindUnixCommands.cmake

@@ -7,8 +7,9 @@ FindUnixCommands
 
 
 Find Unix commands, including the ones from Cygwin
 Find Unix commands, including the ones from Cygwin
 
 
-This module looks for the Unix commands bash, cp, gzip, mv, rm, and tar
-and stores the result in the variables BASH, CP, GZIP, MV, RM, and TAR.
+This module looks for the Unix commands ``bash``, ``cp``, ``gzip``,
+``mv``, ``rm``, and ``tar`` and stores the result in the variables
+``BASH``, ``CP``, ``GZIP``, ``MV``, ``RM``, and ``TAR``.
 #]=======================================================================]
 #]=======================================================================]
 
 
 include(${CMAKE_CURRENT_LIST_DIR}/FindCygwin.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/FindCygwin.cmake)

+ 1 - 1
Modules/GenerateExportHeader.cmake

@@ -7,7 +7,7 @@ GenerateExportHeader
 
 
 Function for generation of export macros for libraries
 Function for generation of export macros for libraries
 
 
-This module provides the function GENERATE_EXPORT_HEADER().
+This module provides the function ``GENERATE_EXPORT_HEADER()``.
 
 
 The ``GENERATE_EXPORT_HEADER`` function can be used to generate a file
 The ``GENERATE_EXPORT_HEADER`` function can be used to generate a file
 suitable for preprocessor inclusion which contains EXPORT macros to be
 suitable for preprocessor inclusion which contains EXPORT macros to be

+ 2 - 3
Modules/UseQt4.cmake

@@ -7,8 +7,8 @@ UseQt4
 
 
 Use Module for QT4
 Use Module for QT4
 
 
-Sets up C and C++ to use Qt 4.  It is assumed that FindQt.cmake has
-already been loaded.  See FindQt.cmake for information on how to load
+Sets up C and C++ to use Qt 4.  It is assumed that :module:`FindQt` has
+already been loaded.  See :module:`FindQt` for information on how to load
 Qt 4 into your CMake project.
 Qt 4 into your CMake project.
 #]=======================================================================]
 #]=======================================================================]
 
 
@@ -105,4 +105,3 @@ foreach(module QT3SUPPORT QTOPENGL QTASSISTANT QTDESIGNER QTMOTIF QTNSPLUGIN
   endif ()
   endif ()
 
 
 endforeach()
 endforeach()
-

+ 1 - 1
Modules/WriteCompilerDetectionHeader.cmake

@@ -5,7 +5,7 @@
 WriteCompilerDetectionHeader
 WriteCompilerDetectionHeader
 ----------------------------
 ----------------------------
 
 
-This module provides the function write_compiler_detection_header().
+This module provides the function ``write_compiler_detection_header()``.
 
 
 This function can be used to generate a file suitable for preprocessor
 This function can be used to generate a file suitable for preprocessor
 inclusion which contains macros to be used in source code::
 inclusion which contains macros to be used in source code::