diff options
| author | Tushar Maheshwari <tushar27192@gmail.com> | 2018-12-27 15:29:51 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-01-16 15:03:35 (GMT) |
| commit | 8bb7562f1a4e75fa5cd00f4ebd868d1494b63e7a (patch) | |
| tree | 958bd92bbfcf1d7e0a31c299aab9f7afde3e058d /Help/command/file.rst | |
| parent | 81650e488c734702384ef903630838015a3f81b1 (diff) | |
| download | CMake-8bb7562f1a4e75fa5cd00f4ebd868d1494b63e7a.zip CMake-8bb7562f1a4e75fa5cd00f4ebd868d1494b63e7a.tar.gz CMake-8bb7562f1a4e75fa5cd00f4ebd868d1494b63e7a.tar.bz2 | |
Help: Add documentation for file(CREATE_LINK) subcommand
Diffstat (limited to 'Help/command/file.rst')
| -rw-r--r-- | Help/command/file.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst index 6e2a6dd..db4d6fc 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -27,6 +27,7 @@ Synopsis file({`COPY`_ | `INSTALL`_} <file>... DESTINATION <dir> [...]) file(`SIZE`_ <filename> <out-var>) file(`READ_SYMLINK`_ <filename> <out-var>) + file(`CREATE_LINK`_ <file> <new-file> [...]) `Path Conversion`_ file(`RELATIVE_PATH`_ <out-var> <directory> <file>) @@ -368,6 +369,28 @@ could do something like this: set(result "${dir}/${result}") endif() +.. _CREATE_LINK: + +.. code-block:: cmake + + file(CREATE_LINK <file> <new-file> + [RESULT <result>] [COPY_ON_ERROR] [SYMBOLIC]) + +Create a link to ``<file>`` at ``<new-file>``. + +It is a hard link by default. This can be changed to symbolic links by +using ``SYMBOLIC``. The original file needs to exist for hard links. + +The ``<result>`` variable, if specified, gets the status of the operation. +It is set to ``0`` in case of success. Otherwise, it contains the error +generated. In case of failures, if ``RESULT`` is not specified, a fatal error +is emitted. + +Specifying ``COPY_ON_ERROR`` enables copying the file as a fallback if +creating the link fails. + +Overwrites the ``<new-file>`` if it exists. + Path Conversion ^^^^^^^^^^^^^^^ |