mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-12-31 10:50:16 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help(install): Move RENAME docs to FILES signature

Browse Source 
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.
This commit is contained in:
FeRD (Frank Dana)
2024-08-01 12:32:05 -04:00
parent 98d86fdc62
commit 38aae609df
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Help/command/install.rst
View File

@@ -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