X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=9ae20a6f055feba0db22f60138ab990347f7aeaa;hp=ca5b9a970cde8ba4ee14746630d1eb66414319dc;hb=c50eb8f1cc33009f1ed29a002066e026fe2923f4;hpb=945b6e0a085611b45b2ab0752a66e6e60b21666c diff --git a/HACKING b/HACKING index ca5b9a9..9ae20a6 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 @@ -74,6 +74,9 @@ capitests/ contrib/ Outside contributions, experimental parts. +csharp/ + Experimental C# bindings. + daemon/ The daemon that runs inside the guest and carries out actions. @@ -83,9 +86,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. @@ -105,7 +121,13 @@ ocaml/ OCaml 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. @@ -120,14 +142,13 @@ 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 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. src/ Source code to the C library. - Also contains the crucial generator program. test-tool/ Interactive qemu/kernel test tool.