From: Zac Medico <zmedico@gentoo.org>
Date: Sun, 10 Apr 2011 20:03:11 +0000 (-0700)
Subject: Scheduler: add more info in docstring comments
X-Git-Tag: v2.1.9.46~8
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e0219e53e37cd1c984d58d0f6ac8925190ffc939;p=portage.git

Scheduler: add more info in docstring comments

This clarifies the purposes of _system_merge_started and _choose_pkg.
---

diff --git a/pym/_emerge/Scheduler.py b/pym/_emerge/Scheduler.py
index 8ee96eb7a..f28d7ef00 100644
--- a/pym/_emerge/Scheduler.py
+++ b/pym/_emerge/Scheduler.py
@@ -1373,6 +1373,10 @@ class Scheduler(PollScheduler):
 	def _system_merge_started(self, merge):
 		"""
 		Add any unsatisfied runtime deps to self._unsatisfied_system_deps.
+		In general, this keeps track of installed system packages with
+		unsatisfied RDEPEND or PDEPEND (circular dependencies). It can be
+		a fragile situation, so we don't execute any unrelated builds until
+		the circular dependencies are built and intstalled.
 		"""
 		graph = self._digraph
 		if graph is None:
@@ -1552,7 +1556,9 @@ class Scheduler(PollScheduler):
 
 	def _choose_pkg(self):
 		"""
-		Choose a task that has all it's dependencies satisfied.
+		Choose a task that has all its dependencies satisfied. This is used
+		for parallel build scheduling, and ensures that we don't build
+		anything with deep dependencies that have yet to be merged.
 		"""
 
 		if self._choose_pkg_return_early: