git commit: Documented Clock::settle.

[bm...@apache.org]

Repository: mesos
Updated Branches:
  refs/heads/master 964acc551 -> 8ff31a340


Documented Clock::settle.


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/8ff31a34
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/8ff31a34
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/8ff31a34

Branch: refs/heads/master
Commit: 8ff31a340d790065b44e9e2b52d215bd3743ba4c
Parents: 964acc5
Author: Benjamin Mahler <bm...@twitter.com>
Authored: Wed May 7 17:53:29 2014 -0700
Committer: Benjamin Mahler <bm...@twitter.com>
Committed: Wed May 7 17:53:29 2014 -0700

----------------------------------------------------------------------
 3rdparty/libprocess/include/process/clock.hpp | 5 +++++
 1 file changed, 5 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/8ff31a34/3rdparty/libprocess/include/process/clock.hpp
----------------------------------------------------------------------
diff --git a/3rdparty/libprocess/include/process/clock.hpp b/3rdparty/libprocess/include/process/clock.hpp
index 82ae3c6..eb157ca 100644
--- a/3rdparty/libprocess/include/process/clock.hpp
+++ b/3rdparty/libprocess/include/process/clock.hpp
@@ -24,6 +24,11 @@ public:
   static void update(const Time& time);
   static void update(ProcessBase* process, const Time& time);
   static void order(ProcessBase* from, ProcessBase* to);
+
+  // When the clock is paused, settle() synchronously ensures that:
+  //   (1) all expired timers are executed,
+  //   (2) no Processes are running, and
+  //   (3) no Processes are ready to run.
   static void settle();
 };