From: Loic Dachary <loic-201408@dachary.org>
Date: Thu, 11 Sep 2014 10:09:57 +0000 (+0200)
Subject: documentation: comment the CompatSet data members
X-Git-Tag: v0.86~36^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=f421d5cc356339b5234f9e2083105c2493559639;p=ceph.git

documentation: comment the CompatSet data members

Signed-off-by: Loic Dachary <loic-201408@dachary.org>
---

diff --git a/src/include/CompatSet.h b/src/include/CompatSet.h
index 0019ebdb0595..03bf54d5ec48 100644
--- a/src/include/CompatSet.h
+++ b/src/include/CompatSet.h
@@ -110,7 +110,13 @@ struct CompatSet {
     }
   };
 
-  FeatureSet compat, ro_compat, incompat;
+  // These features have no impact on the read / write status
+  FeatureSet compat;
+  // If any of these features are missing, read is possible ( as long
+  // as no incompat feature is missing ) but it is not possible to write
+  FeatureSet ro_compat;
+  // If any of these features are missing, read or write is not possible
+  FeatureSet incompat;
 
   CompatSet(FeatureSet& _compat, FeatureSet& _ro_compat, FeatureSet& _incompat) :
     compat(_compat), ro_compat(_ro_compat), incompat(_incompat) {}