From: Richard Jones <rjones@redhat.com>
Date: Fri, 3 Apr 2009 21:24:32 +0000 (+0100)
Subject: Added a HACKING file.
X-Git-Tag: 0.4~27
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=f5d2602bf6d40ecc71a5a17e0be9f480e9a4453a;p=libguestfs.git

Added a HACKING file.
---

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..b2fab3e
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,28 @@
+Adding a new action
+----------------------------------------------------------------------
+
+All action functions are generated automatically, so there are only
+two files you need to edit:
+
+(1) src/generator.ml: Add your new action, parameters, description,
+etc. to the big list called 'functions' at the top of this file.
+
+(2) Edit/create a C file in daemon/ subdirectory which implements your
+'do_action' function.  Take a look at one of the numerous examples
+there.
+
+You will need to run src/generator.ml (from the top directory) which
+regenerates all the auto-generated files, and then continue with the
+ordinary build process.
+
+Formatting
+----------------------------------------------------------------------
+
+Try to use GNU / Emacs default formatting, following the convention
+used elsewhere in the source.
+
+Patches
+----------------------------------------------------------------------
+
+Submit patches to the fedora-virt mailing list:
+http://www.redhat.com/mailman/listinfo/fedora-virt