Help: Improve documentation formating
This commit is contained in:
Bartosz Kosiorek
parent
5ad73b608d
commit
456e0fb64f
@ -9,7 +9,7 @@ Get a global property of the CMake instance.
|
||||
|
||||
Gets a global property from the CMake instance. The value of
|
||||
the ``<property>`` is stored in the variable ``<var>``.
|
||||
If the property is not found, ``<var>`` will be set to ``"NOTFOUND"``.
|
||||
If the property is not found, ``<var>`` will be set to ``NOTFOUND``.
|
||||
See the :manual:`cmake-properties(7)` manual for available properties.
|
||||
|
||||
See also the :command:`get_property` command ``GLOBAL`` option.
|
||||
|
||||
@ -11,7 +11,7 @@ Get a property from a target. The value of the property is stored in
|
||||
the variable ``VAR``. If the target property is not found, the behavior
|
||||
depends on whether it has been defined to be an ``INHERITED`` property
|
||||
or not (see :command:`define_property`). Non-inherited properties will
|
||||
set ``VAR`` to "NOTFOUND", whereas inherited properties will search the
|
||||
set ``VAR`` to ``NOTFOUND``, whereas inherited properties will search the
|
||||
relevant parent scope as described for the :command:`define_property`
|
||||
command and if still unable to find the property, ``VAR`` will be set to
|
||||
an empty string.
|
||||
|
||||
@ -227,7 +227,7 @@ above. The result is ``OFF`` which is false. However, if we remove the
|
||||
|
||||
if(var2)
|
||||
|
||||
which is true because ``var2`` is defined to "var1" which is not a false
|
||||
which is true because ``var2`` is defined to ``var1`` which is not a false
|
||||
constant.
|
||||
|
||||
Automatic evaluation applies in the other cases whenever the
|
||||
|
||||
@ -13,7 +13,7 @@ Include an external Microsoft project file in a workspace.
|
||||
|
||||
Includes an external Microsoft project in the generated workspace
|
||||
file. Currently does nothing on UNIX. This will create a target
|
||||
named [projectname]. This can be used in the :command:`add_dependencies`
|
||||
named ``[projectname]``. This can be used in the :command:`add_dependencies`
|
||||
command to make things depend on the external project.
|
||||
|
||||
``TYPE``, ``GUID`` and ``PLATFORM`` are optional parameters that allow one to
|
||||
|
||||
@ -21,7 +21,7 @@ or its corresponding location in the binary tree may be listed. If a
|
||||
file specified already has an extension, that extension will be
|
||||
removed first. This is useful for providing lists of source files
|
||||
such as foo.cxx when you want the corresponding foo.h to be installed.
|
||||
A typical extension is '.h'.
|
||||
A typical extension is ``.h``.
|
||||
|
||||
::
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ Supported operators are ``+``, ``-``, ``*``, ``/``, ``%``, ``|``, ``&``,
|
||||
``^``, ``~``, ``<<``, ``>>``, and ``(...)``; they have the same meaning
|
||||
as in C code.
|
||||
|
||||
Hexadecimal numbers are recognized when prefixed with "0x", as in C code.
|
||||
Hexadecimal numbers are recognized when prefixed with ``0x``, as in C code.
|
||||
|
||||
The result is formatted according to the option ``OUTPUT_FORMAT``,
|
||||
where ``<format>`` is one of
|
||||
|
||||
@ -14,6 +14,6 @@ more advanced scanner.
|
||||
output_required_files(srcfile outputfile)
|
||||
|
||||
Outputs a list of all the source files that are required by the
|
||||
specified srcfile. This list is written into outputfile. This is
|
||||
similar to writing out the dependencies for srcfile except that it
|
||||
jumps from .h files into .cxx, .c and .cpp files if possible.
|
||||
specified ``srcfile``. This list is written into ``outputfile``. This is
|
||||
similar to writing out the dependencies for ``srcfile`` except that it
|
||||
jumps from ``.h`` files into ``.cxx``, ``.c`` and ``.cpp`` files if possible.
|
||||
|
||||
@ -57,7 +57,7 @@ Each ``<item>`` may be:
|
||||
as when a shared library is detected to have no ``SONAME`` field.
|
||||
See policy :policy:`CMP0060` for discussion of another case.
|
||||
|
||||
If the library file is in a Mac OSX framework, the ``Headers`` directory
|
||||
If the library file is in a macOS framework, the ``Headers`` directory
|
||||
of the framework will also be processed as a
|
||||
:ref:`usage requirement <Target Usage Requirements>`. This has the same
|
||||
effect as passing the framework directory as an include directory.
|
||||
|
||||
@ -12,26 +12,27 @@ Bundle-specific parameters (``CPACK_BUNDLE_xxx``).
|
||||
|
||||
.. variable:: CPACK_BUNDLE_NAME
|
||||
|
||||
The name of the generated bundle. This appears in the OSX finder as the
|
||||
The name of the generated bundle. This appears in the macOS Finder as the
|
||||
bundle name. Required.
|
||||
|
||||
.. variable:: CPACK_BUNDLE_PLIST
|
||||
|
||||
Path to an OSX plist file that will be used for the generated bundle. This
|
||||
assumes that the caller has generated or specified their own Info.plist
|
||||
Path to an macOS Property List (``.plist``) file that will be used
|
||||
for the generated bundle. This
|
||||
assumes that the caller has generated or specified their own ``Info.plist``
|
||||
file. Required.
|
||||
|
||||
.. variable:: CPACK_BUNDLE_ICON
|
||||
|
||||
Path to an OSX icon file that will be used as the icon for the generated
|
||||
bundle. This is the icon that appears in the OSX finder for the bundle, and
|
||||
in the OSX dock when the bundle is opened. Required.
|
||||
Path to an macOS icon file that will be used as the icon for the generated
|
||||
bundle. This is the icon that appears in the macOS Finder for the bundle, and
|
||||
in the macOS dock when the bundle is opened. Required.
|
||||
|
||||
.. variable:: CPACK_BUNDLE_STARTUP_COMMAND
|
||||
|
||||
Path to a startup script. This is a path to an executable or script that
|
||||
will be run whenever an end-user double-clicks the generated bundle in the
|
||||
OSX Finder. Optional.
|
||||
macOS Finder. Optional.
|
||||
|
||||
.. variable:: CPACK_BUNDLE_APPLE_CERT_APP
|
||||
|
||||
@ -42,8 +43,9 @@ Bundle-specific parameters (``CPACK_BUNDLE_xxx``).
|
||||
|
||||
.. variable:: CPACK_BUNDLE_APPLE_ENTITLEMENTS
|
||||
|
||||
The name of the ``Plist`` file that contains your apple entitlements for sandboxing
|
||||
your application. This file is required for submission to the Mac App Store.
|
||||
The name of the Property List (``.plist``) file that contains your Apple
|
||||
entitlements for sandboxing your application. This file is required
|
||||
for submission to the macOS App Store.
|
||||
|
||||
.. variable:: CPACK_BUNDLE_APPLE_CODESIGN_FILES
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ provided by CPack, such as component installation and the dependency graph.
|
||||
Integration with External Packaging Tools
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The CPack External generator generates a .json file containing the
|
||||
The CPack External generator generates a ``.json`` file containing the
|
||||
CPack internal metadata, which gives external software information
|
||||
on how to package the software. External packaging software may itself
|
||||
invoke CPack, consume the generated metadata,
|
||||
|
||||
@ -22,19 +22,19 @@ http://www.rpm.org/wiki/Docs
|
||||
|
||||
.. note::
|
||||
|
||||
`<COMPONENT>` part of variables is preferred to be in upper case (for e.g. if
|
||||
component is named `foo` then use `CPACK_RPM_FOO_XXXX` variable name format)
|
||||
as is with other `CPACK_<COMPONENT>_XXXX` variables.
|
||||
`<COMPONENT>` part of variables is preferred to be in upper case (e.g. if
|
||||
component is named ``foo`` then use ``CPACK_RPM_FOO_XXXX`` variable name format)
|
||||
as is with other ``CPACK_<COMPONENT>_XXXX`` variables.
|
||||
For the purposes of back compatibility (CMake/CPack version 3.5 and lower)
|
||||
support for same cased component (e.g. `fOo` would be used as
|
||||
`CPACK_RPM_fOo_XXXX`) is still supported for variables defined in older
|
||||
support for same cased component (e.g. ``fOo`` would be used as
|
||||
``CPACK_RPM_fOo_XXXX``) is still supported for variables defined in older
|
||||
versions of CMake/CPack but is not guaranteed for variables that
|
||||
will be added in the future. For the sake of back compatibility same cased
|
||||
component variables also override upper cased versions where both are
|
||||
present.
|
||||
|
||||
Here are some CPack RPM generator wiki resources that are here for historic reasons and
|
||||
are no longer maintained but may still prove useful:
|
||||
Here are some CPack RPM generator wiki resources that are here for historic
|
||||
reasons and are no longer maintained but may still prove useful:
|
||||
|
||||
- https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/Configuration
|
||||
- https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/PackageGenerators#rpm-unix-only
|
||||
@ -48,8 +48,8 @@ List of CPack RPM generator specific variables:
|
||||
* Mandatory : NO
|
||||
* Default : OFF
|
||||
|
||||
If enabled (ON) multiple packages are generated. By default a single package
|
||||
containing files of all components is generated.
|
||||
If enabled (``ON``) multiple packages are generated. By default
|
||||
a single package containing files of all components is generated.
|
||||
|
||||
.. variable:: CPACK_RPM_PACKAGE_SUMMARY
|
||||
CPACK_RPM_<component>_PACKAGE_SUMMARY
|
||||
@ -76,14 +76,14 @@ List of CPack RPM generator specific variables:
|
||||
* Default : ``<CPACK_PACKAGE_FILE_NAME>[-<component>].rpm`` with spaces
|
||||
replaced by '-'
|
||||
|
||||
This may be set to ``RPM-DEFAULT`` to allow rpmbuild tool to generate package
|
||||
This may be set to ``RPM-DEFAULT`` to allow ``rpmbuild`` tool to generate package
|
||||
file name by itself.
|
||||
Alternatively provided package file name must end with ``.rpm`` suffix.
|
||||
|
||||
.. note::
|
||||
|
||||
By using user provided spec file, rpm macro extensions such as for
|
||||
generating debuginfo packages or by simply using multiple components more
|
||||
generating ``debuginfo`` packages or by simply using multiple components more
|
||||
than one rpm file may be generated, either from a single spec file or from
|
||||
multiple spec files (each component execution produces its own spec file).
|
||||
In such cases duplicate file names may occur as a result of this variable
|
||||
@ -127,7 +127,7 @@ List of CPack RPM generator specific variables:
|
||||
* Mandatory : YES
|
||||
* Default : Native architecture output by ``uname -m``
|
||||
|
||||
This may be set to ``noarch`` if you know you are building a noarch package.
|
||||
This may be set to ``noarch`` if you know you are building a ``noarch`` package.
|
||||
|
||||
.. variable:: CPACK_RPM_PACKAGE_RELEASE
|
||||
|
||||
@ -207,7 +207,7 @@ List of CPack RPM generator specific variables:
|
||||
* Default : -
|
||||
|
||||
May be used to override RPM compression type to be used to build the
|
||||
RPM. For example some Linux distribution now default to lzma or xz
|
||||
RPM. For example some Linux distribution now default to ``lzma`` or ``xz``
|
||||
compression whereas older cannot use such RPM. Using this one can enforce
|
||||
compression type to be used.
|
||||
|
||||
@ -226,8 +226,8 @@ List of CPack RPM generator specific variables:
|
||||
* Mandatory : NO
|
||||
* Default : -
|
||||
|
||||
May be used to enable (1, yes) or disable (0, no) automatic shared libraries
|
||||
dependency detection. Dependencies are added to requires list.
|
||||
May be used to enable (``1``, ``yes``) or disable (``0``, ``no``) automatic
|
||||
shared libraries dependency detection. Dependencies are added to requires list.
|
||||
|
||||
.. note::
|
||||
|
||||
@ -241,9 +241,9 @@ List of CPack RPM generator specific variables:
|
||||
* Mandatory : NO
|
||||
* Default : -
|
||||
|
||||
May be used to enable (1, yes) or disable (0, no) automatic listing of shared
|
||||
libraries that are provided by the package. Shared libraries are added to
|
||||
provides list.
|
||||
May be used to enable (``1``, ``yes``) or disable (``0``, ``no``)
|
||||
automatic listing of shared libraries that are provided by the package.
|
||||
Shared libraries are added to provides list.
|
||||
|
||||
.. note::
|
||||
|
||||
@ -258,8 +258,8 @@ List of CPack RPM generator specific variables:
|
||||
* Default : -
|
||||
|
||||
Variable enables/disables autoreq and autoprov at the same time.
|
||||
See :variable:`CPACK_RPM_PACKAGE_AUTOREQ` and :variable:`CPACK_RPM_PACKAGE_AUTOPROV`
|
||||
for more details.
|
||||
See :variable:`CPACK_RPM_PACKAGE_AUTOREQ` and
|
||||
:variable:`CPACK_RPM_PACKAGE_AUTOPROV` for more details.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@ -4,14 +4,14 @@ CodeBlocks
|
||||
Generates CodeBlocks project files.
|
||||
|
||||
Project files for CodeBlocks will be created in the top directory and
|
||||
in every subdirectory which features a CMakeLists.txt file containing
|
||||
a PROJECT() call. Additionally a hierarchy of makefiles is generated
|
||||
in every subdirectory which features a ``CMakeLists.txt`` file containing
|
||||
a :command:`project` call. Additionally a hierarchy of makefiles is generated
|
||||
into the build tree.
|
||||
The :variable:`CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES` variable may
|
||||
be set to ``ON`` to exclude any files which are located outside of
|
||||
the project root directory.
|
||||
The appropriate make program can build the
|
||||
project through the default make target. A "make install" target is
|
||||
project through the default ``all`` target. An ``install`` target is
|
||||
also provided.
|
||||
|
||||
This "extra" generator may be specified as:
|
||||
|
||||
@ -7,11 +7,11 @@ Project files for CodeLite will be created in the top directory and
|
||||
in every subdirectory which features a CMakeLists.txt file containing
|
||||
a :command:`project` call.
|
||||
The :variable:`CMAKE_CODELITE_USE_TARGETS` variable may be set to ``ON``
|
||||
to change the default behaviour from projects to targets as the basis
|
||||
to change the default behavior from projects to targets as the basis
|
||||
for project files.
|
||||
The appropriate make program can build the
|
||||
project through the default make target. A "make install" target is
|
||||
also provided.
|
||||
project through the default ``all`` target. An ``install`` target
|
||||
is also provided.
|
||||
|
||||
This "extra" generator may be specified as:
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ Project files for Eclipse will be created in the top directory. In
|
||||
out of source builds, a linked resource to the top level source
|
||||
directory will be created. Additionally a hierarchy of makefiles is
|
||||
generated into the build tree. The appropriate make program can build
|
||||
the project through the default make target. A "make install" target
|
||||
the project through the default ``all`` target. An ``install`` target
|
||||
is also provided.
|
||||
|
||||
This "extra" generator may be specified as:
|
||||
|
||||
@ -9,8 +9,9 @@ via the :variable:`CMAKE_BUILD_TYPE` variable.
|
||||
Customizations that are used to pick toolset and target system:
|
||||
|
||||
The ``-A <arch>`` can be supplied for setting the target architecture.
|
||||
``<arch>`` usually is one of "arm", "ppc", "86", etcetera. If the target architecture
|
||||
is not specified then the default architecture of "arm" will be used.
|
||||
``<arch>`` usually is one of ``arm``, ``ppc``, ``86``, etcetera.
|
||||
If the target architecture is not specified then
|
||||
the default architecture of ``arm`` will be used.
|
||||
|
||||
The ``-T <toolset>`` option can be used to set the directory location of the toolset.
|
||||
Both absolute and relative paths are valid. Relative paths use ``GHS_TOOLSET_ROOT``
|
||||
|
||||
@ -5,10 +5,10 @@ Generates Kate project files.
|
||||
|
||||
A project file for Kate will be created in the top directory in the top level
|
||||
build directory.
|
||||
To use it in kate, the Project plugin must be enabled.
|
||||
The project file is loaded in kate simply by opening the
|
||||
ProjectName.kateproject file in the editor.
|
||||
If the kate Build-plugin is enabled, all targets generated by CMake are
|
||||
To use it in Kate, the Project plugin must be enabled.
|
||||
The project file is loaded in Kate by opening the
|
||||
``ProjectName.kateproject`` file in the editor.
|
||||
If the Kate Build-plugin is enabled, all targets generated by CMake are
|
||||
available for building.
|
||||
|
||||
This "extra" generator may be specified as:
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
MSYS Makefiles
|
||||
--------------
|
||||
|
||||
Generates makefiles for use with MSYS ``make`` under the MSYS shell.
|
||||
Generates makefiles for use with MSYS (Minimal SYStem)
|
||||
``make`` under the MSYS shell.
|
||||
|
||||
Use this generator in a MSYS shell prompt and using ``make`` as the build
|
||||
tool. The generated makefiles use ``/bin/sh`` as the shell to launch build
|
||||
|
||||
@ -4,7 +4,8 @@ MinGW Makefiles
|
||||
Generates makefiles for use with ``mingw32-make`` under a Windows command
|
||||
prompt.
|
||||
|
||||
Use this generator under a Windows command prompt with MinGW in the ``PATH``
|
||||
Use this generator under a Windows command prompt with
|
||||
MinGW (Minimalist GNU for Windows) in the ``PATH``
|
||||
and using ``mingw32-make`` as the build tool. The generated makefiles use
|
||||
``cmd.exe`` as the shell to launch build rules. They are not compatible with
|
||||
MSYS or a unix shell.
|
||||
|
||||
@ -4,8 +4,8 @@ Ninja
|
||||
Generates build.ninja files.
|
||||
|
||||
A build.ninja file is generated into the build tree. Recent versions
|
||||
of the ninja program can build the project through the "all" target.
|
||||
An "install" target is also provided.
|
||||
of the ninja program can build the project through the ``all`` target.
|
||||
An ``install`` target is also provided.
|
||||
|
||||
For each subdirectory ``sub/dir`` of the project, additional targets
|
||||
are generated:
|
||||
|
||||
@ -4,11 +4,11 @@ Sublime Text 2
|
||||
Generates Sublime Text 2 project files.
|
||||
|
||||
Project files for Sublime Text 2 will be created in the top directory
|
||||
and in every subdirectory which features a CMakeLists.txt file
|
||||
containing a PROJECT() call. Additionally Makefiles (or build.ninja
|
||||
files) are generated into the build tree. The appropriate make
|
||||
program can build the project through the default make target. A
|
||||
"make install" target is also provided.
|
||||
and in every subdirectory which features a ``CMakeLists.txt`` file
|
||||
containing a :command:`project` call. Additionally ``Makefiles``
|
||||
(or ``build.ninja`` files) are generated into the build tree.
|
||||
The appropriate make program can build the project through the default ``all``
|
||||
target. An ``install`` target is also provided.
|
||||
|
||||
This "extra" generator may be specified as:
|
||||
|
||||
|
||||
@ -5,4 +5,4 @@ Generates standard UNIX makefiles.
|
||||
|
||||
A hierarchy of UNIX makefiles is generated into the build tree. Any
|
||||
standard UNIX-style make program can build the project through the
|
||||
default make target. A "make install" target is also provided.
|
||||
default ``all`` target. An ``install`` target is also provided.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
For each toolset that comes with this version of Visual Studio, there are
|
||||
variants that are themselves compiled for 32-bit (x86) and 64-bit (x64) hosts
|
||||
(independent of the architecture they target).
|
||||
variants that are themselves compiled for 32-bit (``x86``) and
|
||||
64-bit (``x64``) hosts (independent of the architecture they target).
|
||||
|VS_TOOLSET_HOST_ARCH_DEFAULT|
|
||||
One may explicitly request use of either the 32-bit or 64-bit host tools
|
||||
by adding either ``host=x86`` or ``host=x64`` to the toolset specification.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
CPackWIX
|
||||
--------
|
||||
|
||||
The documentation for the CPack WIX generator has moved here: :cpack_gen:`CPack WIX Generator`
|
||||
The documentation for the CPack WIX generator has moved here:
|
||||
:cpack_gen:`CPack WIX Generator`
|
||||
|
||||
@ -12,11 +12,12 @@ In CMake 2.4 and below it is possible to write code like
|
||||
where ``somelib`` is supposed to be a valid library file name such as
|
||||
``libsomelib.a`` or ``somelib.lib``. For Makefile generators this
|
||||
produces an error at build time because the dependency on the full
|
||||
path cannot be found. For VS IDE and Xcode generators this used to
|
||||
path cannot be found. For :ref:`Visual Studio Generators` IDE
|
||||
and :generator:`Xcode` generators this used to
|
||||
work by accident because CMake would always split off the library
|
||||
directory and ask the linker to search for the library by name
|
||||
(``-lsomelib`` or ``somelib.lib``). Despite the failure with Makefiles, some
|
||||
projects have code like this and build only with VS and/or Xcode.
|
||||
projects have code like this and build only with Visual Studio and/or Xcode.
|
||||
This version of CMake prefers to pass the full path directly to the
|
||||
native build tool, which will fail in this case because it does not
|
||||
name a valid library file.
|
||||
|
||||
@ -4,11 +4,11 @@ CMP0014
|
||||
Input directories must have ``CMakeLists.txt``.
|
||||
|
||||
CMake versions before 2.8 silently ignored missing ``CMakeLists.txt``
|
||||
files in directories referenced by add_subdirectory() or subdirs(),
|
||||
files in directories referenced by :command:`add_subdirectory` or :command:`subdirs`,
|
||||
treating them as if present but empty. In CMake 2.8.0 and above this
|
||||
policy determines whether or not the case is an error. The ``OLD``
|
||||
behavior for this policy is to silently ignore the problem. The ``NEW``
|
||||
behavior for this policy is to report an error.
|
||||
:command:`cmake_policy` determines whether or not the case is an error.
|
||||
The ``OLD`` behavior for this policy is to silently ignore the problem.
|
||||
The ``NEW`` behavior for this policy is to report an error.
|
||||
|
||||
This policy was introduced in CMake version 2.8.0. CMake version
|
||||
|release| warns when the policy is not set and uses ``OLD`` behavior. Use
|
||||
|
||||
@ -1,16 +1,16 @@
|
||||
CMP0015
|
||||
-------
|
||||
|
||||
link_directories() treats paths relative to the source dir.
|
||||
:command:`link_directories` treats paths relative to the source dir.
|
||||
|
||||
In CMake 2.8.0 and lower the link_directories() command passed
|
||||
In CMake 2.8.0 and lower the :command:`link_directories` command passed
|
||||
relative paths unchanged to the linker. In CMake 2.8.1 and above the
|
||||
link_directories() command prefers to interpret relative paths with
|
||||
respect to CMAKE_CURRENT_SOURCE_DIR, which is consistent with
|
||||
include_directories() and other commands. The ``OLD`` behavior for this
|
||||
policy is to use relative paths verbatim in the linker command. The
|
||||
:command:`link_directories` command prefers to interpret relative paths with
|
||||
respect to ``CMAKE_CURRENT_SOURCE_DIR``, which is consistent with
|
||||
:command:`include_directories` and other commands. The ``OLD`` behavior for
|
||||
this policy is to use relative paths verbatim in the linker command. The
|
||||
``NEW`` behavior for this policy is to convert relative paths to absolute
|
||||
paths by appending the relative path to CMAKE_CURRENT_SOURCE_DIR.
|
||||
paths by appending the relative path to ``CMAKE_CURRENT_SOURCE_DIR``.
|
||||
|
||||
This policy was introduced in CMake version 2.8.1. CMake version
|
||||
|release| warns when the policy is not set and uses ``OLD`` behavior. Use
|
||||
|
||||
@ -5,12 +5,12 @@ Prefer files from the CMake module directory when including from there.
|
||||
|
||||
Starting with CMake 2.8.4, if a cmake-module shipped with CMake (i.e.
|
||||
located in the CMake module directory) calls :command:`include` or
|
||||
find_package(), the files located in the CMake module directory are
|
||||
:command:`find_package`, the files located in the CMake module directory are
|
||||
preferred over the files in :variable:`CMAKE_MODULE_PATH`. This makes sure
|
||||
that the modules belonging to CMake always get those files included which
|
||||
they expect, and against which they were developed and tested. In all
|
||||
other cases, the files found in :variable:`CMAKE_MODULE_PATH` still take
|
||||
precedence over the ones in the CMake module directory. The OLD
|
||||
precedence over the ones in the CMake module directory. The ``OLD``
|
||||
behavior is to always prefer files from CMAKE_MODULE_PATH over files
|
||||
from the CMake modules directory.
|
||||
|
||||
|
||||
@ -10,8 +10,9 @@ as :manual:`cmake-generator-expressions(7)` and some
|
||||
diagnostics expect target names to match a restricted pattern.
|
||||
|
||||
Target names may contain upper and lower case letters, numbers, the underscore
|
||||
character (_), dot(.), plus(+) and minus(-). As a special case, ALIAS
|
||||
targets and ``IMPORTED`` targets may contain two consecutive colons.
|
||||
character (``_``), dot(``.``), plus(``+``) and minus(``-``).
|
||||
As a special case, ``ALIAS`` and ``IMPORTED`` targets may contain
|
||||
two consecutive colons.
|
||||
|
||||
Target names reserved by one or more CMake generators are not allowed.
|
||||
Among others these include ``all``, ``clean``, ``help``, and ``install``.
|
||||
|
||||
@ -3,5 +3,5 @@ ADDITIONAL_MAKE_CLEAN_FILES
|
||||
|
||||
Additional files to clean during the make clean stage.
|
||||
|
||||
A list of files that will be cleaned as a part of the "make clean"
|
||||
A list of files that will be cleaned as a part of the ``make clean``
|
||||
stage.
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
|
||||
----------------------------------
|
||||
|
||||
Specify #include line transforms for dependencies in a directory.
|
||||
Specify ``#include`` line transforms for dependencies in a directory.
|
||||
|
||||
This property specifies rules to transform macro-like #include lines
|
||||
This property specifies rules to transform macro-like ``#include`` lines
|
||||
during implicit dependency scanning of C and C++ source files. The
|
||||
list of rules must be semicolon-separated with each entry of the form
|
||||
"A_MACRO(%)=value-with-%" (the % must be literal). During dependency
|
||||
scanning occurrences of A_MACRO(...) on #include lines will be
|
||||
``A_MACRO(%)=value-with-%`` (the ``%`` must be literal). During dependency
|
||||
scanning occurrences of ``A_MACRO(...)`` on ``#include`` lines will be
|
||||
replaced by the value given with the macro argument substituted for
|
||||
'%'. For example, the entry
|
||||
``%``. For example, the entry
|
||||
|
||||
::
|
||||
|
||||
|
||||
@ -3,6 +3,6 @@ INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
|
||||
|
||||
Per-configuration interprocedural optimization for a directory.
|
||||
|
||||
This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION.
|
||||
This is a per-configuration version of ``INTERPROCEDURAL_OPTIMIZATION``.
|
||||
If set, this property overrides the generic property for the named
|
||||
configuration.
|
||||
|
||||
@ -4,5 +4,5 @@ MACROS
|
||||
List of macro commands available in the current directory.
|
||||
|
||||
This read-only property specifies the list of CMake macros currently
|
||||
defined. It is intended for debugging purposes. See the macro
|
||||
defined. It is intended for debugging purposes. See the :command:`macro`
|
||||
command.
|
||||
|
||||
@ -3,5 +3,6 @@ TESTS
|
||||
|
||||
List of tests.
|
||||
|
||||
This read-only property holds a :ref:`semicolon-separated list <CMake Language Lists>` of tests
|
||||
This read-only property holds a
|
||||
:ref:`semicolon-separated list <CMake Language Lists>` of tests
|
||||
defined so far, in the current directory, by the :command:`add_test` command.
|
||||
|
||||
@ -12,20 +12,20 @@ in the solution file:
|
||||
<contents based on property value>
|
||||
EndGlobalSection
|
||||
|
||||
The property must be set to a semicolon-separated list of key=value
|
||||
The property must be set to a semicolon-separated list of ``key=value``
|
||||
pairs. Each such pair will be transformed into an entry in the
|
||||
solution global section. Whitespace around key and value is ignored.
|
||||
List elements which do not contain an equal sign are skipped.
|
||||
|
||||
This property only works for Visual Studio 9 and above; it is ignored
|
||||
on other generators. The property only applies when set on a
|
||||
directory whose CMakeLists.txt contains a project() command.
|
||||
directory whose ``CMakeLists.txt`` contains a :command:`project` command.
|
||||
|
||||
Note that CMake generates postSolution sections ExtensibilityGlobals
|
||||
and ExtensibilityAddIns by default. If you set the corresponding
|
||||
Note that CMake generates postSolution sections ``ExtensibilityGlobals``
|
||||
and ``ExtensibilityAddIns`` by default. If you set the corresponding
|
||||
property, it will override the default section. For example, setting
|
||||
VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default
|
||||
contents of the ExtensibilityGlobals section, while keeping
|
||||
``VS_GLOBAL_SECTION_POST_ExtensibilityGlobals`` will override the default
|
||||
contents of the ``ExtensibilityGlobals`` section, while keeping
|
||||
ExtensibilityAddIns on its default. However, CMake will always
|
||||
add a ``SolutionGuid`` to the ``ExtensibilityGlobals`` section
|
||||
if it is not specified explicitly.
|
||||
|
||||
@ -12,11 +12,11 @@ in the solution file:
|
||||
<contents based on property value>
|
||||
EndGlobalSection
|
||||
|
||||
The property must be set to a semicolon-separated list of key=value
|
||||
The property must be set to a semicolon-separated list of ``key=value``
|
||||
pairs. Each such pair will be transformed into an entry in the
|
||||
solution global section. Whitespace around key and value is ignored.
|
||||
List elements which do not contain an equal sign are skipped.
|
||||
|
||||
This property only works for Visual Studio 9 and above; it is ignored
|
||||
on other generators. The property only applies when set on a
|
||||
directory whose CMakeLists.txt contains a project() command.
|
||||
directory whose ``CMakeLists.txt`` contains a :command:`project` command.
|
||||
|
||||
@ -7,7 +7,7 @@ The :ref:`Visual Studio Generators` create a ``.sln`` file for each directory
|
||||
whose ``CMakeLists.txt`` file calls the :command:`project` command. Set this
|
||||
property in the same directory as a :command:`project` command call (e.g. in
|
||||
the top-level ``CMakeLists.txt`` file) to specify the default startup project
|
||||
for the correpsonding solution file.
|
||||
for the corresponding solution file.
|
||||
|
||||
The property must be set to the name of an existing target. This
|
||||
will cause that project to be listed first in the generated solution
|
||||
|
||||
@ -4,16 +4,18 @@ ALLOW_DUPLICATE_CUSTOM_TARGETS
|
||||
Allow duplicate custom targets to be created.
|
||||
|
||||
Normally CMake requires that all targets built in a project have
|
||||
globally unique logical names (see policy CMP0002). This is necessary
|
||||
to generate meaningful project file names in Xcode and VS IDE
|
||||
globally unique logical names (see policy :policy:`CMP0002`).
|
||||
This is necessary to generate meaningful project file names in
|
||||
:generator:`Xcode` and :ref:`Visual Studio Generators` IDE
|
||||
generators. It also allows the target names to be referenced
|
||||
unambiguously.
|
||||
|
||||
Makefile generators are capable of supporting duplicate custom target
|
||||
names. For projects that care only about Makefile generators and do
|
||||
not wish to support Xcode or VS IDE generators, one may set this
|
||||
property to true to allow duplicate custom targets. The property
|
||||
allows multiple add_custom_target command calls in different
|
||||
Makefile generators are capable of supporting duplicate :command:`add_custom_target`
|
||||
names. For projects that care only about :ref:`Makefile Generators` and do
|
||||
not wish to support :generator:`Xcode` or :ref:`Visual Studio Generators` IDE
|
||||
generators, one may set this property to ``True``
|
||||
to allow duplicate custom targets. The property
|
||||
allows multiple :command:`add_custom_target` command calls in different
|
||||
directories to specify the same target name. However, setting this
|
||||
property will cause non-Makefile generators to produce an error and
|
||||
refuse to generate the project.
|
||||
|
||||
@ -5,7 +5,7 @@ List of features which are disabled during the CMake run.
|
||||
|
||||
List of features which are disabled during the CMake run. By default
|
||||
it contains the names of all packages which were not found. This is
|
||||
determined using the <NAME>_FOUND variables. Packages which are
|
||||
searched QUIET are not listed. A project can add its own features to
|
||||
determined using the ``<NAME>_FOUND`` variables. Packages which are
|
||||
searched ``QUIET`` are not listed. A project can add its own features to
|
||||
this list. This property is used by the macros in
|
||||
FeatureSummary.cmake.
|
||||
``FeatureSummary.cmake``.
|
||||
|
||||
@ -5,7 +5,7 @@ List of features which are enabled during the CMake run.
|
||||
|
||||
List of features which are enabled during the CMake run. By default
|
||||
it contains the names of all packages which were found. This is
|
||||
determined using the <NAME>_FOUND variables. Packages which are
|
||||
searched QUIET are not listed. A project can add its own features to
|
||||
determined using the ``<NAME>_FOUND`` variables. Packages which are
|
||||
searched ``QUIET`` are not listed. A project can add its own features to
|
||||
this list. This property is used by the macros in
|
||||
FeatureSummary.cmake.
|
||||
``FeatureSummary.cmake``.
|
||||
|
||||
@ -4,7 +4,7 @@ USE_FOLDERS
|
||||
Use the :prop_tgt:`FOLDER` target property to organize targets into
|
||||
folders.
|
||||
|
||||
If not set, CMake treats this property as OFF by default. CMake
|
||||
If not set, CMake treats this property as ``OFF`` by default. CMake
|
||||
generators that are capable of organizing into a hierarchy of folders
|
||||
use the values of the :prop_tgt:`FOLDER` target property to name those
|
||||
folders. See also the documentation for the FOLDER target property.
|
||||
folders. See also the documentation for the :prop_tgt:`FOLDER` target property.
|
||||
|
||||
@ -1,14 +1,15 @@
|
||||
XCODE_EMIT_EFFECTIVE_PLATFORM_NAME
|
||||
----------------------------------
|
||||
|
||||
Control emission of ``EFFECTIVE_PLATFORM_NAME`` by the Xcode generator.
|
||||
Control emission of ``EFFECTIVE_PLATFORM_NAME`` by the :generator:`Xcode`
|
||||
generator.
|
||||
|
||||
It is required for building the same target with multiple SDKs. A
|
||||
common use case is the parallel use of ``iphoneos`` and
|
||||
``iphonesimulator`` SDKs.
|
||||
|
||||
Three different states possible that control when the Xcode generator
|
||||
emits the ``EFFECTIVE_PLATFORM_NAME`` variable:
|
||||
Three different states possible that control when the :generator:`Xcode`
|
||||
generator emits the ``EFFECTIVE_PLATFORM_NAME`` variable:
|
||||
|
||||
- If set to ``ON`` it will always be emitted
|
||||
- If set to ``OFF`` it will never be emitted
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CPACK_DESKTOP_SHORTCUTS
|
||||
-----------------------
|
||||
|
||||
Species a list of shortcut names that should be created on the Desktop
|
||||
Species a list of shortcut names that should be created on the `Desktop`
|
||||
for this file.
|
||||
|
||||
The property is currently only supported by the WIX generator.
|
||||
The property is currently only supported by the :cpack_gen:`CPack WIX Generator`.
|
||||
|
||||
@ -3,4 +3,4 @@ CPACK_NEVER_OVERWRITE
|
||||
|
||||
Request that this file not be overwritten on install or reinstall.
|
||||
|
||||
The property is currently only supported by the WIX generator.
|
||||
The property is currently only supported by the :cpack_gen:`CPack WIX Generator`.
|
||||
|
||||
@ -3,4 +3,4 @@ CPACK_PERMANENT
|
||||
|
||||
Request that this file not be removed on uninstall.
|
||||
|
||||
The property is currently only supported by the WIX generator.
|
||||
The property is currently only supported by the :cpack_gen:`CPack WIX Generator`.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CPACK_STARTUP_SHORTCUTS
|
||||
-----------------------
|
||||
|
||||
Species a list of shortcut names that should be created in the Startup folder
|
||||
Species a list of shortcut names that should be created in the `Startup` folder
|
||||
for this file.
|
||||
|
||||
The property is currently only supported by the WIX generator.
|
||||
The property is currently only supported by the :cpack_gen:`CPack WIX Generator`.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
CPACK_START_MENU_SHORTCUTS
|
||||
--------------------------
|
||||
|
||||
Species a list of shortcut names that should be created in the Start Menu
|
||||
Species a list of shortcut names that should be created in the `Start Menu`
|
||||
for this file.
|
||||
|
||||
The property is currently only supported by the WIX generator.
|
||||
The property is currently only supported by the :cpack_gen:`CPack WIX Generator`.
|
||||
|
||||
@ -17,3 +17,5 @@ each of which has to match the following format.
|
||||
``<permission>`` is any of the YesNoType attributes listed here::
|
||||
|
||||
http://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html
|
||||
|
||||
The property is currently only supported by the :cpack_gen:`CPack WIX Generator`.
|
||||
|
||||
@ -3,14 +3,14 @@ COMPILE_DEFINITIONS
|
||||
|
||||
Preprocessor definitions for compiling a source file.
|
||||
|
||||
The COMPILE_DEFINITIONS property may be set to a semicolon-separated
|
||||
list of preprocessor definitions using the syntax VAR or VAR=value.
|
||||
The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated
|
||||
list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``.
|
||||
Function-style definitions are not supported. CMake will
|
||||
automatically escape the value correctly for the native build system
|
||||
(note that CMake language syntax may require escapes to specify some
|
||||
values). This property may be set on a per-configuration basis using
|
||||
the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case
|
||||
name (ex. "COMPILE_DEFINITIONS_DEBUG").
|
||||
the name ``COMPILE_DEFINITIONS_<CONFIG>`` where ``<CONFIG>`` is an upper-case
|
||||
name (ex. ``COMPILE_DEFINITIONS_DEBUG``).
|
||||
|
||||
CMake will automatically drop some definitions that are not supported
|
||||
by the native build tool. Xcode does not support per-configuration
|
||||
@ -18,7 +18,7 @@ definitions on source files.
|
||||
|
||||
.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt
|
||||
|
||||
Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions"
|
||||
Contents of ``COMPILE_DEFINITIONS`` may use :manual:`cmake-generator-expressions(7)`
|
||||
with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
|
||||
manual for available expressions. However, :generator:`Xcode`
|
||||
does not support per-config per-source settings, so expressions
|
||||
|
||||
@ -5,6 +5,6 @@ Ignored. See CMake Policy :policy:`CMP0043`.
|
||||
|
||||
Per-configuration preprocessor definitions on a source file.
|
||||
|
||||
This is the configuration-specific version of COMPILE_DEFINITIONS.
|
||||
Note that Xcode does not support per-configuration source file flags
|
||||
so this property will be ignored by the Xcode generator.
|
||||
This is the configuration-specific version of :prop_tgt:`COMPILE_DEFINITIONS`.
|
||||
Note that :generator:`Xcode` does not support per-configuration source
|
||||
file flags so this property will be ignored by the :generator:`Xcode` generator.
|
||||
|
||||
@ -3,6 +3,6 @@ EXTERNAL_OBJECT
|
||||
|
||||
If set to true then this is an object file.
|
||||
|
||||
If this property is set to true then the source file is really an
|
||||
If this property is set to ``True`` then the source file is really an
|
||||
object file and should not be compiled. It will still be linked into
|
||||
the target though.
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
Fortran_FORMAT
|
||||
--------------
|
||||
|
||||
Set to FIXED or FREE to indicate the Fortran source layout.
|
||||
Set to ``FIXED`` or ``FREE`` to indicate the Fortran source layout.
|
||||
|
||||
This property tells CMake whether a given Fortran source file uses
|
||||
fixed-format or free-format. CMake will pass the corresponding format
|
||||
flag to the compiler. Consider using the target-wide Fortran_FORMAT
|
||||
property if all source files in a target share the same format.
|
||||
flag to the compiler. Consider using the target-wide
|
||||
:prop_tgt:`Fortran_FORMAT` property if all source files in a target
|
||||
share the same format.
|
||||
|
||||
@ -6,4 +6,4 @@ Make the output file have the same extension as the source file.
|
||||
If this property is set then the file extension of the output file
|
||||
will be the same as that of the source file. Normally the output file
|
||||
extension is computed based on the language of the source file, for
|
||||
example .cxx will go to a .o extension.
|
||||
example ``.cxx`` will go to a ``.o`` extension.
|
||||
|
||||
@ -4,5 +4,5 @@ LABELS
|
||||
Specify a list of text labels associated with a source file.
|
||||
|
||||
This property has meaning only when the source file is listed in a
|
||||
target whose LABELS property is also set. No other semantics are
|
||||
target whose ``LABELS`` property is also set. No other semantics are
|
||||
currently specified.
|
||||
|
||||
@ -5,6 +5,7 @@ What programming language is the file.
|
||||
|
||||
A property that can be set to indicate what programming language the
|
||||
source file is. If it is not set the language is determined based on
|
||||
the file extension. Typical values are CXX C etc. Setting this
|
||||
the file extension. Typical values are ``CXX`` (i.e. C++), ``C``,
|
||||
``CSharp``, ``CUDA``, ``Fortran``, and ``ASM``. Setting this
|
||||
property for a file means this file will be compiled. Do not set this
|
||||
for headers or files that should not be compiled.
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
OBJECT_OUTPUTS
|
||||
--------------
|
||||
|
||||
Additional outputs for a Ninja or Makefile rule.
|
||||
Additional outputs for a :generator:`Ninja` or :ref:`Makefile Generators` rule.
|
||||
|
||||
Additional outputs created by compilation of this source file. If any
|
||||
of these outputs is missing the object will be recompiled. This is
|
||||
supported only on the Ninja and Makefile generators and will be ignored on
|
||||
other generators.
|
||||
supported only on the :generator:`Ninja` and :ref:`Makefile Generators`
|
||||
and will be ignored on other generators.
|
||||
|
||||
@ -3,6 +3,6 @@ SYMBOLIC
|
||||
|
||||
Is this just a name for a rule.
|
||||
|
||||
If SYMBOLIC (boolean) is set to true the build system will be informed
|
||||
If ``SYMBOLIC`` (boolean) is set to ``True`` the build system will be informed
|
||||
that the source file is not actually created on disk but instead used
|
||||
as a symbolic name for a build rule.
|
||||
|
||||
@ -2,5 +2,5 @@ VS_XAML_TYPE
|
||||
------------
|
||||
|
||||
Mark a XAML source file as a different type than the default ``Page``.
|
||||
The most common usage would be to set the default App.xaml file as
|
||||
ApplicationDefinition.
|
||||
The most common usage would be to set the default ``App.xaml`` file as
|
||||
``ApplicationDefinition``.
|
||||
|
||||
@ -5,6 +5,6 @@ Exclude this source file from any code wrapping techniques.
|
||||
|
||||
Some packages can wrap source files into alternate languages to
|
||||
provide additional functionality. For example, C++ code can be
|
||||
wrapped into Java or Python etc using SWIG etc. If WRAP_EXCLUDE is
|
||||
set to true (1 etc) that indicates that this source file should not be
|
||||
wrapped into Java or Python etc using SWIG etc. If ``WRAP_EXCLUDE`` is
|
||||
set to ``True``, that indicates that this source file should not be
|
||||
wrapped.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
XCODE_EXPLICIT_FILE_TYPE
|
||||
------------------------
|
||||
|
||||
Set the Xcode ``explicitFileType`` attribute on its reference to a
|
||||
Set the :generator:`Xcode` ``explicitFileType`` attribute on its reference to a
|
||||
source file. CMake computes a default based on file extension but
|
||||
can be told explicitly with this property.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
XCODE_FILE_ATTRIBUTES
|
||||
---------------------
|
||||
|
||||
Add values to the Xcode ``ATTRIBUTES`` setting on its reference to a
|
||||
Add values to the :generator:`Xcode` ``ATTRIBUTES`` setting on its reference to a
|
||||
source file. Among other things, this can be used to set the role on
|
||||
a mig file::
|
||||
a ``.mig`` file::
|
||||
|
||||
set_source_files_properties(defs.mig
|
||||
PROPERTIES
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
XCODE_LAST_KNOWN_FILE_TYPE
|
||||
--------------------------
|
||||
|
||||
Set the Xcode ``lastKnownFileType`` attribute on its reference to a
|
||||
source file. CMake computes a default based on file extension but
|
||||
Set the :generator:`Xcode` ``lastKnownFileType`` attribute on its reference to
|
||||
a source file. CMake computes a default based on file extension but
|
||||
can be told explicitly with this property.
|
||||
|
||||
See also :prop_sf:`XCODE_EXPLICIT_FILE_TYPE`, which is preferred
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
COST
|
||||
----
|
||||
|
||||
Set this to a floating point value. Tests in a test set will be run in descending order of cost.
|
||||
Set this to a floating point value. Tests in a test set will be run
|
||||
in descending order of cost.
|
||||
|
||||
This property describes the cost of a test. You can explicitly set
|
||||
this value; tests with higher COST values will run first.
|
||||
this value; tests with higher ``COST`` values will run first.
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
DISABLED
|
||||
--------
|
||||
|
||||
If set to true, the test will be skipped and its status will be 'Not Run'. A
|
||||
DISABLED test will not be counted in the total number of tests and its
|
||||
completion status will be reported to CDash as 'Disabled'.
|
||||
If set to ``True``, the test will be skipped and its status will be 'Not Run'. A
|
||||
``DISABLED`` test will not be counted in the total number of tests and its
|
||||
completion status will be reported to CDash as ``Disabled``.
|
||||
|
||||
A DISABLED test does not participate in test fixture dependency resolution.
|
||||
If a DISABLED test has fixture requirements defined in its
|
||||
A ``DISABLED`` test does not participate in test fixture dependency resolution.
|
||||
If a ``DISABLED`` test has fixture requirements defined in its
|
||||
:prop_test:`FIXTURES_REQUIRED` property, it will not cause setup or cleanup
|
||||
tests for those fixtures to be added to the test set.
|
||||
|
||||
If a test with the :prop_test:`FIXTURES_SETUP` property set is DISABLED, the
|
||||
fixture behavior will be as though that setup test was passing and any test
|
||||
If a test with the :prop_test:`FIXTURES_SETUP` property set is ``DISABLED``,
|
||||
the fixture behavior will be as though that setup test was passing and any test
|
||||
case requiring that fixture will still run.
|
||||
|
||||
@ -4,6 +4,6 @@ ENVIRONMENT
|
||||
Specify environment variables that should be defined for running a test.
|
||||
|
||||
If set to a list of environment variables and values of the form
|
||||
MYVAR=value those environment variables will be defined while running
|
||||
``MYVAR=value`` those environment variables will be defined while running
|
||||
the test. The environment is restored to its previous state after the
|
||||
test is done.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
MEASUREMENT
|
||||
-----------
|
||||
|
||||
Specify a CDASH measurement and value to be reported for a test.
|
||||
Specify a ``CDASH`` measurement and value to be reported for a test.
|
||||
|
||||
If set to a name then that name will be reported to CDASH as a named
|
||||
measurement with a value of 1. You may also specify a value by
|
||||
setting MEASUREMENT to "measurement=value".
|
||||
If set to a name then that name will be reported to ``CDASH`` as a named
|
||||
measurement with a value of ``1``. You may also specify a value by
|
||||
setting ``MEASUREMENT`` to ``measurement=value``.
|
||||
|
||||
@ -3,6 +3,6 @@ RUN_SERIAL
|
||||
|
||||
Do not run this test in parallel with any other test.
|
||||
|
||||
Use this option in conjunction with the ctest_test PARALLEL_LEVEL
|
||||
Use this option in conjunction with the ctest_test ``PARALLEL_LEVEL``
|
||||
option to specify that this test should not be run in parallel with
|
||||
any other tests.
|
||||
|
||||
@ -6,4 +6,4 @@ Return code to mark a test as skipped.
|
||||
Sometimes only a test itself can determine if all requirements for the
|
||||
test are met. If such a situation should not be considered a hard failure
|
||||
a return code of the process can be specified that will mark the test as
|
||||
"Not Run" if it is encountered.
|
||||
``Not Run`` if it is encountered.
|
||||
|
||||
@ -6,7 +6,7 @@ generated by the compiler while building source files.
|
||||
|
||||
This is a per-configuration version of
|
||||
:prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY`,
|
||||
but multi-configuration generators (VS, Xcode) do NOT append a
|
||||
but multi-configuration generators (Visual Studio, Xcode) do NOT append a
|
||||
per-configuration subdirectory to the specified directory. This
|
||||
property is initialized by the value of the
|
||||
:variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>` variable
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
DEBUG_POSTFIX
|
||||
-------------
|
||||
|
||||
See target property <CONFIG>_POSTFIX.
|
||||
See target property ``<CONFIG>_POSTFIX``.
|
||||
|
||||
This property is a special case of the more-general <CONFIG>_POSTFIX
|
||||
property for the DEBUG configuration.
|
||||
This property is a special case of the more-general ``<CONFIG>_POSTFIX``
|
||||
property for the ``DEBUG`` configuration.
|
||||
|
||||
@ -3,9 +3,9 @@ DEFINE_SYMBOL
|
||||
|
||||
Define a symbol when compiling this target's sources.
|
||||
|
||||
DEFINE_SYMBOL sets the name of the preprocessor symbol defined when
|
||||
``DEFINE_SYMBOL`` sets the name of the preprocessor symbol defined when
|
||||
compiling sources in a shared library. If not set here then it is set
|
||||
to target_EXPORTS by default (with some substitutions if the target is
|
||||
to ``target_EXPORTS`` by default (with some substitutions if the target is
|
||||
not a valid C identifier). This is useful for headers to know whether
|
||||
they are being included from inside their library or outside to
|
||||
properly setup dllexport/dllimport decorations.
|
||||
|
||||
@ -4,7 +4,7 @@ DOTNET_TARGET_FRAMEWORK_VERSION
|
||||
Specify the .NET target framework version.
|
||||
|
||||
Used to specify the .NET target framework version for C++/CLI. For
|
||||
example, "v4.5".
|
||||
example: ``v4.5``.
|
||||
|
||||
This property is only evaluated for :ref:`Visual Studio Generators`
|
||||
VS 2010 and above.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
EXCLUDE_FROM_DEFAULT_BUILD
|
||||
--------------------------
|
||||
|
||||
Exclude target from "Build Solution".
|
||||
Exclude target from ``Build Solution``.
|
||||
|
||||
This property is only used by Visual Studio generators.
|
||||
When set to TRUE, the target will not be built when you press "Build
|
||||
Solution".
|
||||
When set to ``TRUE``, the target will not be built when you press
|
||||
``Build Solution``.
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>
|
||||
-----------------------------------
|
||||
|
||||
Per-configuration version of target exclusion from "Build Solution".
|
||||
Per-configuration version of target exclusion from ``Build Solution``.
|
||||
|
||||
This is the configuration-specific version of
|
||||
EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD
|
||||
is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes
|
||||
:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD`. If the generic
|
||||
:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD` is also set on a target,
|
||||
``EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>`` takes
|
||||
precedence in configurations for which it has a value.
|
||||
|
||||
@ -3,6 +3,6 @@ EXPORT_NAME
|
||||
|
||||
Exported name for target files.
|
||||
|
||||
This sets the name for the IMPORTED target generated by the
|
||||
This sets the name for the ``IMPORTED`` target generated by the
|
||||
:command:`install(EXPORT)` and :command:`export` commands.
|
||||
If not set, the logical target name is used by default.
|
||||
|
||||
@ -3,5 +3,5 @@ EchoString
|
||||
|
||||
A message to be displayed when the target is built.
|
||||
|
||||
A message to display on some generators (such as makefiles) when the
|
||||
target is built.
|
||||
A message to display on some generators (such as :ref:`Makefile Generators`)
|
||||
when the target is built.
|
||||
|
||||
@ -3,10 +3,10 @@ FOLDER
|
||||
|
||||
Set the folder name. Use to organize targets in an IDE.
|
||||
|
||||
Targets with no FOLDER property will appear as top level entities in
|
||||
IDEs like Visual Studio. Targets with the same FOLDER property value
|
||||
Targets with no ``FOLDER`` property will appear as top level entities in
|
||||
IDEs like Visual Studio. Targets with the same ``FOLDER`` property value
|
||||
will appear next to each other in a folder of that name. To nest
|
||||
folders, use FOLDER values such as 'GUI/Dialogs' with '/' characters
|
||||
folders, use ``FOLDER`` values such as 'GUI/Dialogs' with '/' characters
|
||||
separating folder levels.
|
||||
|
||||
This property is initialized by the value of the variable
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
Fortran_FORMAT
|
||||
--------------
|
||||
|
||||
Set to FIXED or FREE to indicate the Fortran source layout.
|
||||
Set to ``FIXED`` or ``FREE`` to indicate the Fortran source layout.
|
||||
|
||||
This property tells CMake whether the Fortran source files in a target
|
||||
use fixed-format or free-format. CMake will pass the corresponding
|
||||
format flag to the compiler. Use the source-specific Fortran_FORMAT
|
||||
format flag to the compiler. Use the source-specific ``Fortran_FORMAT``
|
||||
property to change the format of a specific source file. If the
|
||||
variable CMAKE_Fortran_FORMAT is set when a target is created its
|
||||
variable :variable:`CMAKE_Fortran_FORMAT` is set when a target is created its
|
||||
value is used to initialize this property.
|
||||
|
||||
@ -8,10 +8,10 @@ the compiler supports a module output directory this specifies the
|
||||
directory in which the modules will be placed. When this property is
|
||||
not set the modules will be placed in the build directory
|
||||
corresponding to the target's source directory. If the variable
|
||||
CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its
|
||||
:variable:`CMAKE_Fortran_MODULE_DIRECTORY` is set when a target is created its
|
||||
value is used to initialize this property.
|
||||
|
||||
Note that some compilers will automatically search the module output
|
||||
directory for modules USEd during compilation but others will not. If
|
||||
your sources USE modules their location must be specified by
|
||||
INCLUDE_DIRECTORIES regardless of this property.
|
||||
:prop_tgt:`INCLUDE_DIRECTORIES` regardless of this property.
|
||||
|
||||
@ -6,4 +6,4 @@ Generator's file for this target.
|
||||
An internal property used by some generators to record the name of the
|
||||
project or dsp file associated with this target. Note that at
|
||||
configure time, this property is only set for targets created by
|
||||
include_external_msproject().
|
||||
:command:`include_external_msproject`.
|
||||
|
||||
@ -4,7 +4,7 @@ GHS_INTEGRITY_APP
|
||||
``ON`` / ``OFF`` boolean to determine if an executable target should
|
||||
be treated as an `Integrity Application`.
|
||||
|
||||
If no value is set and if a `.int` file is added as a source file to the
|
||||
If no value is set and if a ``.int`` file is added as a source file to the
|
||||
executable target it will be treated as an `Integrity Application`.
|
||||
|
||||
Supported on :generator:`Green Hills MULTI`.
|
||||
|
||||
@ -1,17 +1,17 @@
|
||||
GNUtoMS
|
||||
-------
|
||||
|
||||
Convert GNU import library (.dll.a) to MS format (.lib).
|
||||
Convert GNU import library (``.dll.a``) to MS format (``.lib``).
|
||||
|
||||
When linking a shared library or executable that exports symbols using
|
||||
GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert
|
||||
the import library (.dll.a) from GNU to MS format (.lib). Both import
|
||||
libraries will be installed by install(TARGETS) and exported by
|
||||
install(EXPORT) and export() to be linked by applications with either
|
||||
GNU- or MS-compatible tools.
|
||||
the import library (``.dll.a``) from GNU to MS format (``.lib``). Both import
|
||||
libraries will be installed by :command:`install(TARGETS)` and exported by
|
||||
:command:`install(EXPORT)` and :command:`export` to be linked
|
||||
by applications with either GNU- or MS-compatible tools.
|
||||
|
||||
If the variable CMAKE_GNUtoMS is set when a target is created its
|
||||
If the variable ``CMAKE_GNUtoMS`` is set when a target is created its
|
||||
value is used to initialize this property. The variable must be set
|
||||
prior to the first command that enables a language such as project()
|
||||
or enable_language(). CMake provides the variable as an option to the
|
||||
prior to the first command that enables a language such as :command:`project`
|
||||
or :command:`enable_language`. CMake provides the variable as an option to the
|
||||
user automatically when configuring on Windows with GNU tools.
|
||||
|
||||
@ -3,5 +3,5 @@ HAS_CXX
|
||||
|
||||
Link the target using the C++ linker tool (obsolete).
|
||||
|
||||
This is equivalent to setting the LINKER_LANGUAGE property to CXX.
|
||||
See that property's documentation for details.
|
||||
This is equivalent to setting the :prop_tgt:`LINKER_LANGUAGE`
|
||||
property to ``CXX``.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
IMPORTED
|
||||
--------
|
||||
|
||||
Read-only indication of whether a target is IMPORTED.
|
||||
Read-only indication of whether a target is ``IMPORTED``.
|
||||
|
||||
The boolean value of this property is ``True`` for targets created with
|
||||
the IMPORTED option to :command:`add_executable` or :command:`add_library`.
|
||||
the ``IMPORTED`` option to :command:`add_executable` or :command:`add_library`.
|
||||
It is ``False`` for targets built within the project.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_IMPLIB
|
||||
---------------
|
||||
|
||||
Full path to the import library for an IMPORTED target.
|
||||
Full path to the import library for an ``IMPORTED`` target.
|
||||
|
||||
Set this to the location of the ".lib" part of a windows DLL. Ignored
|
||||
Set this to the location of the ``.lib`` part of a Windows DLL. Ignored
|
||||
for non-imported targets.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_IMPLIB_<CONFIG>
|
||||
------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_IMPLIB property.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_IMPLIB` property.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported.
|
||||
|
||||
@ -8,7 +8,7 @@ their implementation. On some platforms the linker searches for the
|
||||
dependent libraries of shared libraries they are including in the
|
||||
link. Set this property to the list of dependent shared libraries of
|
||||
an imported library. The list should be disjoint from the list of
|
||||
interface libraries in the INTERFACE_LINK_LIBRARIES property. On
|
||||
interface libraries in the :prop_tgt:`INTERFACE_LINK_LIBRARIES` property. On
|
||||
platforms requiring dependent shared libraries to be found at link
|
||||
time CMake uses this list to add appropriate files or paths to the
|
||||
link command line. Ignored for non-imported targets.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>
|
||||
------------------------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_LINK_DEPENDENT_LIBRARIES`.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported. If set, this property completely
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
IMPORTED_LINK_INTERFACE_LANGUAGES
|
||||
---------------------------------
|
||||
|
||||
Languages compiled into an IMPORTED static library.
|
||||
Languages compiled into an ``IMPORTED`` static library.
|
||||
|
||||
Set this to the list of languages of source files compiled to produce
|
||||
a STATIC IMPORTED library (such as "C" or "CXX"). CMake accounts for
|
||||
a ``STATIC IMPORTED`` library (such as ``C`` or ``CXX``). CMake accounts for
|
||||
these languages when computing how to link a target to the imported
|
||||
library. For example, when a C executable links to an imported C++
|
||||
static library CMake chooses the C++ linker to satisfy language
|
||||
runtime dependencies of the static library.
|
||||
|
||||
This property is ignored for targets that are not STATIC libraries.
|
||||
This property is ignored for targets that are not ``STATIC`` libraries.
|
||||
This property is ignored for non-imported targets.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>
|
||||
------------------------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_LANGUAGES`.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported. If set, this property completely
|
||||
|
||||
@ -1,16 +1,16 @@
|
||||
IMPORTED_LINK_INTERFACE_LIBRARIES
|
||||
---------------------------------
|
||||
|
||||
Transitive link interface of an IMPORTED target.
|
||||
Transitive link interface of an ``IMPORTED`` target.
|
||||
|
||||
Set this to the list of libraries whose interface is included when an
|
||||
IMPORTED library target is linked to another target. The libraries
|
||||
``IMPORTED`` library target is linked to another target. The libraries
|
||||
will be included on the link line for the target. Unlike the
|
||||
LINK_INTERFACE_LIBRARIES property, this property applies to all
|
||||
imported target types, including STATIC libraries. This property is
|
||||
:prop_tgt:`LINK_INTERFACE_LIBRARIES` property, this property applies to all
|
||||
imported target types, including ``STATIC`` libraries. This property is
|
||||
ignored for non-imported targets.
|
||||
|
||||
This property is ignored if the target also has a non-empty
|
||||
INTERFACE_LINK_LIBRARIES property.
|
||||
:prop_tgt:`INTERFACE_LINK_LIBRARIES` property.
|
||||
|
||||
This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.
|
||||
This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` instead.
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>
|
||||
------------------------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_LIBRARIES`.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported. If set, this property completely
|
||||
overrides the generic property for the named configuration.
|
||||
|
||||
This property is ignored if the target also has a non-empty
|
||||
INTERFACE_LINK_LIBRARIES property.
|
||||
:prop_tgt:`INTERFACE_LINK_LIBRARIES` property.
|
||||
|
||||
This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.
|
||||
This property is deprecated. Use :prop_tgt:`INTERFACE_LINK_LIBRARIES` instead.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
IMPORTED_LINK_INTERFACE_MULTIPLICITY
|
||||
------------------------------------
|
||||
|
||||
Repetition count for cycles of IMPORTED static libraries.
|
||||
Repetition count for cycles of ``IMPORTED`` static libraries.
|
||||
|
||||
This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets.
|
||||
This is :prop_tgt:`LINK_INTERFACE_MULTIPLICITY` for ``IMPORTED`` targets.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>
|
||||
---------------------------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_LINK_INTERFACE_MULTIPLICITY`.
|
||||
|
||||
If set, this property completely overrides the generic property for
|
||||
the named configuration.
|
||||
|
||||
@ -1,21 +1,21 @@
|
||||
IMPORTED_LOCATION
|
||||
-----------------
|
||||
|
||||
Full path to the main file on disk for an IMPORTED target.
|
||||
Full path to the main file on disk for an ``IMPORTED`` target.
|
||||
|
||||
Set this to the location of an IMPORTED target file on disk. For
|
||||
Set this to the location of an ``IMPORTED`` target file on disk. For
|
||||
executables this is the location of the executable file. For bundles
|
||||
on macOS this is the location of the executable file inside
|
||||
Contents/MacOS under the application bundle folder. For static
|
||||
``Contents/MacOS`` under the application bundle folder. For ``STATIC``
|
||||
libraries and modules this is the location of the library or module.
|
||||
For shared libraries on non-DLL platforms this is the location of the
|
||||
For ``SHARED`` libraries on non-DLL platforms this is the location of the
|
||||
shared library. For frameworks on macOS this is the location of the
|
||||
library file symlink just inside the framework folder. For DLLs this
|
||||
is the location of the ".dll" part of the library. For UNKNOWN
|
||||
is the location of the ``.dll`` part of the library. For ``UNKNOWN``
|
||||
libraries this is the location of the file to be linked. Ignored for
|
||||
non-imported targets.
|
||||
|
||||
Projects may skip IMPORTED_LOCATION if the configuration-specific
|
||||
property IMPORTED_LOCATION_<CONFIG> is set. To get the location of an
|
||||
imported target read one of the LOCATION or LOCATION_<CONFIG>
|
||||
properties.
|
||||
Projects may skip ``IMPORTED_LOCATION`` if the configuration-specific
|
||||
property :prop_tgt:`IMPORTED_LOCATION_<CONFIG>` is set. To get the location
|
||||
of an imported target read one of the :prop_tgt:`LOCATION` or
|
||||
``LOCATION_<CONFIG>`` properties.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_LOCATION_<CONFIG>
|
||||
--------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_LOCATION property.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_LOCATION` property.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported.
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
IMPORTED_NO_SONAME
|
||||
------------------
|
||||
|
||||
Specifies that an IMPORTED shared library target has no "soname".
|
||||
Specifies that an ``IMPORTED`` shared library target has no ``soname``.
|
||||
|
||||
Set this property to true for an imported shared library file that has
|
||||
no "soname" field. CMake may adjust generated link commands for some
|
||||
no ``soname`` field. CMake may adjust generated link commands for some
|
||||
platforms to prevent the linker from using the path to the library in
|
||||
place of its missing soname. Ignored for non-imported targets.
|
||||
place of its missing ``soname``. Ignored for non-imported targets.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_NO_SONAME_<CONFIG>
|
||||
---------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_NO_SONAME property.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_NO_SONAME` property.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
IMPORTED_SONAME
|
||||
---------------
|
||||
|
||||
The "soname" of an IMPORTED target of shared library type.
|
||||
The ``soname`` of an ``IMPORTED`` target of shared library type.
|
||||
|
||||
Set this to the "soname" embedded in an imported shared library. This
|
||||
Set this to the ``soname`` embedded in an imported shared library. This
|
||||
is meaningful only on platforms supporting the feature. Ignored for
|
||||
non-imported targets.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
IMPORTED_SONAME_<CONFIG>
|
||||
------------------------
|
||||
|
||||
<CONFIG>-specific version of IMPORTED_SONAME property.
|
||||
<CONFIG>-specific version of :prop_tgt:`IMPORTED_SONAME` property.
|
||||
|
||||
Configuration names correspond to those provided by the project from
|
||||
which the target is imported.
|
||||
|
||||
@ -3,7 +3,7 @@ IMPORT_PREFIX
|
||||
|
||||
What comes before the import library name.
|
||||
|
||||
Similar to the target property PREFIX, but used for import libraries
|
||||
(typically corresponding to a DLL) instead of regular libraries. A
|
||||
target property that can be set to override the prefix (such as "lib")
|
||||
Similar to the target property :prop_tgt:`PREFIX`, but used for import libraries
|
||||
(typically corresponding to a ``DLL``) instead of regular libraries. A
|
||||
target property that can be set to override the prefix (such as ``lib``)
|
||||
on an import library name.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user