Add Documentation for FAIR_USER_SCHED sysfs files
authorDhaval Giani <[email protected]>
Wed, 12 Dec 2007 05:48:59 +0000 (11:18 +0530)
committerGreg Kroah-Hartman <[email protected]>
Mon, 17 Dec 2007 18:33:19 +0000 (10:33 -0800)
This patch adds documentation about /sys/kernel/uids/<uid>/cpu_share
to Documentation/ABI.

Signed-off-by: Dhaval Giani <[email protected]>
Cc: Ingo Molnar <[email protected]>
Signed-off-by: Greg Kroah-Hartman <[email protected]>
Documentation/ABI/testing/sysfs-kernel-uids [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-kernel-uids b/Documentation/ABI/testing/sysfs-kernel-uids
new file mode 100644 (file)
index 0000000..648d65d
--- /dev/null
@@ -0,0 +1,14 @@
+What:          /sys/kernel/uids/<uid>/cpu_shares
+Date:          December 2007
+Contact:       Dhaval Giani <[email protected]>
+               Srivatsa Vaddagiri <[email protected]>
+Description:
+               The /sys/kernel/uids/<uid>/cpu_shares tunable is used
+               to set the cpu bandwidth a user is allowed. This is a
+               propotional value. What that means is that if there
+               are two users logged in, each with an equal number of
+               shares, then they will get equal CPU bandwidth. Another
+               example would be, if User A has shares = 1024 and user
+               B has shares = 2048, User B will get twice the CPU
+               bandwidth user A will. For more details refer
+               Documentation/sched-design-CFS.txt