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) generator/generator_actions.ml: Add your new action, parameters,
11 description, etc. to the big list 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 make syntax-check Checks the syntax of the C code.
29 make check Runs the test suite.
31 Enable warnings, and fix any you find:
32 ./configure --enable-gcc-warnings
35 ----------------------------------------------------------------------
36 Our C source code generally adheres to some basic code-formatting
37 conventions. The existing code base is not totally consistent on this
38 front, but we do prefer that contributed code be formatted similarly.
39 In short, use spaces-not-TABs for indentation, use 2 spaces for each
40 indentation level, and other than that, follow the K&R style.
42 If you use Emacs, add the following to one of one of your start-up files
43 (e.g., ~/.emacs), to help ensure that you get indentation right:
45 ;;; In libguestfs, indent with spaces everywhere (not TABs).
46 ;;; Exceptions: Makefile and ChangeLog modes.
47 (add-hook 'find-file-hook
48 '(lambda () (if (and buffer-file-name
49 (string-match "/libguestfs\\>" (buffer-file-name))
50 (not (string-equal mode-name "Change Log"))
51 (not (string-equal mode-name "Makefile")))
52 (setq indent-tabs-mode nil))))
54 ;;; When editing C sources in libguestfs, use this style.
55 (defun libguestfs-c-mode ()
56 "C mode with adjusted defaults for use with libguestfs."
59 (setq c-indent-level 2)
60 (setq c-basic-offset 2))
61 (add-hook 'c-mode-hook
62 '(lambda () (if (string-match "/libguestfs\\>" (buffer-file-name))
63 (libguestfs-c-mode))))
66 ----------------------------------------------------------------------
69 The qemu appliance, build scripts and so on.
72 Automated tests of the C API.
75 The 'virt-cat', 'virt-filesystems' and 'virt-ls' commands and
79 Outside contributions, experimental parts.
82 Experimental C# bindings.
85 The daemon that runs inside the guest and carries out actions.
91 Guestfish (the command-line program / shell)
94 FUSE (userspace filesystem) built on top of libguestfs.
97 The crucially important generator, used to automatically
98 generate large amounts of boilerplate C code for things like
104 hivex/ [removed in 1.0.85]
105 This used to contain the hivex library for reading and
106 writing Windows Registry binary hive files. This is now
107 available as a separate upstream project.
110 Some guest images to test against. These are gzipped to save
111 space. You have to unzip them before use.
113 Also contains some files used by the test suite.
116 Virtual machine image inspector (virt-inspector).
122 M4 macros used by autoconf.
131 Translations of simple gettext strings. For translations of
132 longer documents, see po-docs/.
135 The build infrastructure and PO files for translations of
136 manpages and POD files. Eventually this will be combined
137 with the po/ directory, but that is rather complicated.
152 Command line tools like virt-df, virt-edit and more.
155 Source code to the C library.
158 Interactive qemu/kernel test tool.
161 ----------------------------------------------------------------------
163 It's a good idea to use guestfish to try out new commands.
165 Debugging the daemon is a problem because it runs inside a minimal
166 qemu environment. However you can print messages from the daemon, and
167 they will show up if you use 'guestfish -v'.
170 ----------------------------------------------------------------------
172 Submit patches to the mailing list:
173 http://www.redhat.com/mailman/listinfo/libguestfs
174 and CC to rjones@redhat.com
177 ----------------------------------------------------------------------
179 We support i18n (gettext anyhow) in the library.
181 However many messages come from the daemon, and we don't translate
182 those at the moment. One reason is that the appliance generally has
183 all locale files removed from it, because they take up a lot of space.
184 So we'd have to readd some of those, as well as copying our PO files
187 Debugging messages are never translated, since they are intended for
191 ----------------------------------------------------------------------
193 In the daemon code we have created custom printf formatters %Q and %R,
194 which are used to do shell quoting.
196 %Q => Simple shell quoted string. Any spaces or other shell characters
199 %R => Same as %Q except the string is treated as a path which is prefixed
204 asprintf (&cmd, "cat %R", path);
205 ==> "cat /sysroot/some\ path\ with\ spaces"
207 Note: Do NOT use these when you are passing parameters to the
208 command{,r,v,rv}() functions. These parameters do NOT need to be
209 quoted because they are not passed via the shell (instead, straight to
210 exec). You probably want to use the sysroot_path() function however.