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
18 ----------------------------------------------------------------------
20 Try to use GNU / Emacs default formatting, following the convention
21 used elsewhere in the source.
23 Please make sure that the code compiles without warnings.
25 Please test any changes.
28 ----------------------------------------------------------------------
29 Our C source code generally adheres to some basic code-formatting
30 conventions. The existing code base is not totally consistent on this
31 front, but we do prefer that contributed code be formatted similarly.
32 In short, use spaces-not-TABs for indentation, use 2 spaces for each
33 indentation level, and other than that, follow the K&R style.
35 If you use Emacs, add the following to one of one of your start-up files
36 (e.g., ~/.emacs), to help ensure that you get indentation right:
38 ;;; When editing C sources in libguestfs, use this style.
39 (defun libguestfs-c-mode ()
40 "C mode with adjusted defaults for use with libguestfs."
43 (setq indent-tabs-mode nil) ; indent using spaces, not TABs
44 (setq c-indent-level 2)
45 (setq c-basic-offset 2))
46 (add-hook 'c-mode-hook
47 '(lambda () (if (string-match "/libguestfs" (buffer-file-name))
48 (libguestfs-c-mode))))
51 ----------------------------------------------------------------------
54 The qemu appliance, build scripts and so on.
60 Automated tests of the C API.
63 Outside contributions, experimental parts.
66 The daemon that runs inside the guest and carries out actions.
75 Guestfish (the command-line program / shell)
81 Some guest images to test against. These are gzipped to save
82 space. You have to unzip them before use.
84 Also contains some files used by the test suite.
87 Virtual machine image inspector (virt-inspector).
93 M4 macros used by autoconf.
114 Source code to the C library.
115 Also contains the crucial generator program.
118 Interactive qemu/kernel test tool.
121 Xen to KVM (V2V) conversion tool.
124 ----------------------------------------------------------------------
126 It's a good idea to use guestfish to try out new commands.
128 Debugging the daemon is a problem because it runs inside a minimal
129 qemu environment. However you can print messages from the daemon, and
130 they will show up if you use 'guestfish -v'.
133 ----------------------------------------------------------------------
135 Submit patches to the mailing list:
136 http://www.redhat.com/mailman/listinfo/libguestfs
137 and CC to rjones@redhat.com
140 ----------------------------------------------------------------------
142 We support i18n (gettext anyhow) in the library.
144 However many messages come from the daemon, and we don't translate
145 those at the moment. One reason is that the appliance generally has
146 all locale files removed from it, because they take up a lot of space.
147 So we'd have to readd some of those, as well as copying our PO files
150 Debugging messages are never translated, since they are intended for
154 ----------------------------------------------------------------------
156 In the daemon code we have created custom printf formatters %Q and %R,
157 which are used to do shell quoting.
159 %Q => Simple shell quoted string. Any spaces or other shell characters
162 %R => Same as %Q except the string is treated as a path which is prefixed
167 asprintf (&cmd, "cat %R", path);
168 ==> "cat /sysroot/some\ path\ with\ spaces"
170 Note: Do NOT use these when you are passing parameters to the
171 command{,r,v,rv}() functions. These parameters do NOT need to be
172 quoted because they are not passed via the shell (instead, straight to
173 exec). You probably want to use the sysroot_path() function however.