X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=f59dd666ba8bb8e784caf7347eee7a81cededca0;hp=900980a8af67c70df151c0e1e3faf0fc13438608;hb=ba7ec6aea325b0a6df5777afc057df087f669a7b;hpb=a8c3723e3818b5a7a31520043c6831115ab9d0e0 diff --git a/HACKING b/HACKING index 900980a..f59dd66 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 @@ -71,6 +71,10 @@ appliance/ capitests/ Automated tests of the C API. +cat/ + The 'virt-cat', 'virt-filesystems' and 'virt-ls' commands and + documentation. + contrib/ Outside contributions, experimental parts. @@ -80,6 +84,9 @@ csharp/ daemon/ The daemon that runs inside the guest and carries out actions. +df/ + 'virt-df' command and documentation. + examples/ The examples. @@ -89,6 +96,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. @@ -115,8 +127,17 @@ m4/ ocaml/ OCaml bindings. +php/ + PHP bindings. + po/ - Translations. + Translations of simple gettext strings. For translations of + longer documents, see po-docs/. + +po-docs/ + The build infrastructure and PO files for translations of + manpages and POD files. Eventually this will be combined + with the po/ directory, but that is rather complicated. perl/ Perl bindings. @@ -127,18 +148,17 @@ python/ regressions/ Regression tests. +rescue/ + 'virt-rescue' command and documentation. + ruby/ Ruby bindings. tools/ - Command line tools like virt-cat, virt-df, virt-edit and more. - In versions <= 1.0.73 these were all in separate directories - like cat/, df/, edit/, but since then we moved them all into - one directory to simplify builds. + Command line tools written in Perl (virt-resize and more). src/ Source code to the C library. - Also contains the crucial generator program. test-tool/ Interactive qemu/kernel test tool.