[PATCH 4/4] blkio-cgroup: Documents for use_hierarchy interface

[Gui Jianfeng]

Documents for use_hierarchy interface.

Signed-off-by: Gui Jianfeng <guijianfeng@xxxxxxxxxxxxxx>
---
 Documentation/cgroups/blkio-controller.txt |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

diff --git a/Documentation/cgroups/blkio-controller.txt b/Documentation/cgroups/blkio-controller.txt
index d6da611..df6c938 100644
--- a/Documentation/cgroups/blkio-controller.txt
+++ b/Documentation/cgroups/blkio-controller.txt
@@ -15,6 +15,21 @@ one is throttling policy which can be used to specify upper IO rate limits
 on devices. This policy is implemented in generic block layer and can be
 used on leaf nodes as well as higher level logical devices like device mapper.
 
+Currently, both hierarchical bandwidth division and flat bandwidth division are
+supported. Consider the follow hierarchy:
+
+                    grp1
+                    /  \
+                  grp2 grp3
+                  /  \
+               grp4 grp5
+
+All groups have a same weight 500, and only grp3 grp4 and grp5 are contending
+for IO bandwidth. If flat bandwidth division is in use, grp3 grp4 and grp5 will
+share the same bandwidth, that is 33.3% for each. If hierarchical bandwidth 
+division is in use, grp4 and grp5 will get 25% of bandwidth for each, gpr3
+will get the reset 50%.
+
 HOWTO
 =====
 Proportional Weight division of bandwidth
@@ -142,6 +157,12 @@ Proportional weight policy files
 	  dev     weight
 	  8:16    300
 
+- blkio.use_hierarchy
+	- If this interface is set, hierarchical bandwidth division is enabled.
+	  Ohterwise, flat bandwidth division is enabled. Currently this
+	  interface only shows up in root cgroup, and works in the case that
+	  there're no child cgroups.
+
 - blkio.time
 	- disk time allocated to cgroup per device in milliseconds. First
 	  two fields specify the major and minor number of the device and
-- 1.6.5.2 
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/