Răsfoiți Sursa

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.
Bartosz Kosiorek 6 ani în urmă
părinte
comite
c58f5e116e
1 a modificat fișierele cu 3 adăugiri și 0 ștergeri
  1. 3 0
      Modules/ExternalProject.cmake

+ 3 - 0
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``.