add comment
authorScott Graham <scottmg@chromium.org>
Fri, 24 Apr 2015 21:25:17 +0000 (14:25 -0700)
committerScott Graham <scottmg@chromium.org>
Fri, 24 Apr 2015 21:25:22 +0000 (14:25 -0700)
src/state.h

index d7987ba..58fac13 100644 (file)
@@ -71,6 +71,9 @@ struct Pool {
 
   /// |current_use_| is the total of the weights of the edges which are
   /// currently scheduled in the Plan (i.e. the edges in Plan::ready_).
+  /// This is generally <= to depth_. It can exceed it very briefly when the
+  /// pool is notified about an edge that's about to be finished that will
+  /// not actually be started. See Plan::NodeFinished().
   int current_use_;
   int depth_;