From 19e15853e9ace8df5acfd784811479cc14d3a369 Mon Sep 17 00:00:00 2001 From: NeroBurner-tux Date: Wed, 27 Feb 2019 21:37:51 +0100 Subject: Help: add inter link anchors for install() commands --- Help/command/install.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Help/command/install.rst b/Help/command/install.rst index 8c98b65..5580a20 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -99,6 +99,7 @@ Windows platforms are unaffected. Installing Targets ^^^^^^^^^^^^^^^^^^ +.. _`install(TARGETS)`: .. _TARGETS: .. code-block:: cmake @@ -327,6 +328,8 @@ use "generator expressions" with the syntax ``$<...>``. See the Installing Files ^^^^^^^^^^^^^^^^ +.. _`install(FILES)`: +.. _`install(PROGRAMS)`: .. _FILES: .. _PROGRAMS: @@ -404,6 +407,7 @@ use "generator expressions" with the syntax ``$<...>``. See the Installing Directories ^^^^^^^^^^^^^^^^^^^^^^ +.. _`install(DIRECTORY)`: .. _DIRECTORY: .. code-block:: cmake @@ -528,6 +532,8 @@ manual for available expressions. Custom Installation Logic ^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _`install(CODE)`: +.. _`install(SCRIPT)`: .. _CODE: .. _SCRIPT: @@ -557,6 +563,7 @@ name, not the file's contents). See the Installing Exports ^^^^^^^^^^^^^^^^^^ +.. _`install(EXPORT)`: .. _EXPORT: .. code-block:: cmake -- cgit v0.12 From b8307adb9f1cd5c5d8fc5a75fb958356b2f091d7 Mon Sep 17 00:00:00 2001 From: NeroBurner Date: Wed, 27 Feb 2019 11:23:39 -0500 Subject: Help: inter-link install() commands --- Help/command/install.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Help/command/install.rst b/Help/command/install.rst index 5580a20..4cef787 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -266,20 +266,20 @@ the following additional arguments: is not recommended to use ``NAMELINK_SKIP`` in conjunction with ``NAMELINK_COMPONENT``. -The ``install(TARGETS)`` command can also accept the following options at the +The `install(TARGETS)`_ command can also accept the following options at the top level: ``EXPORT`` This option associates the installed target files with an export called ````. It must appear before any target options. To actually - install the export file itself, call ``install(EXPORT)``, documented below. + install the export file itself, call `install(EXPORT)`_, documented below. See documentation of the :prop_tgt:`EXPORT_NAME` target property to change the name of the exported target. ``INCLUDES DESTINATION`` This option specifies a list of directories which will be added to the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` target property of the - ```` when exported by the :command:`install(EXPORT)` command. If a + ```` when exported by the `install(EXPORT)`_ command. If a relative path is specified, it is treated as relative to the ``$``. @@ -313,7 +313,7 @@ targets that link to the object libraries in their implementation. Installing a target with the :prop_tgt:`EXCLUDE_FROM_ALL` target property set to ``TRUE`` has undefined behavior. -:command:`install(TARGETS)` can install targets that were created in +`install(TARGETS)`_ can install targets that were created in other directories. When using such cross-directory install rules, running ``make install`` (or similar) from a subdirectory will not guarantee that targets from other directories are up-to-date. You can use @@ -580,7 +580,7 @@ Installing Exports The ``EXPORT`` form generates and installs a CMake file containing code to import targets from the installation tree into another project. Target installations are associated with the export ```` -using the ``EXPORT`` option of the ``install(TARGETS)`` signature +using the ``EXPORT`` option of the `install(TARGETS)`_ signature documented above. The ``NAMESPACE`` option will prepend ```` to the target names as they are written to the import file. By default the generated file will be called ``.cmake`` but the ``FILE`` -- cgit v0.12