diff options
| author | Craig Scott <craig.scott@crascit.com> | 2022-02-21 07:28:07 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2022-02-21 07:28:16 (GMT) |
| commit | 704e87ee8cf8f903aaaeaf12080ecc69703a7512 (patch) | |
| tree | 544d79dbdf2c163d89f19bd8809ac1e4d41a1e7f /Modules/ExternalProject.cmake | |
| parent | 7847a449302756c8faff4ba7df0e1e7baef95c67 (diff) | |
| download | CMake-704e87ee8cf8f903aaaeaf12080ecc69703a7512.zip CMake-704e87ee8cf8f903aaaeaf12080ecc69703a7512.tar.gz CMake-704e87ee8cf8f903aaaeaf12080ecc69703a7512.tar.bz2 | |
Help: Clarify behavior of REBASE_CHECKOUT when switching branches
Issue: #23216
Diffstat (limited to 'Modules/ExternalProject.cmake')
| -rw-r--r-- | Modules/ExternalProject.cmake | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index 14864d5..292333d 100644 --- a/Modules/ExternalProject.cmake +++ b/Modules/ExternalProject.cmake @@ -353,6 +353,10 @@ External Project Definition When ``GIT_REMOTE_UPDATE_STRATEGY`` is not present, this is the default strategy unless the default has been overridden with ``CMAKE_EP_GIT_REMOTE_UPDATE_STRATEGY`` (see below). + Note that if the branch specified in ``GIT_TAG`` is different to + the upstream branch currently being tracked, it is not safe to + perform a rebase. In that situation, ``REBASE`` will silently be + treated as ``CHECKOUT`` instead. ``REBASE_CHECKOUT`` Same as ``REBASE`` except if the rebase fails, an annotated tag will |