mon/PaxosService: update docs a bit

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

diff --git a/src/mon/PaxosService.h b/src/mon/PaxosService.h
index 6e1b136cde0ff63eb571ac85e91b0bbdeb1560d3..25bf8994bc29d650cba643d166f3c917a55998f7 100644 (file)
--- a/src/mon/PaxosService.h
+++ b/src/mon/PaxosService.h
@@ -461,11 +461,6 @@ public:
    */
   virtual void tick() {}
 
-  /**
-   * called at same interval as tick.  consider a trim.
-   */
-  void maybe_trim();
-
   /**
    * Get health information
    *
@@ -649,6 +644,13 @@ public:
    * @defgroup PaxosService_h_Trim
    * @{
    */
+  /**
+   * trim service states if appropriate
+   *
+   * Called at same interval as tick()
+   */
+  void maybe_trim();
+
   /**
    * Auxiliary function to trim our state from version @from to version @to,
    * not including; i.e., the interval [from, to[
@@ -670,12 +672,15 @@ public:
   /**
    * Get the version we should trim to.
    *
+   * Should be overloaded by service if it wants to trim states.
+   *
    * @returns the version we should trim to; if we return zero, it should be
    *         assumed that there's no version to trim to.
    */
   virtual version_t get_trim_to() {
     return 0;
   }
+
   /**
    * @}
    */