From d44dcf4e004c680182821dec45faa7d6f70e4591 Mon Sep 17 00:00:00 2001
From: Sage Weil <sage@redhat.com>
Date: Tue, 12 Dec 2017 16:22:16 -0600
Subject: [PATCH] osd: document split tracking structures a bit

Signed-off-by: Sage Weil <sage@redhat.com>
---
 src/osd/OSD.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/osd/OSD.h b/src/osd/OSD.h
index 2d10d6f3b032d..e4517873e89bb 100644
--- a/src/osd/OSD.h
+++ b/src/osd/OSD.h
@@ -913,8 +913,13 @@ public:
 private:
   // split
   Mutex in_progress_split_lock;
+  // splits are "pending" after OSD has consumed the map indicating the PG should
+  // split but the PG has not yet processed the map.
   map<spg_t, spg_t> pending_splits; // child -> parent
   map<spg_t, set<spg_t> > rev_pending_splits; // parent -> [children]
+
+  // splits are "in progress" after the PG has gotten the map, and we hold the
+  // parent lock, but the children have not yet been created.
   set<spg_t> in_progress_splits;       // child
 
 public:
-- 
2.39.5