summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTom Mewett <tom.mewett@codethink.co.uk>2019-12-10 11:17:45 +0000
committerTom Mewett <tom.mewett@codethink.co.uk>2019-12-13 16:40:28 +0000
commita87ff4f7a5d734bbb54d34fe496ce2c9cccd1627 (patch)
treebe55b72fe4be6f733574b5f19d59c40ef8cb1d92 /src
parent2fc5a5cfbcf5c16407914849ea1a99bfdb71cb0e (diff)
downloadbuildstream-a87ff4f7a5d734bbb54d34fe496ce2c9cccd1627.tar.gz
_gitsourcebase.py: Add and update some comments on _GitMirror
Diffstat (limited to 'src')
-rw-r--r--src/buildstream/_gitsourcebase.py17
1 files changed, 14 insertions, 3 deletions
diff --git a/src/buildstream/_gitsourcebase.py b/src/buildstream/_gitsourcebase.py
index 4e9e59161..9365137e1 100644
--- a/src/buildstream/_gitsourcebase.py
+++ b/src/buildstream/_gitsourcebase.py
@@ -48,9 +48,20 @@ class _RefFormat(FastEnum):
GIT_DESCRIBE = "git-describe"
-# Because of handling of submodules, we maintain a _GitMirror
-# for the primary git source and also for each submodule it
-# might have at a given time
+# This class represents a single Git repository. The Git source needs to account for
+# submodules, but we don't want to cache them all under the umbrella of the
+# superproject - so we use this class which caches them independently, according
+# to their URL. Instances keep reference to their "parent" GitSourceBase,
+# and if applicable, where in the superproject they are found.
+#
+# Args:
+# source (_GitSourceBase or subclass): The parent source
+# path (str): The relative location of the submodule in the superproject;
+# the empty string for the superproject itself
+# url (str): Where to clone the repo from
+# ref (str): Specified 'ref' from the source configuration
+# primary (bool): Whether this is the primary URL for the source
+# tags (list): Tag configuration; see _GitSourceBase._load_tags
#
class _GitMirror(SourceFetcher):
def __init__(self, source, path, url, ref, *, primary=False, tags=[]):