X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=c1888dfe2b311559b006cbda3abf5e8928c6c391;hp=6ca33be31c7d1692baa2e931f62caecfae3abd90;hb=dc8e4b057ecd3984d7c27c8e;hpb=bdf7a27a790ff26664f91d95239ec33c5467bfeb diff --git a/HACKING b/HACKING index 6ca33be..c1888df 100644 --- a/HACKING +++ b/HACKING @@ -1,125 +1,2 @@ -PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING TO SEE WHETHER IT -IS AUTOMATICALLY GENERATED OR NOT. - -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. - -Formatting ----------------------------------------------------------------------- - -Try to use GNU / Emacs default formatting, following the convention -used elsewhere in the source. - -Please make sure that the code compiles without warnings. - -Please test any changes. - -Directories ----------------------------------------------------------------------- - -appliance/ - The qemu appliance, build scripts and so on. - -cat/ - The virt-cat tool. - -capitests/ - Automated tests of the C API. - -contrib/ - Outside contributions, experimental parts. - -daemon/ - The daemon that runs inside the guest and carries out actions. - -df/ - The virt-df tool. - -examples/ - The examples. - -fish/ - Guestfish (the command-line program / shell) - -haskell/ - Haskell bindings. - -images/ - Some guest images to test against. These are gzipped to save - space. You have to unzip them before use. - - Also contains some files used by the test suite. - -inspector/ - Virtual machine image inspector (virt-inspector). - -java/ - Java bindings. - -m4/ - M4 macros used by autoconf. - -ocaml/ - OCaml bindings. - -po/ - Translations. - -perl/ - Perl bindings. - -python/ - Python bindings. - -regressions/ - Regression tests. - -ruby/ - Ruby bindings. - -src/ - Source code to the C library. - Also contains the crucial generator program. - -v2v/ - Xen to KVM (V2V) conversion tool. - -Debugging ----------------------------------------------------------------------- - -It's a good idea to use guestfish to try out new commands. - -Debugging the daemon is a problem because it runs inside a minimal -qemu environment. However you can print messages from the daemon, and -they will show up if you use 'guestfish -v'. - -Patches ----------------------------------------------------------------------- - -Submit patches to the mailing list: -http://www.redhat.com/mailman/listinfo/libguestfs -and CC to rjones@redhat.com - -I18N ----------------------------------------------------------------------- - -We support i18n (gettext anyhow) in the library. - -However many messages come from the daemon, and we don't translate -those at the moment. One reason is that the appliance generally has -all locale files removed from it, because they take up a lot of space. -So we'd have to readd some of those, as well as copying our PO files -into the appliance. - -Debugging messages are never translated, since they are intended for -the programmers. +The contents of this page have moved to the section "EXTENDING LIBGUESTFS" +in the guestfs(3) man page.