Browse Source

Help: Add install() command document section headers

Use section headers instead of horizontal dividers so that one may link
to the sections.
Brad King 11 years ago
parent
commit
67815894ca
1 changed files with 17 additions and 5 deletions
  1. 17 5
      Help/command/install.rst

+ 17 - 5
Help/command/install.rst

@@ -1,8 +1,15 @@
 install
 install
 -------
 -------
 
 
+.. only:: html
+
+   .. contents::
+
 Specify rules to run at install time.
 Specify rules to run at install time.
 
 
+Introduction
+^^^^^^^^^^^^
+
 This command generates installation rules for a project.  Rules
 This command generates installation rules for a project.  Rules
 specified by calls to this command within a source directory are
 specified by calls to this command within a source directory are
 executed in order during installation.  The order across directories
 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
   Specify that it is not an error if the file to be installed does
   not exist.
   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
 Installing a target with the :prop_tgt:`EXCLUDE_FROM_ALL` target property
 set to ``TRUE`` has undefined behavior.
 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
 However, if any item begins in a generator expression it must evaluate
 to a full path.
 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
 file permissions, the scripts will be given specific permissions, and any
 ``CVS`` directories will be excluded.
 ``CVS`` directories will be excluded.
 
 
-------------------------------------------------------------------------------
+Custom Installation Logic
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
 ::
 ::
 
 
@@ -266,7 +277,8 @@ example, the code
 
 
 will print a message during installation.
 will print a message during installation.
 
 
-------------------------------------------------------------------------------
+Installing Exports
+^^^^^^^^^^^^^^^^^^
 
 
 ::
 ::