summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2018-12-02 21:04:22 +0000
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2018-12-03 11:14:55 +0000
commit9022a778827ad5fe6f39daa835aff6002dccf14c (patch)
treeefbaec9575a5b82992503251539f4327a72f6445
parentb1430fb5e7c61d2d53da9be6c4a9e5ce83fbd1dc (diff)
downloadbuildstream-9022a778827ad5fe6f39daa835aff6002dccf14c.tar.gz
buildstream/plugins/sources/git.py: warn about checkout by default
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..8586ebcf8 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
+.. attention::
+
+ Note that this plugin **will checkout git submodules by default**; even if
+ they are not specified in the `.bst` file.
+
**Usage:**
.. code:: yaml