Re: [patch 08/38] CKRM e18: Documentation

[Pavel Machek <pavel@ucw.cz>]

Hi!

> This patch adds all current documentation on CKRM.
> 
> Signed-Off-By: Hubertus Franke <frankeh@us.ibm.com>
> Signed-Off-By: Chandra Seetharaman <sekharan@us.ibm.com>
> Signed-Off-By: Shailabh Nagar <nagar@us.ibm.com>
> Signed-Off-By: Vivek Kashyap <vivk@us.ibm.com>
> Signed-Off-By: Gerrit Huizenga <gh@us.ibm.com>
> 
>  TODO         |   16 +++++++++
>  ckrm_basics  |   66 +++++++++++++++++++++++++++++++++++++++
>  core_usage   |   72 +++++++++++++++++++++++++++++++++++++++++++
>  crbce        |   33 +++++++++++++++++++
>  installation |   70 ++++++++++++++++++++++++++++++++++++++++++
>  rbce_basics  |   67 ++++++++++++++++++++++++++++++++++++++++
>  rbce_usage   |   98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  7 files changed, 422 insertions(+)
> 
> Index: linux-2.6.12-ckrm1/Documentation/ckrm/ckrm_basics
> ===================================================================
> --- /dev/null	1970-01-01 00:00:00.000000000 +0000
> +++ linux-2.6.12-ckrm1/Documentation/ckrm/ckrm_basics	2005-06-20 13:08:35.000000000 -0700
> @@ -0,0 +1,66 @@
> +CKRM Basics
> +-------------

Perhaps you want to explain what "CKRM" means?

> +RCFS depicts a CKRM class as a directory. Hierarchy of classes can be

Another four letter acronym, unexplained?

> +   # cat /rcfs/taskclass/c1/members
> +   lists pids of tasks belonging to c1
> +
> +   # cat /rcfs/socket_class/s1/members
> +   lists the ipaddress\port of all listening sockets in s1
                         ~
			  did you want to use "/" here?

> Index: linux-2.6.12-ckrm1/Documentation/ckrm/crbce
> ===================================================================
> --- /dev/null	1970-01-01 00:00:00.000000000 +0000
> +++ linux-2.6.12-ckrm1/Documentation/ckrm/crbce	2005-06-20 13:08:35.000000000 -0700
> @@ -0,0 +1,33 @@
> +CRBCE
> +----------
> +
> +crbce is a superset of rbce. In addition to providing automatic
> +classification, the crbce module

Nice, but you should describe what RBCE means... And capitalize your
acronyms consistently...

> Index: linux-2.6.12-ckrm1/Documentation/ckrm/rbce_basics
> ===================================================================
> --- /dev/null	1970-01-01 00:00:00.000000000 +0000
> +++ linux-2.6.12-ckrm1/Documentation/ckrm/rbce_basics	2005-06-20 13:08:35.000000000 -0700
> @@ -0,0 +1,67 @@
> +Rule-based Classification Engine (RBCE)
> +-------------------------------------------
> +
> +The ckrm/rbce directory contains the sources for two classification engines
> +called rbce and crbce. Both are optional, built as kernel modules and share much
> +of their codebase. Only one classification engine (CE) can be loaded at a time
> +in CKRM.

TMFLAs! (*)

Your resource managment may be quite nice system, but the naming is
definitely very ugly. With your design we would not have open() system
call, but ofsoarh() -- open filesystem object and return its
handle. Can you come up with some reasonable naming?

								Pavel
(*) Too many four letter acronyms.
-- 
teflon -- maybe it is a trademark, but it should not be.