diff options
| author | Brad King <brad.king@kitware.com> | 2014-06-24 16:51:19 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-06-24 16:52:11 (GMT) |
| commit | 67815894cabcba32b6afbf3438dc45a00f1a7406 (patch) | |
| tree | 3fa7c6ed13cafe9a5f1f0566cf13c1958f4071b1 /Help/command/install.rst | |
| parent | 0474aa4a78d74f971f6be5d3c4209c46bd6e02e9 (diff) | |
| download | CMake-67815894cabcba32b6afbf3438dc45a00f1a7406.zip CMake-67815894cabcba32b6afbf3438dc45a00f1a7406.tar.gz CMake-67815894cabcba32b6afbf3438dc45a00f1a7406.tar.bz2 | |
Help: Add install() command document section headers
Use section headers instead of horizontal dividers so that one may link
to the sections.
Diffstat (limited to 'Help/command/install.rst')
| -rw-r--r-- | Help/command/install.rst | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst index 47108f0..462a8a9 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -1,8 +1,15 @@ install ------- +.. only:: html + + .. contents:: + Specify rules to run at install time. +Introduction +^^^^^^^^^^^^ + This command generates installation rules for a project. Rules specified by calls to this command within a source directory are executed in order during installation. The order across directories @@ -52,7 +59,8 @@ signatures that specify them. The common options are: Specify that it is not an error if the file to be installed does not exist. ------------------------------------------------------------------------------- +Installing Targets +^^^^^^^^^^^^^^^^^^ :: @@ -147,7 +155,8 @@ file itself, call ``install(EXPORT)``, documented below. Installing a target with the :prop_tgt:`EXCLUDE_FROM_ALL` target property set to ``TRUE`` has undefined behavior. ------------------------------------------------------------------------------- +Installing Files +^^^^^^^^^^^^^^^^ :: @@ -175,7 +184,8 @@ The list of ``files...`` given to ``FILES`` or ``PROGRAMS`` may use However, if any item begins in a generator expression it must evaluate to a full path. ------------------------------------------------------------------------------- +Installing Directories +^^^^^^^^^^^^^^^^^^^^^^ :: @@ -247,7 +257,8 @@ will install the ``icons`` directory to ``share/myproj/icons`` and the file permissions, the scripts will be given specific permissions, and any ``CVS`` directories will be excluded. ------------------------------------------------------------------------------- +Custom Installation Logic +^^^^^^^^^^^^^^^^^^^^^^^^^ :: @@ -266,7 +277,8 @@ example, the code will print a message during installation. ------------------------------------------------------------------------------- +Installing Exports +^^^^^^^^^^^^^^^^^^ :: |