1 PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING TO SEE WHETHER IT
2 IS AUTOMATICALLY GENERATED OR NOT.
5 ----------------------------------------------------------------------
7 All action functions are generated automatically, so there are only
8 two files you need to edit:
10 (1) src/generator.ml: Add your new action, parameters, description,
11 etc. to the big list called 'functions' at the top of this file.
13 (2) Edit/create a C file in daemon/ subdirectory which implements your
14 'do_action' function. Take a look at one of the numerous examples
17 You will need to run src/generator.ml (from the top directory) which
18 regenerates all the auto-generated files, and then continue with the
19 ordinary build process.
22 ----------------------------------------------------------------------
24 Try to use GNU / Emacs default formatting, following the convention
25 used elsewhere in the source.
27 Please make sure that the code compiles without warnings.
29 Please test any changes.
32 ----------------------------------------------------------------------
35 The qemu appliance, build scripts and so on.
38 Automated tests of the C API.
41 Outside contributions, experimental parts.
44 The daemon that runs inside the guest and carries out actions.
50 Guestfish (the command-line program / shell)
56 Some guest images to test against. These are gzipped to save
57 space. You have to unzip them before use.
59 Also contains some files used by the test suite.
62 Virtual machine image inspector (virt-inspector).
68 M4 macros used by autoconf.
89 Source code to the C library.
90 Also contains the crucial generator program.
93 ----------------------------------------------------------------------
95 It's a good idea to use guestfish to try out new commands.
97 Debugging the daemon is a problem because it runs inside a minimal
98 qemu environment. However you can print messages from the daemon, and
99 they will show up if you use 'guestfish -v'.
102 ----------------------------------------------------------------------
104 Submit patches to the fedora-virt mailing list:
105 http://www.redhat.com/mailman/listinfo/fedora-virt
106 and CC to rjones@redhat.com
109 ----------------------------------------------------------------------
111 We support i18n (gettext anyhow) in the library.
113 However many messages come from the daemon, and we don't translate
114 those at the moment. One reason is that the appliance generally has
115 all locale files removed from it, because they take up a lot of space.
116 So we'd have to readd some of those, as well as copying our PO files
119 Debugging messages are never translated, since they are intended for