diff options
| author | Brad King <brad.king@kitware.com> | 2019-01-21 12:48:19 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2019-01-21 12:48:26 (GMT) |
| commit | d704cc34071f0c6f95099670c94c7f1940ab7fa2 (patch) | |
| tree | 1a815a2dcb0446d290d6b80b8828ed7bbef2594b /Help | |
| parent | d1aa2e11092acdcc22b333e219187026d38549a5 (diff) | |
| parent | 0f08ed89362d207e18b06e806f127cd683b79141 (diff) | |
| download | CMake-d704cc34071f0c6f95099670c94c7f1940ab7fa2.zip CMake-d704cc34071f0c6f95099670c94c7f1940ab7fa2.tar.gz CMake-d704cc34071f0c6f95099670c94c7f1940ab7fa2.tar.bz2 | |
Merge topic 'command_file_link'
0f08ed8936 cmSystemTools: Silence CreateLink and CreateSymlink errors
593d986470 Tests: Avoid cross-device links in CREATE_LINK test
9a3d85cfc5 Tests: Skip symlink tests on Windows
e68ea269d7 Tests: CREATE_LINK subcommand negative test case
45aa9c65a1 Tests: file CREATE_LINK subcommand test cases
8bb7562f1a Help: Add documentation for file(CREATE_LINK) subcommand
81650e488c cmFileCommand: Add CREATE_LINK subcommand
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2759
Diffstat (limited to 'Help')
| -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 ^^^^^^^^^^^^^^^ |