X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=c1888dfe2b311559b006cbda3abf5e8928c6c391;hp=2d3f216f4a404d78d2ecd8affce4b6fc81798fa7;hb=a53833fdd21cd573fe8fd02d7a11a3a5e9764ce0;hpb=a2e1d51acda406fd4193f121ac9f879e60cf4302 diff --git a/HACKING b/HACKING index 2d3f216..c1888df 100644 --- a/HACKING +++ b/HACKING @@ -1,77 +1,2 @@ -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. - -You will need to run src/generator.ml (from the top directory) which -regenerates all the auto-generated files, and then continue with the -ordinary build process. - -PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING to see whether it -is automatically generated or not. - -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 ----------------------------------------------------------------------- - -daemon/ - The daemon that runs inside the guest and carries out actions. - -examples/ - The examples. - -fish/ - Guestfish (the command-line program / shell) - -images/ - Some guest images to test against. These are gzipped to save - space. You have to unzip them before use. - -m4/ - M4 macros used by autoconf. - -ocaml/ - OCaml bindings. - -perl/ - Perl bindings. - -python/ - Python bindings. - -src/ - Source code to the C library. - Also contains the crucial generator program. - -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 fedora-virt mailing list: -http://www.redhat.com/mailman/listinfo/fedora-virt -and CC to rjones@redhat.com +The contents of this page have moved to the section "EXTENDING LIBGUESTFS" +in the guestfs(3) man page.