diff options
| author | Brad King <brad.king@kitware.com> | 2018-05-04 12:18:32 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-05-07 14:10:37 (GMT) |
| commit | 51c0e1407c1317e8084c72fabebb60fffcaac99d (patch) | |
| tree | ca9ebcaef67f4fa4d89041ab414675e10bdd507f /Help/command/install.rst | |
| parent | 0acd70511946597b30e934369353654cdc18929e (diff) | |
| download | CMake-51c0e1407c1317e8084c72fabebb60fffcaac99d.zip CMake-51c0e1407c1317e8084c72fabebb60fffcaac99d.tar.gz CMake-51c0e1407c1317e8084c72fabebb60fffcaac99d.tar.bz2 | |
Help: Add Synopsis section to install, list, and string docs
Summarize the command signatures in one block at the top of the
documentation as is typical in Unix command-line tool manuals.
Make the mode keywords links to the corresponding full signature
and documentation.
Issue: #17948
Diffstat (limited to 'Help/command/install.rst')
| -rw-r--r-- | Help/command/install.rst | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst index a81714f..6cea996 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -1,19 +1,19 @@ install ------- -.. only:: html - - .. contents:: - Specify rules to run at install time. -This command accepts several signatures: +Synopsis +^^^^^^^^ -* :ref:`install(TARGETS) <install-targets>` -* :ref:`install(FILES|PROGRAMS) <install-files>` -* :ref:`install(DIRECTORY) <install-directory>` -* :ref:`install(SCRIPT|CODE) <install-script>` -* :ref:`install(EXPORT|EXPORT_ANDROID_MK) <install-export>` +.. parsed-literal:: + + install(`TARGETS`_ <target>... [...]) + install({`FILES`_ | `PROGRAMS`_} <file>... DESTINATION <dir> [...]) + install(`DIRECTORY`_ <dir>... DESTINATION <dir> [...]) + install(`SCRIPT`_ <file> [...]) + install(`CODE`_ <code> [...]) + install(`EXPORT`_ <export-name> DESTINATION <dir> [...]) Introduction ^^^^^^^^^^^^ @@ -89,11 +89,11 @@ Command signatures that install files may print messages during installation. Use the :variable:`CMAKE_INSTALL_MESSAGE` variable to control which messages are printed. -.. _install-targets: - Installing Targets ^^^^^^^^^^^^^^^^^^ +.. _TARGETS: + :: install(TARGETS targets... [EXPORT <export-name>] @@ -284,11 +284,12 @@ The install destination given to the target install ``DESTINATION`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. -.. _install-files: - Installing Files ^^^^^^^^^^^^^^^^ +.. _FILES: +.. _PROGRAMS: + :: install(<FILES|PROGRAMS> files... DESTINATION <dir> @@ -319,11 +320,11 @@ The install destination given to the files install ``DESTINATION`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. -.. _install-directory: - Installing Directories ^^^^^^^^^^^^^^^^^^^^^^ +.. _DIRECTORY: + :: install(DIRECTORY dirs... DESTINATION <dir> @@ -402,11 +403,12 @@ given to the directory install ``DESTINATION`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. -.. _install-script: - Custom Installation Logic ^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _CODE: +.. _SCRIPT: + :: install([[SCRIPT <file>] [CODE <code>]] @@ -425,11 +427,11 @@ example, the code will print a message during installation. -.. _install-export: - Installing Exports ^^^^^^^^^^^^^^^^^^ +.. _EXPORT: + :: install(EXPORT <export-name> DESTINATION <dir> |