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

diff --git a/ChangeLog b/ChangeLog
index 47a7f8f156c9f75c1a8993ceb928b2f3eef988ae..f92090cb3e54d277da1d3f7d754dd60320188d75 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Tue Oct 21 16:25:22 CEST 2008 Daniel Veillard <veillard@redhat.com>
+
+       * 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 <veillard@redhat.com>
 
        * src/qemu_driver.c: cleanup patch for usb masstorage hotadd

diff --git a/HACKING b/HACKING
index 1f9ac7b2e8003e662b2f6a46c0fc81a17806e303..3945833f29a141191d7cfc7511ae2ed73c59020a 100644 (file)
--- 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 2c29f2c282dcb7674e5ea3c50fe333185e2f9523..ade1c10bd2e38f72da6caa726b5a24ae5fb4e8d8 100644 (file)
--- 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.
+      </dd></dl>
+        <h2>Monitoring plugins</h2>
+        <dl><dt><a href="http://honk.sigxcpu.org/projects/libvirt/monitor/">for munin</a></dt><dd>
+       The two plugins provided by Guido Günther allows to monitor network and
+        block I/O with <a href="http://munin.projects.linpro.no/">Munin</a>.
+      </dd><dt><a href="http://collectd.org/plugins/libvirt.shtml">for collectd</a></dt><dd>
+       The libvirt-plugin is part of <a href="http://collectd.org/">collectd</a>
+        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.
+      </dd><dt><a href="http://et.redhat.com/~rjones/nagios-virt/">nagios-virt</a></dt><dd>
+       Nagios-virt is a configuration tool for adding monitoring of your
+       virtualised domains to <a href="http://www.nagios.org/">Nagios</a>.
+        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.
       </dd></dl>
       </div>
     </div>

diff --git a/docs/apps.html.in b/docs/apps.html.in
index eca52fb4267d5aec529dcd1664df81270b210c1c..fca56bdd79179af140e26e8fa5ecac6356974968 100644 (file)
--- a/docs/apps.html.in
+++ b/docs/apps.html.in
@@ -103,6 +103,31 @@
       </dd>
     </dl>
 
+    <h2>Monitoring plugins</h2>
+    <dl>
+      <dt><a href="http://honk.sigxcpu.org/projects/libvirt/monitor/">for munin</a></dt>
+      <dd>
+       The two plugins provided by Guido Günther allows to monitor network and
+        block I/O with <a href="http://munin.projects.linpro.no/">Munin</a>.
+      </dd>
+      <dt><a href="http://collectd.org/plugins/libvirt.shtml">for collectd</a></dt>
+      <dd>
+       The libvirt-plugin is part of <a href="http://collectd.org/">collectd</a>
+        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.
+      </dd>
+      <dt><a href="http://et.redhat.com/~rjones/nagios-virt/">nagios-virt</a></dt>
+      <dd>
+       Nagios-virt is a configuration tool for adding monitoring of your
+       virtualised domains to <a href="http://www.nagios.org/">Nagios</a>.
+        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.
+      </dd>
+    </dl>
 
   </body>
 </html>