From: Sage Weil <sage@inktank.com>
Date: Fri, 19 Jul 2013 23:59:15 +0000 (-0700)
Subject: mon/PaxosService: update on_active() docs to clarify calling rules
X-Git-Tag: v0.67-rc1~12^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=0356eebfa51d0f3bb94102c271776250f610d090;p=ceph.git

mon/PaxosService: update on_active() docs to clarify calling rules

Signed-off-by: Sage Weil <sage@inktank.com>
---

diff --git a/src/mon/PaxosService.h b/src/mon/PaxosService.h
index a5761d19ad83..74d5a90494c8 100644
--- a/src/mon/PaxosService.h
+++ b/src/mon/PaxosService.h
@@ -438,8 +438,9 @@ public:
   /**
    * This is called when the Paxos state goes to active.
    *
-   * @remarks It's a courtesy method, in case the class implementing this 
-   *	      service has anything it wants/needs to do at that time.
+   * On the peon, this is after each election.
+   * On the leader, this is after each election, *and* after each completed
+   * proposal.
    *
    * @note This function may get called twice in certain recovery cases.
    */