From: Sage Weil <sage@inktank.com>
Date: Fri, 12 Jul 2013 00:40:13 +0000 (-0700)
Subject: mon: fix sync_start doc
X-Git-Tag: v0.67-rc1~59^2~20^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=a04525bebf032a520d32c6f1e3349c7f4720e263;p=ceph.git

mon: fix sync_start doc

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

diff --git a/src/mon/Monitor.cc b/src/mon/Monitor.cc
index 211b1a5d0ceb..fb22f8d0dcef 100644
--- a/src/mon/Monitor.cc
+++ b/src/mon/Monitor.cc
@@ -820,14 +820,6 @@ void Monitor::sync_reset()
   sync_start_version = 0;
 }
 
-/**
- * Start sync process
- *
- * Start pulling committed state from another monitor.
- *
- * @param other Synchronization provider to-be.
- * @param whether to do a full sync or just catch up on recent paxos
- */
 void Monitor::sync_start(entity_inst_t &other, bool full)
 {
   dout(10) << __func__ << " " << other << (full ? " full" : " recent") << dendl;
diff --git a/src/mon/Monitor.h b/src/mon/Monitor.h
index 4c27024dd203..310a75ecf39e 100644
--- a/src/mon/Monitor.h
+++ b/src/mon/Monitor.h
@@ -317,14 +317,12 @@ private:
   void sync_obtain_latest_monmap(bufferlist &bl);
 
   /**
-   * Start the synchronization efforts.
+   * Start sync process
    *
-   * This function should be called whenever we find the need to synchronize
-   * our store state with the remaining cluster.
+   * Start pulling committed state from another monitor.
    *
-   *
-   * @param entity An entity instance referring to the sync provider we picked.
-   * @param whether to sycn the full store, or just pull recent paxos commits
+   * @param entity where to pull committed state from
+   * @param full whether to do a full sync or just catch up on recent paxos
    */
   void sync_start(entity_inst_t &entity, bool full);