From 85432b0bd0eb234d3aa513243496d05a9d52e394 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Tue, 21 Oct 2008 14:26:59 +0000 Subject: [PATCH] Document somme commit rules, and add application monitoring links to docs * HACKING: update with some rules for commiters * docs/apps.html docs/apps.html.in: add a section on monitoring support daniel --- ChangeLog | 6 ++++++ HACKING | 36 ++++++++++++++++++++++++++++++++++-- docs/apps.html | 18 ++++++++++++++++++ docs/apps.html.in | 25 +++++++++++++++++++++++++ 4 files changed, 83 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 47a7f8f156..f92090cb3e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Tue Oct 21 16:25:22 CEST 2008 Daniel Veillard + + * HACKING: update with some rules for commiters + * docs/apps.html docs/apps.html.in: add a section on monitoring + support + Tue Oct 21 15:08:02 CEST 2008 Daniel Veillard * src/qemu_driver.c: cleanup patch for usb masstorage hotadd diff --git a/HACKING b/HACKING index 1f9ac7b2e8..3945833f29 100644 --- a/HACKING +++ b/HACKING @@ -1,5 +1,5 @@ -Libvirt contributor guidelines -============================== + Libvirt contributor guidelines + ============================== General tips for contributing patches @@ -245,3 +245,35 @@ Of particular note: *DO NOT* include libvirt/libvirt.h or libvirt/virterror.h. It is included by "internal.h" already and there are some special reasons why you cannot include these files explicitly. + + + + Libvirt commiters guidelines + ============================ + +The AUTHORS files indicates the list of people with commit acces right +who can actually merge the patches. + +The general rule for commiting patches is to make sure it has been reviewed +properly in the mailing-list first, usually if a couple of persons gave an +ACK or +1 to a patch and nobody raised an objection on the list it should +be good to go. If the patch touches a part of the code where you're not the +main maintainer or not have a very clear idea of how things work, it's better +to wait for a more authoritative feedback though. Before commiting please +also rebuild locally and run 'make check syntax-check' and make sure they +don't raise error. Try to look for warnings too for example configure with + --enable-compile-warnings=error +which adds -Werror to compile flags, so no warnings get missed + +Exceptions to that 'review and approval on the list first' is fixing failures +to build: + - if a recently commited patch breaks compilation on a platform + or for a given driver then it's fine to commit a minimal fix + directly without getting the review feedback first + - similary if make check or make syntax-chek breaks, if there is + an obvious fix, it's fine to commit immediately +The patch should still be sent to the list (or tell what the fix was if +trivial) and 'make check syntax-check' should pass too before commiting +anything +Similary fixes for documentation and code comments can be managed +in the same way, but still make sure they get reviewed if non-trivial. diff --git a/docs/apps.html b/docs/apps.html index 2c29f2c282..ade1c10bd2 100644 --- a/docs/apps.html +++ b/docs/apps.html @@ -138,6 +138,24 @@ is a LiveCD which is booted on the machine to be converted. It collects a little information from the user and then copies the disks over to a remote machine and defines the XML for a domain to run the guest. + +

Monitoring plugins

+
for munin
+ The two plugins provided by Guido Günther allows to monitor network and + block I/O with Munin. +
for collectd
+ The libvirt-plugin is part of collectd + and gather statistics about virtualized guests on a system. This + way, you can collect CPU, network interface and block device usage + for each guest without installing collectd on the guest systems. + or a full description of available please refer to the libvirt section + in the collectd.conf(5) manual page. +
nagios-virt
+ Nagios-virt is a configuration tool for adding monitoring of your + virtualised domains to Nagios. + You can use this tool to either set up a new Nagios installation for + your Xen or QEMU/KVM guests, or to integrate with your existing Nagios + installation.
diff --git a/docs/apps.html.in b/docs/apps.html.in index eca52fb426..fca56bdd79 100644 --- a/docs/apps.html.in +++ b/docs/apps.html.in @@ -103,6 +103,31 @@ +

Monitoring plugins

+
+
for munin
+
+ The two plugins provided by Guido Günther allows to monitor network and + block I/O with Munin. +
+
for collectd
+
+ The libvirt-plugin is part of collectd + and gather statistics about virtualized guests on a system. This + way, you can collect CPU, network interface and block device usage + for each guest without installing collectd on the guest systems. + or a full description of available please refer to the libvirt section + in the collectd.conf(5) manual page. +
+
nagios-virt
+
+ Nagios-virt is a configuration tool for adding monitoring of your + virtualised domains to Nagios. + You can use this tool to either set up a new Nagios installation for + your Xen or QEMU/KVM guests, or to integrate with your existing Nagios + installation. +
+