Commit cb33befe authored by Bartosz Kosiorek's avatar Bartosz Kosiorek

Modules: Update documentation formatting

parent 0e4fbb4a
......@@ -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>*/(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
containing a configuration file::
......@@ -262,16 +262,16 @@ that order).
* The ``lib`` path is always searched.
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
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
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
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
:variable:`CMAKE_FIND_FRAMEWORK` and :variable:`CMAKE_FIND_APPBUNDLE`
variables determine the order of preference.
......
......@@ -54,7 +54,7 @@ on Windows Nullsoft Scriptable Install System.
.. 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
......@@ -71,8 +71,8 @@ on Windows Nullsoft Scriptable Install System.
.. 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
......@@ -102,15 +102,15 @@ on Windows Nullsoft Scriptable Install System.
.. 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
Additional NSIS commands to uninstall start menu shortcuts.
Additional NSIS commands to uninstall `Start Menu` shortcuts.
.. 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
executables are in an exec directory.
......
......@@ -5,7 +5,7 @@ ASM<DIALECT>
Preferred executable for compiling a specific dialect of assembly language
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
``ASM<DIALECT>`` compiler, after which the value for ``ASM<DIALECT>`` is stored
in the cache as
......
......@@ -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``,
``ASM_MASMFLAGS`` or ``ASM-ATTFLAGS``. Will only be used by CMake on the
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.
......@@ -369,11 +369,11 @@ is computed as::
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
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
Therefore, the weighted time summary for each label or subproject represents
......
......@@ -3,7 +3,7 @@ VS_DEPLOYMENT_CONTENT
Mark a source file as content for deployment with a Windows Phone or
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
:manual:`generator expressions <cmake-generator-expressions(7)>`
to make the choice based on the build configuration.
......
......@@ -6,7 +6,7 @@ be useful if the path in :variable:`CMAKE_SYSROOT` is read-only, or otherwise
should remain pristine.
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.
If any ``RPATH``/``RUNPATH`` entries passed to the linker contain the
......
......@@ -5,7 +5,7 @@ Ask CPack to error out as soon as a file with absolute ``INSTALL DESTINATION``
is encountered.
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
of :variable:`CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION` when CPack
runs.
This diff is collapsed.
......@@ -202,23 +202,24 @@ External Project Definition
:command:`file(DOWNLOAD)`)
``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:
``IGNORED``
The .netrc file is ignored.
The ``.netrc`` file is ignored.
This is the default.
``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``
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>``
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
is not specified, the value of the ``CMAKE_NETRC_FILE`` variable will
be used instead (see :command:`file(DOWNLOAD)`)
......
......@@ -19,7 +19,7 @@ The module defines the following variables:
true if the program was found
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::
......@@ -55,7 +55,7 @@ The options are:
The macro defines the following variables:
``BISON_<Name>_DEFINED``
true is the macro ran successfully
``True`` is the macro ran successfully
``BISON_<Name>_INPUT``
The input source file, an alias for <YaccInput>
......
......@@ -5,12 +5,12 @@
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
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).
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
``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
Result Variables
......@@ -63,7 +63,7 @@ This module defines the following variables:
``BLAS_FOUND``
library implementing the BLAS interface is found
``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``
uncached list of libraries (using full path name) to link against
to use BLAS (may be empty if compiler implicitly links BLAS)
......@@ -75,7 +75,7 @@ This module defines the following variables:
.. 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:
......
......@@ -85,33 +85,33 @@ The following :prop_tgt:`IMPORTED` targets are also defined::
Boost::dynamic_linking - interface target to enable dynamic linking
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
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
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
result variables. Note that some hint names start in upper-case
"BOOST". One may specify these as environment variables if they are
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
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
tree (excluding environment variables) this module discards previous
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
linking to corresponding libraries. This requires matching libraries
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
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})
......@@ -230,12 +230,12 @@ Boost CMake
If Boost was built using the boost-cmake project it provides a package
configuration file for use with find_package's Config mode. This
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
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
......
......@@ -7,8 +7,8 @@ FindCups
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
^^^^^^^^^^^^^^^^
......
......@@ -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_VERSION - the version of flex
FLEX_LIBRARIES - The flex libraries
......@@ -35,10 +35,10 @@ If flex is found on the system, the module provides the macro:
[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
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.
Indeed the macro defines the following variables:
......@@ -61,8 +61,8 @@ defines a macro:
ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget)
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.
::
......
......@@ -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
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
SWIG_EXECUTABLE
``SWIG_EXECUTABLE``
#]=======================================================================]
find_program(SWIG_EXECUTABLE NAMES swig3.0 swig2.0 swig)
......
......@@ -5,7 +5,7 @@
FindTIFF
--------
Find the TIFF library (libtiff).
Find the TIFF library (``libtiff``).
Imported targets
^^^^^^^^^^^^^^^^
......
......@@ -7,8 +7,9 @@ FindUnixCommands
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)
......
......@@ -7,7 +7,7 @@ GenerateExportHeader
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
suitable for preprocessor inclusion which contains EXPORT macros to be
......
......@@ -7,8 +7,8 @@ UseQt4
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.
#]=======================================================================]
......@@ -105,4 +105,3 @@ foreach(module QT3SUPPORT QTOPENGL QTASSISTANT QTDESIGNER QTMOTIF QTNSPLUGIN
endif ()
endforeach()
......@@ -5,7 +5,7 @@
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
inclusion which contains macros to be used in source code::
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment