mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-25 10:18:34 -06:00
Help: Improve description of modules
This commit is contained in:
@@ -20,7 +20,7 @@ preprocessor definitions.
|
||||
* Use :command:`include_directories` to add include directories.
|
||||
* Use :command:`add_compile_options` to add other options.
|
||||
|
||||
Flags beginning in -D or /D that look like preprocessor definitions are
|
||||
Flags beginning in ``-D`` or ``/D`` that look like preprocessor definitions are
|
||||
automatically added to the :prop_dir:`COMPILE_DEFINITIONS` directory
|
||||
property for the current directory. Definitions with non-trivial values
|
||||
may be left in the set of flags instead of being converted for reasons of
|
||||
|
||||
@@ -80,7 +80,7 @@ CMake Policy Stack
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
CMake keeps policy settings on a stack, so changes made by the
|
||||
cmake_policy command affect only the top of the stack. A new entry on
|
||||
``cmake_policy`` command affect only the top of the stack. A new entry on
|
||||
the policy stack is managed automatically for each subdirectory to
|
||||
protect its parents and siblings. CMake also manages a new entry for
|
||||
scripts loaded by :command:`include` and :command:`find_package` commands
|
||||
|
||||
@@ -17,7 +17,7 @@ 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
|
||||
specify the type of project, id (GUID) of the project and the name of
|
||||
specify the type of project, id (``GUID``) of the project and the name of
|
||||
the target platform. This is useful for projects requiring values
|
||||
other than the default (e.g. WIX projects).
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ The optional ``<mode>`` keyword determines the type of message:
|
||||
The CMake command-line tool displays STATUS messages on stdout and all
|
||||
other message types on stderr. The CMake GUI displays all messages in
|
||||
its log area. The interactive dialogs (ccmake and CMakeSetup) show
|
||||
STATUS messages one at a time on a status line and other messages in
|
||||
``STATUS`` messages one at a time on a status line and other messages in
|
||||
interactive pop-up boxes.
|
||||
|
||||
CMake Warning and Error message text displays using a simple markup
|
||||
|
||||
@@ -35,7 +35,7 @@ It must be one of the following:
|
||||
``SOURCE``
|
||||
Scope may name zero or more source files. Note that source
|
||||
file properties are visible only to targets added in the same
|
||||
directory (CMakeLists.txt).
|
||||
directory (``CMakeLists.txt``).
|
||||
See also the :command:`set_source_files_properties` command.
|
||||
|
||||
``INSTALL``
|
||||
@@ -48,7 +48,7 @@ It must be one of the following:
|
||||
Path components have to be separated by forward slashes,
|
||||
must be normalized and are case sensitive.
|
||||
|
||||
To reference the installation prefix itself with a relative path use ".".
|
||||
To reference the installation prefix itself with a relative path use ``.``.
|
||||
|
||||
Currently installed file properties are only defined for
|
||||
the WIX generator where the given paths are relative
|
||||
|
||||
@@ -16,4 +16,4 @@ See also the :command:`set_property(SOURCE)` command.
|
||||
|
||||
See :ref:`Source File Properties` for the list of properties known
|
||||
to CMake. Source file properties are visible only to targets added
|
||||
in the same directory (CMakeLists.txt).
|
||||
in the same directory (``CMakeLists.txt``).
|
||||
|
||||
Reference in New Issue
Block a user