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 Outside contributions, experimental parts.
78 Experimental C# bindings.
81 The daemon that runs inside the guest and carries out actions.
87 Guestfish (the command-line program / shell)
90 FUSE (userspace filesystem) built on top of libguestfs.
93 The crucially important generator, used to automatically
94 generate large amounts of boilerplate C code for things like
100 hivex/ [removed in 1.0.85]
101 This used to contain the hivex library for reading and
102 writing Windows Registry binary hive files. This is now
103 available as a separate upstream project.
106 Some guest images to test against. These are gzipped to save
107 space. You have to unzip them before use.
109 Also contains some files used by the test suite.
112 Virtual machine image inspector (virt-inspector).
118 M4 macros used by autoconf.
127 Translations of simple gettext strings. For translations of
128 longer documents, see po-docs/.
131 The build infrastructure and PO files for translations of
132 manpages and POD files. Eventually this will be combined
133 with the po/ directory, but that is rather complicated.
148 Command line tools like virt-cat, virt-df, virt-edit and more.
149 In versions <= 1.0.73 these were all in separate directories
150 like cat/, df/, edit/, but since then we moved them all into
151 one directory to simplify builds.
154 Source code to the C library.
157 Interactive qemu/kernel test tool.
160 ----------------------------------------------------------------------
162 It's a good idea to use guestfish to try out new commands.
164 Debugging the daemon is a problem because it runs inside a minimal
165 qemu environment. However you can print messages from the daemon, and
166 they will show up if you use 'guestfish -v'.
169 ----------------------------------------------------------------------
171 Submit patches to the mailing list:
172 http://www.redhat.com/mailman/listinfo/libguestfs
173 and CC to rjones@redhat.com
176 ----------------------------------------------------------------------
178 We support i18n (gettext anyhow) in the library.
180 However many messages come from the daemon, and we don't translate
181 those at the moment. One reason is that the appliance generally has
182 all locale files removed from it, because they take up a lot of space.
183 So we'd have to readd some of those, as well as copying our PO files
186 Debugging messages are never translated, since they are intended for
190 ----------------------------------------------------------------------
192 In the daemon code we have created custom printf formatters %Q and %R,
193 which are used to do shell quoting.
195 %Q => Simple shell quoted string. Any spaces or other shell characters
198 %R => Same as %Q except the string is treated as a path which is prefixed
203 asprintf (&cmd, "cat %R", path);
204 ==> "cat /sysroot/some\ path\ with\ spaces"
206 Note: Do NOT use these when you are passing parameters to the
207 command{,r,v,rv}() functions. These parameters do NOT need to be
208 quoted because they are not passed via the shell (instead, straight to
209 exec). You probably want to use the sysroot_path() function however.