Browse Source

Help: Clarify behavior of REBASE_CHECKOUT when switching branches

Issue: #23216
Craig Scott 3 years ago
parent
commit
704e87ee8c
1 changed files with 4 additions and 0 deletions
  1. 4 0
      Modules/ExternalProject.cmake

+ 4 - 0
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