summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2022-09-02 12:20:53 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2022-09-02 12:20:53 (GMT)
commit2a21555ea7861f640931b1fd2458f6f7bdb3253e (patch)
treec2265f541fd9a0784d296761f296105b1d5e31a7 /Modules
parent6dd6f911178e7daface0b8c3be4b70f920dd8d40 (diff)
downloadCMake-2a21555ea7861f640931b1fd2458f6f7bdb3253e.zip
CMake-2a21555ea7861f640931b1fd2458f6f7bdb3253e.tar.gz
CMake-2a21555ea7861f640931b1fd2458f6f7bdb3253e.tar.bz2
ExternalProject: note the default of `GIT_TAG` being `master`
Reported on Discourse: https://discourse.cmake.org/t/fetchcontent-makeavailable-invalid-reference-master/6386
Diffstat (limited to 'Modules')
-rw-r--r--Modules/ExternalProject.cmake3
1 files changed, 3 insertions, 0 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake
index c7948cd..9952658 100644
--- a/Modules/ExternalProject.cmake
+++ b/Modules/ExternalProject.cmake
@@ -301,6 +301,9 @@ External Project Definition
If ``GIT_SHALLOW`` is enabled then ``GIT_TAG`` works only with
branch names and tags. A commit hash is not allowed.
+ Note that if not provided, ``GIT_TAG`` defaults to ``master``, not the
+ default Git branch name.
+
``GIT_REMOTE_NAME <name>``
The optional name of the remote. If this option is not specified, it
defaults to ``origin``.