todo: Add note about using blktrace.
[libguestfs.git] / HACKING
1 PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING TO SEE WHETHER IT
2 IS AUTOMATICALLY GENERATED OR NOT.
3
4 Adding a new action
5 ----------------------------------------------------------------------
6
7 All action functions are generated automatically, so there are only
8 two files you need to edit:
9
10 (1) generator/generator_actions.ml: Add your new action, parameters,
11 description, etc. to the big list at the top of this file.
12
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
15 there.
16
17 Formatting
18 ----------------------------------------------------------------------
19
20 Try to use GNU / Emacs default formatting, following the convention
21 used elsewhere in the source.
22
23 Please make sure that the code compiles without warnings.
24
25 Please test any changes.
26
27 Useful targets:
28   make syntax-check    Checks the syntax of the C code.
29   make check           Runs the test suite.
30
31 Enable warnings, and fix any you find:
32   ./configure --enable-gcc-warnings
33
34 Code indentation
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.
41
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:
44
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))))
53
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."
57     (interactive)
58     (c-set-style "K&R")
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))))
64
65 Directories
66 ----------------------------------------------------------------------
67
68 appliance/
69         The qemu appliance, build scripts and so on.
70
71 capitests/
72         Automated tests of the C API.
73
74 contrib/
75         Outside contributions, experimental parts.
76
77 csharp/
78         Experimental C# bindings.
79
80 daemon/
81         The daemon that runs inside the guest and carries out actions.
82
83 examples/
84         The examples.
85
86 fish/
87         Guestfish (the command-line program / shell)
88
89 fuse/
90         FUSE (userspace filesystem) built on top of libguestfs.
91
92 generator/
93         The crucially important generator, used to automatically
94         generate large amounts of boilerplate C code for things like
95         RPC and bindings.
96
97 haskell/
98         Haskell bindings.
99
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.
104
105 images/
106         Some guest images to test against.  These are gzipped to save
107         space.  You have to unzip them before use.
108
109         Also contains some files used by the test suite.
110
111 inspector/
112         Virtual machine image inspector (virt-inspector).
113
114 java/
115         Java bindings.
116
117 m4/
118         M4 macros used by autoconf.
119
120 ocaml/
121         OCaml bindings.
122
123 po/
124         Translations of simple gettext strings.  For translations of
125         longer documents, see po-docs/.
126
127 po-docs/
128         The build infrastructure and PO files for translations of
129         manpages and POD files.  Eventually this will be combined
130         with the po/ directory, but that is rather complicated.
131
132 perl/
133         Perl bindings.
134
135 python/
136         Python bindings.
137
138 regressions/
139         Regression tests.
140
141 ruby/
142         Ruby bindings.
143
144 tools/
145         Command line tools like virt-cat, virt-df, virt-edit and more.
146         In versions <= 1.0.73 these were all in separate directories
147         like cat/, df/, edit/, but since then we moved them all into
148         one directory to simplify builds.
149
150 src/
151         Source code to the C library.
152
153 test-tool/
154         Interactive qemu/kernel test tool.
155
156 Debugging
157 ----------------------------------------------------------------------
158
159 It's a good idea to use guestfish to try out new commands.
160
161 Debugging the daemon is a problem because it runs inside a minimal
162 qemu environment.  However you can print messages from the daemon, and
163 they will show up if you use 'guestfish -v'.
164
165 Patches
166 ----------------------------------------------------------------------
167
168 Submit patches to the mailing list:
169 http://www.redhat.com/mailman/listinfo/libguestfs
170 and CC to rjones@redhat.com
171
172 I18N
173 ----------------------------------------------------------------------
174
175 We support i18n (gettext anyhow) in the library.
176
177 However many messages come from the daemon, and we don't translate
178 those at the moment.  One reason is that the appliance generally has
179 all locale files removed from it, because they take up a lot of space.
180 So we'd have to readd some of those, as well as copying our PO files
181 into the appliance.
182
183 Debugging messages are never translated, since they are intended for
184 the programmers.
185
186 Extended printf
187 ----------------------------------------------------------------------
188
189 In the daemon code we have created custom printf formatters %Q and %R,
190 which are used to do shell quoting.
191
192 %Q => Simple shell quoted string.  Any spaces or other shell characters
193       are escaped for you.
194
195 %R => Same as %Q except the string is treated as a path which is prefixed
196       by the sysroot.
197
198 eg.
199
200 asprintf (&cmd, "cat %R", path);
201 ==> "cat /sysroot/some\ path\ with\ spaces"
202
203 Note: Do NOT use these when you are passing parameters to the
204 command{,r,v,rv}() functions.  These parameters do NOT need to be
205 quoted because they are not passed via the shell (instead, straight to
206 exec).  You probably want to use the sysroot_path() function however.