summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-11-07 15:20:58 (GMT)
committerBrad King <brad.king@kitware.com>2014-11-07 15:20:58 (GMT)
commitb71399a189616b762e975670e477c6d09813803f (patch)
treef26a6965dddf3d02d033ef84c6d88e009d0b91e7 /Help
parent51bb383dbf6de9f46d7784a0d3e0bc845a85a0a3 (diff)
parent79349ed8fc22f70de7f839b2323cf3e93aca9bc9 (diff)
downloadCMake-b71399a189616b762e975670e477c6d09813803f.zip
CMake-b71399a189616b762e975670e477c6d09813803f.tar.gz
CMake-b71399a189616b762e975670e477c6d09813803f.tar.bz2
Merge branch 'release-doc-formatting' into release
Diffstat (limited to 'Help')
-rw-r--r--Help/command/add_library.rst19
-rw-r--r--Help/manual/cmake-buildsystem.7.rst2
-rw-r--r--Help/manual/cmake-commands.7.rst2
-rw-r--r--Help/manual/cmake-compile-features.7.rst2
-rw-r--r--Help/manual/cmake-developer.7.rst2
-rw-r--r--Help/manual/cmake-generator-expressions.7.rst2
-rw-r--r--Help/manual/cmake-generators.7.rst2
-rw-r--r--Help/manual/cmake-language.7.rst74
-rw-r--r--Help/manual/cmake-modules.7.rst2
-rw-r--r--Help/manual/cmake-packages.7.rst4
-rw-r--r--Help/manual/cmake-policies.7.rst2
-rw-r--r--Help/manual/cmake-properties.7.rst2
-rw-r--r--Help/manual/cmake-qt.7.rst2
-rw-r--r--Help/manual/cmake-toolchains.7.rst2
-rw-r--r--Help/manual/cmake-variables.7.rst2
15 files changed, 98 insertions, 23 deletions
diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst
index 203b503..7c06203 100644
--- a/Help/command/add_library.rst
+++ b/Help/command/add_library.rst
@@ -133,14 +133,17 @@ Creates an :ref:`Interface Library <Interface Libraries>`. An ``INTERFACE``
library target does not directly create build output, though it may
have properties set on it and it may be installed, exported and
imported. Typically the ``INTERFACE_*`` properties are populated on
-the interface target using the :command:`set_property`,
-:command:`target_link_libraries(INTERFACE)`,
-:command:`target_include_directories(INTERFACE)`,
-:command:`target_compile_options(INTERFACE)`,
-:command:`target_compile_definitions(INTERFACE)`,
-and :command:`target_sources(INTERFACE)` commands, and then it
-is used as an argument to :command:`target_link_libraries` like any other
-target.
+the interface target using the commands:
+
+* :command:`set_property`,
+* :command:`target_link_libraries(INTERFACE)`,
+* :command:`target_include_directories(INTERFACE)`,
+* :command:`target_compile_options(INTERFACE)`,
+* :command:`target_compile_definitions(INTERFACE)`, and
+* :command:`target_sources(INTERFACE)`,
+
+and then it is used as an argument to :command:`target_link_libraries`
+like any other target.
An ``INTERFACE`` :ref:`Imported Target <Imported Targets>` may also be
created with this signature. An ``IMPORTED`` library target references a
diff --git a/Help/manual/cmake-buildsystem.7.rst b/Help/manual/cmake-buildsystem.7.rst
index 1ce9a7e..43f0e97 100644
--- a/Help/manual/cmake-buildsystem.7.rst
+++ b/Help/manual/cmake-buildsystem.7.rst
@@ -3,7 +3,7 @@
cmake-buildsystem(7)
********************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-commands.7.rst b/Help/manual/cmake-commands.7.rst
index 8ff73a4..9c1d3b9 100644
--- a/Help/manual/cmake-commands.7.rst
+++ b/Help/manual/cmake-commands.7.rst
@@ -3,7 +3,7 @@
cmake-commands(7)
*****************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-compile-features.7.rst b/Help/manual/cmake-compile-features.7.rst
index 8e3dbb8..4259224 100644
--- a/Help/manual/cmake-compile-features.7.rst
+++ b/Help/manual/cmake-compile-features.7.rst
@@ -3,7 +3,7 @@
cmake-compile-features(7)
*************************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst
index eea5fc3..0884a59 100644
--- a/Help/manual/cmake-developer.7.rst
+++ b/Help/manual/cmake-developer.7.rst
@@ -3,7 +3,7 @@
cmake-developer(7)
******************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst
index 981bd84..c47a7c4 100644
--- a/Help/manual/cmake-generator-expressions.7.rst
+++ b/Help/manual/cmake-generator-expressions.7.rst
@@ -3,7 +3,7 @@
cmake-generator-expressions(7)
******************************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-generators.7.rst b/Help/manual/cmake-generators.7.rst
index 7f5093f..4bc8c5f 100644
--- a/Help/manual/cmake-generators.7.rst
+++ b/Help/manual/cmake-generators.7.rst
@@ -3,7 +3,7 @@
cmake-generators(7)
*******************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-language.7.rst b/Help/manual/cmake-language.7.rst
index b83dcad..9c511ca 100644
--- a/Help/manual/cmake-language.7.rst
+++ b/Help/manual/cmake-language.7.rst
@@ -3,7 +3,7 @@
cmake-language(7)
*****************
-.. only:: html or latex
+.. only:: html
.. contents::
@@ -79,6 +79,10 @@ A CMake Language source file consists of zero or more
`Command Invocations`_ separated by newlines and optionally
spaces and `Comments`_:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
file: `file_element`*
file_element: `command_invocation` `line_ending` |
@@ -87,6 +91,10 @@ spaces and `Comments`_:
space: <match '[ \t]+'>
newline: <match '\n'>
+.. raw:: latex
+
+ \end{small}
+
Note that any source file line not inside `Command Arguments`_ or
a `Bracket Comment`_ can end in a `Line Comment`_.
@@ -98,6 +106,10 @@ Command Invocations
A *command invocation* is a name followed by paren-enclosed arguments
separated by whitespace:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
command_invocation: `space`* `identifier` `space`* '(' `arguments` ')'
identifier: <match '[A-Za-z_][A-Za-z0-9_]*'>
@@ -106,6 +118,10 @@ separated by whitespace:
: `separation`* '(' `arguments` ')'
separation: `space` | `line_ending`
+.. raw:: latex
+
+ \end{small}
+
For example:
.. code-block:: cmake
@@ -137,9 +153,17 @@ Command Arguments
There are three types of arguments within `Command Invocations`_:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
argument: `bracket_argument` | `quoted_argument` | `unquoted_argument`
+.. raw:: latex
+
+ \end{small}
+
.. _`Bracket Argument`:
Bracket Argument
@@ -149,6 +173,10 @@ A *bracket argument*, inspired by `Lua`_ long bracket syntax,
encloses content between opening and closing "brackets" of the
same length:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
bracket_argument: `bracket_open` `bracket_content` `bracket_close`
bracket_open: '[' '='{len} '['
@@ -156,6 +184,10 @@ same length:
: of the same {len} as the `bracket_open`>
bracket_close: ']' '='{len} ']'
+.. raw:: latex
+
+ \end{small}
+
An opening bracket of length *len >= 0* is written ``[`` followed
by *len* ``=`` followed by ``[`` and the corresponding closing
bracket is written ``]`` followed by *len* ``=`` followed by ``]``.
@@ -197,6 +229,10 @@ Quoted Argument
A *quoted argument* encloses content between opening and closing
double-quote characters:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
quoted_argument: '"' `quoted_element`* '"'
quoted_element: <any character except '\' or '"'> |
@@ -204,6 +240,10 @@ double-quote characters:
: `quoted_continuation`
quoted_continuation: '\' `newline`
+.. raw:: latex
+
+ \end{small}
+
Quoted argument content consists of all text between opening and
closing quotes. Both `Escape Sequences`_ and `Variable References`_
are evaluated. A quoted argument is always given to the command
@@ -246,12 +286,20 @@ An *unquoted argument* is not enclosed by any quoting syntax.
It may not contain any whitespace, ``(``, ``)``, ``#``, ``"``, or ``\``
except when escaped by a backslash:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
unquoted_argument: `unquoted_element`+ | `unquoted_legacy`
unquoted_element: <any character except whitespace or one of '()#"\'> |
: `escape_sequence`
unquoted_legacy: <see note in text>
+.. raw:: latex
+
+ \end{small}
+
Unquoted argument content consists of all text in a contiguous block
of allowed or escaped characters. Both `Escape Sequences`_ and
`Variable References`_ are evaluated. The resulting value is divided
@@ -294,12 +342,20 @@ Escape Sequences
An *escape sequence* is a ``\`` followed by one character:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
escape_sequence: `escape_identity` | `escape_encoded` | `escape_semicolon`
escape_identity: '\' <match '[^A-Za-z0-9;]'>
escape_encoded: '\t' | '\r' | '\n'
escape_semicolon: '\;'
+.. raw:: latex
+
+ \end{small}
+
A ``\`` followed by a non-alphanumeric character simply encodes the literal
character without interpreting it as syntax. A ``\t``, ``\r``, or ``\n``
encodes a tab, carriage return, or newline character, respectively. A ``\;``
@@ -348,9 +404,17 @@ Bracket Comment
A ``#`` immediately followed by a `Bracket Argument`_ forms a
*bracket comment* consisting of the entire bracket enclosure:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
bracket_comment: '#' `bracket_argument`
+.. raw:: latex
+
+ \end{small}
+
For example:
.. code-block:: cmake
@@ -371,10 +435,18 @@ Line Comment
A ``#`` not immediately followed by a `Bracket Argument`_ forms a
*line comment* that runs until the end of the line:
+.. raw:: latex
+
+ \begin{small}
+
.. productionlist::
line_comment: '#' <any text not starting in a `bracket_argument`
: and not containing a `newline`>
+.. raw:: latex
+
+ \end{small}
+
For example:
.. code-block:: cmake
diff --git a/Help/manual/cmake-modules.7.rst b/Help/manual/cmake-modules.7.rst
index 61e4bb4..f5a35b3 100644
--- a/Help/manual/cmake-modules.7.rst
+++ b/Help/manual/cmake-modules.7.rst
@@ -3,7 +3,7 @@
cmake-modules(7)
****************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-packages.7.rst b/Help/manual/cmake-packages.7.rst
index 5d6201c..5e4f0ea 100644
--- a/Help/manual/cmake-packages.7.rst
+++ b/Help/manual/cmake-packages.7.rst
@@ -3,7 +3,7 @@
cmake-packages(7)
*****************
-.. only:: html or latex
+.. only:: html
.. contents::
@@ -479,7 +479,7 @@ be true. This can be tested with logic in the package configuration file:
foreach(_comp ${ClimbingStats_FIND_COMPONENTS})
if (NOT ";${_supported_components};" MATCHES _comp)
set(ClimbingStats_FOUND False)
- set(ClimbingStats_NOTFOUND_MESSAGE "Specified unsupported component: ${_comp}")
+ set(ClimbingStats_NOTFOUND_MESSAGE "Unsupported component: ${_comp}")
endif()
include("${CMAKE_CURRENT_LIST_DIR}/ClimbingStats${_comp}Targets.cmake")
endforeach()
diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst
index f1717a0..dfa423e 100644
--- a/Help/manual/cmake-policies.7.rst
+++ b/Help/manual/cmake-policies.7.rst
@@ -3,7 +3,7 @@
cmake-policies(7)
*****************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst
index 38bcd04..bf456f5 100644
--- a/Help/manual/cmake-properties.7.rst
+++ b/Help/manual/cmake-properties.7.rst
@@ -3,7 +3,7 @@
cmake-properties(7)
*******************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-qt.7.rst b/Help/manual/cmake-qt.7.rst
index fe8d62d..e8a2c1e 100644
--- a/Help/manual/cmake-qt.7.rst
+++ b/Help/manual/cmake-qt.7.rst
@@ -3,7 +3,7 @@
cmake-qt(7)
***********
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-toolchains.7.rst b/Help/manual/cmake-toolchains.7.rst
index fad5481..afc8ba2 100644
--- a/Help/manual/cmake-toolchains.7.rst
+++ b/Help/manual/cmake-toolchains.7.rst
@@ -3,7 +3,7 @@
cmake-toolchains(7)
*******************
-.. only:: html or latex
+.. only:: html
.. contents::
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index 1deb8bb..99088e0 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -3,7 +3,7 @@
cmake-variables(7)
******************
-.. only:: html or latex
+.. only:: html
.. contents::