diff options
| author | Brad King <brad.king@kitware.com> | 2024-08-02 13:45:03 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2024-08-02 13:45:17 (GMT) |
| commit | 9c4dbd97713ee96d7e3c4c1ef91d5a22fb5c5308 (patch) | |
| tree | a303420f5a32b08f7f8757d6c36c4d7a11dcc5e6 /Help | |
| parent | a274ba2b971a1dde6d7757d00bf1fd50f71ca2cd (diff) | |
| parent | 38aae609df31400eaa03aa4aaecaa566a6c7a6a4 (diff) | |
| download | CMake-9c4dbd97713ee96d7e3c4c1ef91d5a22fb5c5308.zip CMake-9c4dbd97713ee96d7e3c4c1ef91d5a22fb5c5308.tar.gz CMake-9c4dbd97713ee96d7e3c4c1ef91d5a22fb5c5308.tar.bz2 | |
Merge topic 'install-rename-doc'
38aae609df Help(install): Move RENAME docs to FILES signature
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !9698
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 |