summaryrefslogtreecommitdiff
path: root/buildstream/plugins/sources/git.py
diff options
context:
space:
mode:
Diffstat (limited to 'buildstream/plugins/sources/git.py')
-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