CHANGELOG v1
* fix jsafranek comments
This patch adds the whitelist configuration file man page
Signed-off-by: Ivana Hutarova Varekova <[email protected]>
---
doc/man/Makefile.am | 3 ++-
doc/man/cgsnapshot.1 | 40 ++++++++++++++++++++++++++++-------
doc/man/cgsnapshot_whitelist.conf.5 | 1 +
3 files changed, 35 insertions(+), 9 deletions(-)
create mode 100644 doc/man/cgsnapshot_whitelist.conf.5
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 26338d8..ec751a4 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,6 +1,7 @@
man_MANS = cgclassify.1 cgconfig.conf.5 cgconfigparser.8 cgexec.1 cgred.conf.5
\
cgrules.conf.5 cgrulesengd.8 cgcreate.1 cgset.1 cgclear.1 cgget.1 \
- cgdelete.1 lssubsys.1 lscgroup.1 cgsnapshot.1
+ cgdelete.1 lssubsys.1 lscgroup.1 cgsnapshot.1 \
+ cgsnapshot_whitelist.conf.5
EXTRA_DIST = $(man_MANS)
diff --git a/doc/man/cgsnapshot.1 b/doc/man/cgsnapshot.1
index 9dbf8b4..f8678f6 100644
--- a/doc/man/cgsnapshot.1
+++ b/doc/man/cgsnapshot.1
@@ -32,6 +32,31 @@ Ignore all warnings
Display only variables from whitelist.
The default location of the whitelist is
.B /etc/cgsnapshot_whitelist.conf.
+.sp 1
+The whitelist contains two type of records:
+.RS
+.PD 0
+.TP
+.B variable=y
+means this variable should be listed in
+.B cgsnapshot
+output.
+.TP
+.B variable=n
+means this variable should not be listed in
+.B cgsnapshot
+output. In non-silent mode,
+.B cgsnapshot
+outputs a warning if it finds a variable which should not be listed.
+.PD
+.PP
+If
+.B cgsnapshot
+finds a variable which is not on the list, then it shows an error message.
+Both warnings and errors can be suppressed using
+.B -s
+option.
+.RE
.TP
.B --whitelist-file file
@@ -48,17 +73,16 @@ defines controller whose hierarchies will be
output
.SH FILES
-.LP
-.PD .1v
-.TP 20
+.TP
.B /etc/cgsnapshot_whitelist.conf
+default location of the whitelist. The structure of this whitelist is
+described in section
+.B DESCRIPTION
+in the part about
+.B -w
+option.
.TP
-default location of the whitelist.
-.LP
-.PD .1v
-.TP 20
.B /etc/cgconfig.conf
-.TP
default libcgroup configuration file.
.SH SEE ALSO
diff --git a/doc/man/cgsnapshot_whitelist.conf.5
b/doc/man/cgsnapshot_whitelist.conf.5
new file mode 100644
index 0000000..7cecfc8
--- /dev/null
+++ b/doc/man/cgsnapshot_whitelist.conf.5
@@ -0,0 +1 @@
+.so man1/cgsnapshot.1
\ No newline at end of file
------------------------------------------------------------------------------
Start uncovering the many advantages of virtual appliances
and start using them to simplify application deployment and
accelerate your shift to cloud computing.
http://p.sf.net/sfu/novell-sfdev2dev
_______________________________________________
Libcg-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/libcg-devel
