[buildstream] 09/13: sources/git.py: Document tracking multiple branches

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

root pushed a commit to branch tmewett/merge-git-tag
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit 31a0ff61f13d20ce6f683801160959e1f5e539f7
Author: Tom Mewett <to...@codethink.co.uk>
AuthorDate: Mon Jan 13 15:33:29 2020 +0000

    sources/git.py: Document tracking multiple branches
---
 src/buildstream/plugins/sources/git.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/buildstream/plugins/sources/git.py b/src/buildstream/plugins/sources/git.py
index d04ccfe..ce69895 100644
--- a/src/buildstream/plugins/sources/git.py
+++ b/src/buildstream/plugins/sources/git.py
@@ -41,8 +41,13 @@ git - stage files from a git repository
    # in your project configuration is recommended.
    url: upstream:foo.git
 
-   # Optionally specify a symbolic tracking branch or tag, this
-   # will be used to update the 'ref' when refreshing the pipeline.
+   # Optionally specify a symbolic tracking branch, tag, or other Git
+   # revision. When tracking, the rev is checked and the 'ref' config option
+   # is updated to the commit it points to.
+   #
+   # 'track' can also be a list, in which case all the revs are checked and
+   # the overall latest commit is used.
+   #
    track: master
 
    # Optionally specify the ref format used for tracking.