diff options
author | FeRD (Frank Dana) <ferdnyc@gmail.com> | 2024-08-01 16:32:05 (GMT) |
---|---|---|
committer | FeRD (Frank Dana) <ferdnyc@gmail.com> | 2024-08-01 16:41:43 (GMT) |
commit | 38aae609df31400eaa03aa4aaecaa566a6c7a6a4 (patch) | |
tree | 1b81105161b0dc98cdd60a2a31c2e99dc518560e /Help | |
parent | 98d86fdc62e84df82536ad73978e4b73a0fafde7 (diff) | |
download | CMake-38aae609df31400eaa03aa4aaecaa566a6c7a6a4.zip CMake-38aae609df31400eaa03aa4aaecaa566a6c7a6a4.tar.gz CMake-38aae609df31400eaa03aa4aaecaa566a6c7a6a4.tar.bz2 |
Help(install): Move RENAME docs to FILES signature
The document's intro claims that the options documented up top are
the ones common to multiple signatures, but `RENAME` is only valid
for `install(FILES ...)`. Move it to that section of the docs.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/install.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst index ffc1926..a2e7491 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -111,11 +111,6 @@ signatures that specify them. The common options are: Specify that the file is excluded from a full installation and only installed as part of a component-specific installation -``RENAME <name>`` - Specify a name for an installed file that may be different from the - original file. Renaming is allowed only when a single file is - installed by the command. - ``OPTIONAL`` Specify that it is not an error if the file to be installed does not exist. @@ -543,6 +538,10 @@ Signatures However, if any item begins in a generator expression it must evaluate to a full path. + The optional ``RENAME <name>`` argument is used to specify a name for the + installed file that is different from the original file name. Renaming + is allowed only when a single file is installed by the command. + Either a ``TYPE`` or a ``DESTINATION`` must be provided, but not both. A ``TYPE`` argument specifies the generic file type of the files being installed. A destination will then be set automatically by taking the |