X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=f59dd666ba8bb8e784caf7347eee7a81cededca0;hp=7156bf7072d399efbd0cc0bff193624c3a95d017;hb=a6054bf90f39a84c1a8f8f7d3b9e81e84cb13696;hpb=7faff93c3cd2143ee20127f75625f5c520b9d787 diff --git a/HACKING b/HACKING index 7156bf7..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 @@ -68,20 +68,24 @@ Directories appliance/ The qemu appliance, build scripts and so on. -cat/ - The virt-cat tool. - capitests/ Automated tests of the C API. +cat/ + The 'virt-cat', 'virt-filesystems' and 'virt-ls' commands and + documentation. + contrib/ Outside contributions, experimental parts. +csharp/ + Experimental C# bindings. + daemon/ The daemon that runs inside the guest and carries out actions. df/ - The virt-df tool. + 'virt-df' command and documentation. examples/ The examples. @@ -89,9 +93,22 @@ examples/ fish/ Guestfish (the command-line program / shell) +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. +hivex/ [removed in 1.0.85] + This used to contain the hivex library for reading and + writing Windows Registry binary hive files. This is now + available as a separate upstream project. + images/ Some guest images to test against. These are gzipped to save space. You have to unzip them before use. @@ -110,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. @@ -122,12 +148,17 @@ python/ regressions/ Regression tests. +rescue/ + 'virt-rescue' command and documentation. + ruby/ Ruby bindings. +tools/ + 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.