summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-04-04 15:48:44 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-04-04 15:48:55 (GMT)
commit56abc31270cbe60845021107383f1cede0ed075e (patch)
tree07242ad4c4dae0ea7cf479aa1a219854ad9f4e07 /Help/command
parenta6324490e501154dba620a2495afd6f09eea8167 (diff)
parent456e0fb64f5c70191145c34104d6f25bd24b7b37 (diff)
downloadCMake-56abc31270cbe60845021107383f1cede0ed075e.zip
CMake-56abc31270cbe60845021107383f1cede0ed075e.tar.gz
CMake-56abc31270cbe60845021107383f1cede0ed075e.tar.bz2
Merge topic 'improve-documentation'
456e0fb64f Help: Improve documentation formating Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3174
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/get_cmake_property.rst2
-rw-r--r--Help/command/get_target_property.rst2
-rw-r--r--Help/command/if.rst2
-rw-r--r--Help/command/include_external_msproject.rst2
-rw-r--r--Help/command/install_files.rst2
-rw-r--r--Help/command/math.rst2
-rw-r--r--Help/command/output_required_files.rst6
-rw-r--r--Help/command/target_link_libraries.rst2
8 files changed, 10 insertions, 10 deletions
diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst
index 58bf741..96764a3 100644
--- a/Help/command/get_cmake_property.rst
+++ b/Help/command/get_cmake_property.rst
@@ -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.
diff --git a/Help/command/get_target_property.rst b/Help/command/get_target_property.rst
index 4327681..11e07ea 100644
--- a/Help/command/get_target_property.rst
+++ b/Help/command/get_target_property.rst
@@ -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.
diff --git a/Help/command/if.rst b/Help/command/if.rst
index a48a0fa..f377f2c 100644
--- a/Help/command/if.rst
+++ b/Help/command/if.rst
@@ -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
diff --git a/Help/command/include_external_msproject.rst b/Help/command/include_external_msproject.rst
index 375baf2..88bb2c6 100644
--- a/Help/command/include_external_msproject.rst
+++ b/Help/command/include_external_msproject.rst
@@ -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
diff --git a/Help/command/install_files.rst b/Help/command/install_files.rst
index f5fb46d..ff074a8 100644
--- a/Help/command/install_files.rst
+++ b/Help/command/install_files.rst
@@ -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``.
::
diff --git a/Help/command/math.rst b/Help/command/math.rst
index 4fa55f6..3cbe719 100644
--- a/Help/command/math.rst
+++ b/Help/command/math.rst
@@ -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
diff --git a/Help/command/output_required_files.rst b/Help/command/output_required_files.rst
index 8bc6a73..b3a6e86 100644
--- a/Help/command/output_required_files.rst
+++ b/Help/command/output_required_files.rst
@@ -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.
diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst
index c5e4f9f..c2e7e8a 100644
--- a/Help/command/target_link_libraries.rst
+++ b/Help/command/target_link_libraries.rst
@@ -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.