libcgroup.h 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. /*
  2. * Copyright IBM Corporation. 2007
  3. *
  4. * Author: Balbir Singh <balbir@linux.vnet.ibm.com>
  5. *
  6. * This program is free software; you can redistribute it and/or modify it
  7. * under the terms of version 2.1 of the GNU Lesser General Public License
  8. * as published by the Free Software Foundation.
  9. *
  10. * This program is distributed in the hope that it would be useful, but
  11. * WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13. *
  14. */
  15. #ifndef _LIBCGROUP_H
  16. #define _LIBCGROUP_H
  17. #define _LIBCGROUP_H_INSIDE
  18. #include <libcgroup/error.h>
  19. #include <libcgroup/init.h>
  20. #include <libcgroup/iterators.h>
  21. #include <libcgroup/groups.h>
  22. #include <libcgroup/tasks.h>
  23. #include <libcgroup/config.h>
  24. #include <libcgroup/log.h>
  25. #undef _LIBCGROUP_H_INSIDE
  26. /*! \mainpage libcgroup
  27. *
  28. * \section intro_sec Introduction
  29. *
  30. * @c libcgroup is a library that abstracts the control group file system in Linux.
  31. * It comes with various command-line tools and configuration files, see
  32. * their man pages for details.
  33. *
  34. * This documentation provides description of @c libcgroup API. Read following
  35. * sections, preferably in this order:
  36. * -# @ref group_init "Initialization"
  37. * -# @ref group_groups "Control Groups"
  38. * -# @ref group_iterators "Iterators"
  39. * -# @ref group_tasks "Manipulation with tasks"
  40. * -# @ref group_config "Configuration"
  41. * -# @ref group_errors "Error Handling"
  42. */
  43. #endif /* _LIBCGROUP_H */