diff options
| author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-03-15 13:14:03 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-03-15 15:00:31 (GMT) |
| commit | c58f5e116e0fd4fd883320812bfb052582005e90 (patch) | |
| tree | 880229c06b0a30faeed0b41527d9fd5b1890ac6f /Modules | |
| parent | 8355665f8df5d9e1de5a50cb78d62071f55b7b43 (diff) | |
| download | CMake-c58f5e116e0fd4fd883320812bfb052582005e90.zip CMake-c58f5e116e0fd4fd883320812bfb052582005e90.tar.gz CMake-c58f5e116e0fd4fd883320812bfb052582005e90.tar.bz2 | |
ExternalProject: Extend documentation about GIT_TAG usage
When GIT_SHALLOW is used, the '--depth 1 --no-single-branch'
arguments are add. It means that only branch names and tags
is downloaded to repository. Most Commit Hash is not working.
With this commit the documentation was updated, to describe
the limitation of GIT_SHALLOW.
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/ExternalProject.cmake | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index 96250d3..4344bdb 100644 --- a/Modules/ExternalProject.cmake +++ b/Modules/ExternalProject.cmake @@ -251,6 +251,9 @@ External Project Definition The lack of such deterministic behavior makes the main project lose traceability and repeatability. + If ``GIT_SHALLOW`` is enabled then ``GIT_TAG`` works only with + branch names and tags. A commit hash is not allowed. + ``GIT_REMOTE_NAME <name>`` The optional name of the remote. If this option is not specified, it defaults to ``origin``. |