Mercurial > archived > louis > perso > liblxcstats
changeset 11:cff6be97dae1
Add a mainpage for the doxygen documentation
author | Louis Opter <kalessin@kalessin.fr> |
---|---|
date | Fri, 07 Jan 2011 20:53:10 +0100 |
parents | 3a1977ecccc7 |
children | dbf24a82f625 |
files | lxcstats.h |
diffstat | 1 files changed, 24 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/lxcstats.h Thu Jan 06 00:59:06 2011 +0100 +++ b/lxcstats.h Fri Jan 07 20:53:10 2011 +0100 @@ -4,6 +4,30 @@ # include <stdint.h> /** + * @mainpage liblxcstats API Reference + * + * @section sec_about About + * + * The liblxcstats returns resources usage statistics on the LXC Containers + * found on your system in a convenient data structure. LXC, Linux Containers, + * are like chroots on steroids. + * + * LXC uses the cgroup Linux kernel feature. Unlike other software + * virtualization technique (such as OpenVZ), LXC works on a vanilla Linux + * kernel. + * + * The code assumes that the cgroup hierarchy has been created by LXC. In the + * future this library could become a generic cgroup statistics library. + * + * This library is used to implement the LXC plugin for Collectd. + * + * @section see_also See Also + * + * - <a href="http://lxc.sourceforge.net/">LXC Containers</a>; + * - <a href="http://collectd.org/">Collectd</a>. + */ + +/** * Opaque structure used as a context for all liblxcst functions. */ typedef struct _lxcst_controller lxcst_handle;