From: Kefu Chai <kchai@redhat.com>
Date: Thu, 28 Jan 2021 05:08:51 +0000 (+0800)
Subject: osd/PeeringState: document prepare_stats_for_publish()
X-Git-Tag: v17.1.0~3115^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=e24ff7b2639ca1ba48d052f22941b64f1eff6d11;p=ceph.git

osd/PeeringState: document prepare_stats_for_publish()

document its parameters

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/src/osd/PeeringState.h b/src/osd/PeeringState.h
index a74b65eafa6a..2cae797d62d1 100644
--- a/src/osd/PeeringState.h
+++ b/src/osd/PeeringState.h
@@ -1825,6 +1825,12 @@ public:
    *
    * Returns updated pg_stat_t if stats have changed since
    * pg_stats_publish adding in unstable_stats.
+   *
+   * @param pg_stats_publish the latest pg_stat possessed by caller
+   * @param unstable_stats additional stats which should be included in the
+   *        returned stats
+   * @return the up to date stats if it is different from the specfied
+   *         @c pg_stats_publish
    */
   std::optional<pg_stat_t> prepare_stats_for_publish(
     const std::optional<pg_stat_t> &pg_stats_publish,