commit 26b9f6fae96c1a5cf1abee43a5bf79c3591319b0
author Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> Wed Jul 18 20:50:33 2018 +0900
committer Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> Wed Jul 18 20:52:43 2018 +0900
tree 6938ca57ae0de86fe2f6cb367acbf4caed0bc7e8
parent d835c37f2514767b64f6fa5eee0821ec1943a7fd

_stream.py: Clarifying ambiguous FIXME comment about required artifacts

buildstream/_stream.py

diff --git a/buildstream/_stream.py b/buildstream/_stream.py
index 34baa0b..646b7a2 100644
--- a/buildstream/_stream.py
+++ b/buildstream/_stream.py
@@ -879,9 +879,12 @@
         # Set the "required" artifacts that should not be removed
         # while this pipeline is active
         #
-        # FIXME: The set of required artifacts should probably be
-        #        what's in `selected`, but this does not seem to work
-        #        for some reason
+        # FIXME: The set of required artifacts is only really needed
+        #        for build and pull tasks.
+        #
+        #        It must include all the artifacts which are required by the
+        #        final product. Note that this is a superset of the build plan.
+        #
         self._artifacts.append_required_artifacts((e for e in self._pipeline.dependencies(elements, Scope.ALL)))
 
         if selection == PipelineSelection.PLAN and dynamic_plan: