summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2018-12-02 21:04:22 +0000
committerJavier Jardón <jjardon@gnome.org>2018-12-02 21:04:22 +0000
commitf4e2a04b6d02a1c3a06c8cc1003343bed0e532e6 (patch)
tree33219193ac47ac64d9ede82721e95d40b289400f
parent7cea464a0a1f9286b768c037332e3c8f38920aa8 (diff)
downloadbuildstream-jjardon/doc_git_submodules.tar.gz
buildstream/plugins/sources/git.py: warn about checkout by defaultjjardon/doc_git_submodules
See #783
-rw-r--r--buildstream/plugins/sources/git.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/buildstream/plugins/sources/git.py b/buildstream/plugins/sources/git.py
index 18c8be82a..93088a4cc 100644
--- a/buildstream/plugins/sources/git.py
+++ b/buildstream/plugins/sources/git.py
@@ -25,6 +25,11 @@ git - stage files from a git repository
* git
+.. note::
+
+ Note that this plugin **will checkout git submodules by default**; even if
+ they are not specify in the `.bst` file.
+
**Usage:**
.. code:: yaml