summaryrefslogtreecommitdiffstats
path: root/HACKING
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2010-09-11 09:25:12 +0100
committerRichard Jones <rjones@redhat.com>2010-09-11 12:04:44 +0100
commit04d8209077d2227eb1d42695ba71147f78987050 (patch)
treea2ed4a062f70fe258d0fd9b60020c24f6dc7459c /HACKING
parent264629b9f0ace1062b453b2d0ae55e48385189d3 (diff)
downloadlibguestfs-04d8209077d2227eb1d42695ba71147f78987050.tar.gz
libguestfs-04d8209077d2227eb1d42695ba71147f78987050.tar.xz
libguestfs-04d8209077d2227eb1d42695ba71147f78987050.zip
Split generator into separate source files.
'src/generator.ml' is no more. Instead the generator is logically split up over many different source files. Read generator/README for help and tips. We compile the generator down to bytecode, not native code. This means it will run more slowly, but is done for maximum portability.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING10
1 files changed, 7 insertions, 3 deletions
diff --git a/HACKING b/HACKING
index 3d607373..9ae20a6f 100644
--- a/HACKING
+++ b/HACKING
@@ -7,8 +7,8 @@ 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.
+(1) generator/generator_actions.ml: Add your new action, parameters,
+description, etc. to the big list 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
@@ -89,6 +89,11 @@ fish/
fuse/
FUSE (userspace filesystem) built on top of libguestfs.
+generator/
+ The crucially important generator, used to automatically
+ generate large amounts of boilerplate C code for things like
+ RPC and bindings.
+
haskell/
Haskell bindings.
@@ -144,7 +149,6 @@ tools/
src/
Source code to the C library.
- Also contains the crucial generator program.
test-tool/
Interactive qemu/kernel test tool.