HACKING 23.6 KB
Newer Older
1
-*- buffer-read-only: t -*- vi: set ro:
2 3
DO NOT EDIT THIS FILE!  IT IS GENERATED AUTOMATICALLY
from docs/hacking.html.in!
4

5 6 7 8 9


                         Contributor guidelines
                         ======================

10 11


12 13
General tips for contributing patches
=====================================
14 15
(1) Discuss any large changes on the mailing list first. Post patches early and
listen to feedback.
16

17
(2) Post patches in unified diff format. A command similar to this should work:
18 19 20 21 22

  diff -urp libvirt.orig/ libvirt.modified/ > libvirt-myfeature.patch

or:

23
  git diff > libvirt-myfeature.patch
24

25 26 27 28 29 30 31 32 33 34 35
However, the usual workflow of libvirt developer is:

  git checkout master
  git pull
  git checkout -t origin -b workbranch
  Hack, committing any changes along the way

Then, when you want to post your patches:

  git pull --rebase
  (fix any conflicts)
36 37
  git send-email --cover-letter --no-chain-reply-to --annotate \
                 --to=libvir-list@redhat.com master
38

39 40 41 42 43 44
(Note that the "git send-email" subcommand may not be in the main git package
and using it may require installion of a separate package, for example the
"git-email" package in Fedora.) For a single patch you can omit
"--cover-letter", but a series of two or more patches needs a cover letter. If
you get tired of typing "--to=libvir-list@redhat.com" designation you can set
it in git config:
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

  git config sendemail.to libvir-list@redhat.com

Please follow this as close as you can, especially the rebase and git
send-email part, as it makes life easier for other developers to review your
patch set. One should avoid sending patches as attachments, but rather send
them in email body along with commit message. If a developer is sending
another version of the patch (e.g. to address review comments), he is advised
to note differences to previous versions after the "---" line in the patch so
that it helps reviewers but doesn't become part of git history. Moreover, such
patch needs to be prefixed correctly with "--subject-prefix=PATCHv2" appended
to "git send-email" (substitute "v2" with the correct version if needed
though).



61 62
(3) Split large changes into a series of smaller patches, self-contained if
possible, with an explanation of each patch and an explanation of how the
63
sequence of patches fits together. Moreover, please keep in mind that it's
64 65 66 67 68
required to be able to compile cleanly (*including* "make check" and "make
syntax-check") after each patch. A feature does not have to work until the end
of a series, but intermediate patches must compile and not cause test-suite
failures (this is to preserve the usefulness of "git bisect", among other
things).
69 70


71

72 73
(4) Make sure your patches apply against libvirt GIT. Developers only follow GIT
and don't care much about released versions.
74

75
(5) Run the automated tests on your code before submitting any changes. In
76 77
particular, configure with compile warnings set to -Werror. This is done
automatically for a git checkout; from a tarball, use:
78

79
  ./configure --enable-werror
80 81 82 83 84 85 86 87 88

and run the tests:

  make check
  make syntax-check
  make -C tests valgrind

The latter test checks for memory leaks.

89 90 91 92 93 94 95
If you encounter any failing tests, the VIR_TEST_DEBUG environment variable
may provide extra information to debug the failures. Larger values of
VIR_TEST_DEBUG may provide larger amounts of information:

  VIR_TEST_DEBUG=1 make check    (or)
  VIR_TEST_DEBUG=2 make check

96
Also, individual tests can be run from inside the "tests/" directory, like:
97 98 99

  ./qemuxml2xmltest

100 101
(6) Update tests and/or documentation, particularly if you are adding a new
feature or changing the output of a program.
102 103


104

105 106
There is more on this subject, including lots of links to background reading
on the subject, on
107

108 109
  Richard Jones' guide to working with open source projects
  http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/
110

111

112 113 114
Code indentation
================
Libvirt's C source code generally adheres to some basic code-formatting
115 116 117 118
conventions. The existing code base is not totally consistent on this front,
but we do prefer that contributed code be formatted similarly. In short, use
spaces-not-TABs for indentation, use 4 spaces for each indentation level, and
other than that, follow the K&R style.
119 120 121 122 123 124 125 126 127 128 129 130 131

If you use Emacs, add the following to one of one of your start-up files
(e.g., ~/.emacs), to help ensure that you get indentation right:

  ;;; When editing C sources in libvirt, use this style.
  (defun libvirt-c-mode ()
    "C mode with adjusted defaults for use with libvirt."
    (interactive)
    (c-set-style "K&R")
    (setq indent-tabs-mode nil) ; indent using spaces, not TABs
    (setq c-indent-level 4)
    (setq c-basic-offset 4))
  (add-hook 'c-mode-hook
132 133 134
            '(lambda () (if (string-match "/libvirt" (buffer-file-name))
                            (libvirt-c-mode))))

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
If you use vim, append the following to your ~/.vimrc file:

  set nocompatible
  filetype on
  set autoindent
  set smartindent
  set cindent
  set tabstop=8
  set shiftwidth=4
  set expandtab
  set cinoptions=(0,:0,l1,t0
  filetype plugin indent on
  au FileType make setlocal noexpandtab
  au BufRead,BufNewFile *.am setlocal noexpandtab
  match ErrorMsg /\s\+$\| \+\ze\t/

Or if you don't want to mess your ~/.vimrc up, you can save the above into a
file called .lvimrc (not .vimrc) located at the root of libvirt source, then
install a vim script from
http://www.vim.org/scripts/script.php?script_id=1408, which will load the
.lvimrc only when you edit libvirt code.

157 158 159

Code formatting (especially for new code)
=========================================
160 161 162
With new code, we can be even more strict. Please apply the following function
(using GNU indent) to any new code. Note that this also gives you an idea of
the type of spacing we prefer around operators and keywords:
163 164 165 166 167 168 169 170

  indent-libvirt()
  {
    indent -bad -bap -bbb -bli4 -br -ce -brs -cs -i4 -l75 -lc75 \
      -sbi4 -psl -saf -sai -saw -sbi4 -ss -sc -cdw -cli4 -npcs -nbc \
      --no-tabs "$@"
  }

171 172 173
Note that sometimes you'll have to post-process that output further, by piping
it through "expand -i", since some leading TABs can get through. Usually
they're in macro definitions or strings, and should be converted anyhow.
174

175 176 177 178 179 180
Libvirt requires a C99 compiler for various reasons. However, most of the code
base prefers to stick to C89 syntax unless there is a compelling reason
otherwise. For example, it is preferable to use "/* */" comments rather than
"//". Also, when declaring local variables, the prevailing style has been to
declare them at the beginning of a scope, rather than immediately before use.

181

182 183 184 185
Curly braces
============
Omit the curly braces around an "if", "while", "for" etc. body only when that
body occupies a single line. In every other case we require the braces. This
186 187
ensures that it is trivially easy to identify a single-'statement' loop: each
has only one 'line' in its body.
188 189 190

Omitting braces with a single-line body is fine:

191 192
  while (expr) // one-line body -> omitting curly braces is ok
      single_line_stmt();
193 194 195 196

However, the moment your loop/if/else body extends onto a second line, for
whatever reason (even if it's just an added comment), then you should add
braces. Otherwise, it would be too easy to insert a statement just before that
197
comment (without adding braces), thinking it is already a multi-statement loop:
198

199 200 201
  while (true) // BAD! multi-line body with no braces
      /* comment... */
      single_line_stmt();
202 203 204

Do this instead:

205 206 207 208
  while (true) { // Always put braces around a multi-line body.
      /* comment... */
      single_line_stmt();
  }
209 210 211 212

There is one exception: when the second body line is not at the same
indentation level as the first body line:

213 214 215
  if (expr)
      die("a diagnostic that would make this line"
          " extend past the 80-column limit"));
216 217 218 219 220 221

It is safe to omit the braces in the code above, since the further-indented
second body line makes it obvious that this is still a single-statement body.

To reiterate, don't do this:

222 223 224 225
  if (expr)            // BAD: no braces around...
      while (expr_2) { // ... a multi-line body
          ...
      }
226 227 228

Do this, instead:

229 230 231 232 233
  if (expr) {
      while (expr_2) {
          ...
      }
  }
234 235 236

However, there is one exception in the other direction, when even a one-line
block should have braces. That occurs when that one-line, brace-less block is
237 238 239 240 241
an "if" or "else" block, and the counterpart block *does* use braces. In that
case, put braces around both blocks. Also, if the "else" block is much shorter
than the "if" block, consider negating the "if"-condition and swapping the
bodies, putting the short block first and making the longer, multi-line block
be the "else" block.
242

243 244 245 246 247
  if (expr) {
      ...
      ...
  }
  else
248 249
      x = y;    // BAD: braceless "else" with braced "then",
                // and short block last
250

251 252 253 254 255 256
  if (expr)
      x = y;    // BAD: braceless "if" with braced "else"
  else {
      ...
      ...
  }
257

258 259 260 261 262 263
Keeping braces consistent and putting the short block first is preferred,
especially when the multi-line body is more than a few lines long, because it
is easier to read and grasp the semantics of an if-then-else block when the
simpler block occurs first, rather than after the more involved block:

  if (!expr) {
264
    x = y; // putting the smaller block first is more readable
265
  } else {
266 267 268
      ...
      ...
  }
269

270
But if negating a complex condition is too ugly, then at least add braces:
271

272
  if (complex expr not worth negating) {
273 274 275 276 277
      ...
      ...
  } else {
      x = y;
  }
278 279


280 281 282 283
Preprocessor
============
For variadic macros, stick with C99 syntax:

284
  #define vshPrint(_ctl, ...) fprintf(stdout, __VA_ARGS__)
285

286 287
Use parenthesis when checking if a macro is defined, and use indentation to
track nesting:
288

289 290 291
  #if defined(HAVE_POSIX_FALLOCATE) && !defined(HAVE_FALLOCATE)
  # define fallocate(a,ignored,b,c) posix_fallocate(a,b,c)
  #endif
292 293


294 295 296 297 298 299
C types
=======
Use the right type.

Scalars
-------
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
- If you're using "int" or "long", odds are good that there's a better type.

- If a variable is counting something, be sure to declare it with an unsigned
type.

- If it's memory-size-related, use "size_t" (use "ssize_t" only if required).

- If it's file-size related, use uintmax_t, or maybe "off_t".

- If it's file-offset related (i.e., signed), use "off_t".

- If it's just counting small numbers use "unsigned int"; (on all but oddball
embedded systems, you can assume that that type is at least four bytes wide).

- If a variable has boolean semantics, give it the "bool" type and use the
corresponding "true" and "false" macros. It's ok to include <stdbool.h>, since
libvirt's use of gnulib ensures that it exists and is usable.

- In the unusual event that you require a specific width, use a standard type
like "int32_t", "uint32_t", "uint64_t", etc.

- While using "bool" is good for readability, it comes with minor caveats:

-- Don't use "bool" in places where the type size must be constant across all
systems, like public interfaces and on-the-wire protocols. Note that it would
be possible (albeit wasteful) to use "bool" in libvirt's logical wire
protocol, since XDR maps that to its lower-level "bool_t" type, which *is*
fixed-size.

-- Don't compare a bool variable against the literal, "true", since a value with
a logical non-false value need not be "1". I.e., don't write "if (seen ==
true) ...". Rather, write "if (seen)...".





Of course, take all of the above with a grain of salt. If you're about to use
some system interface that requires a type like "size_t", "pid_t" or "off_t",
use matching types for any corresponding variables.

Also, if you try to use e.g., "unsigned int" as a type, and that conflicts
with the signedness of a related variable, sometimes it's best just to use the
*wrong* type, if 'pulling the thread' and fixing all related variables would
be too invasive.

Finally, while using descriptive types is important, be careful not to go
overboard. If whatever you're doing causes warnings, or requires casts, then
reconsider or ask for help.
349 350 351

Pointers
--------
352 353 354 355 356 357
Ensure that all of your pointers are 'const-correct'. Unless a pointer is used
to modify the pointed-to storage, give it the "const" attribute. That way, the
reader knows up-front that this is a read-only pointer. Perhaps more
importantly, if we're diligent about this, when you see a non-const pointer,
you're guaranteed that it is used to modify the storage it points to, or it is
aliased to another pointer that is.
358 359


360 361 362
Low level memory management
===========================
Use of the malloc/free/realloc/calloc APIs is deprecated in the libvirt
363 364
codebase, because they encourage a number of serious coding bugs and do not
enable compile time verification of checks for NULL. Instead of these
365
routines, use the macros from memory.h.
366

367
- To allocate a single object:
368

369 370 371 372 373 374
  virDomainPtr domain;

  if (VIR_ALLOC(domain) < 0) {
      virReportOOMError();
      return NULL;
  }
375 376 377



378
- To allocate an array of objects:
379

380
  virDomainPtr domains;
381
  size_t ndomains = 10;
382 383 384 385 386

  if (VIR_ALLOC_N(domains, ndomains) < 0) {
      virReportOOMError();
      return NULL;
  }
387 388 389



390
- To allocate an array of object pointers:
391

392
  virDomainPtr *domains;
393
  size_t ndomains = 10;
394

395 396 397 398 399 400 401
  if (VIR_ALLOC_N(domains, ndomains) < 0) {
      virReportOOMError();
      return NULL;
  }



402 403 404 405 406 407
- To re-allocate the array of domains to be 1 element longer (however, note that
repeatedly expanding an array by 1 scales quadratically, so this is
recommended only for smaller arrays):

  virDomainPtr domains;
  size_t ndomains = 0;
408

409
  if (VIR_EXPAND_N(domains, ndomains, 1) < 0) {
410 411 412
      virReportOOMError();
      return NULL;
  }
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
  domains[ndomains - 1] = domain;



- To ensure an array has room to hold at least one more element (this approach
scales better, but requires tracking allocation separately from usage)

  virDomainPtr domains;
  size_t ndomains = 0;
  size_t ndomains_max = 0;

  if (VIR_RESIZE_N(domains, ndomains_max, ndomains, 1) < 0) {
      virReportOOMError();
      return NULL;
  }
  domains[ndomains++] = domain;
429 430 431



432 433
- To trim an array of domains from its allocated size down to the actual used
size:
434

435 436 437 438
  virDomainPtr domains;
  size_t ndomains = x;
  size_t ndomains_max = y;

439
  VIR_SHRINK_N(domains, ndomains_max, ndomains_max - ndomains);
440 441 442



443
- To free an array of domains:
444

445 446 447 448 449 450 451 452 453
  virDomainPtr domains;
  size_t ndomains = x;
  size_t ndomains_max = y;
  size_t i;

  for (i = 0; i < ndomains; i++)
      VIR_FREE(domains[i]);
  VIR_FREE(domains);
  ndomains_max = ndomains = 0;
454 455 456 457 458 459






460 461
File handling
=============
462 463
Usage of the "fdopen()", "close()", "fclose()" APIs is deprecated in libvirt
code base to help avoiding double-closing of files or file descriptors, which
J
Ján Tomko 已提交
464
is particularly dangerous in a multi-threaded application. Instead of these
E
Eric Blake 已提交
465
APIs, use the macros from virfile.h
466

467
- Open a file from a file descriptor:
468 469 470 471 472 473 474 475 476

  if ((file = VIR_FDOPEN(fd, "r")) == NULL) {
      virReportSystemError(errno, "%s",
                           _("failed to open file from file descriptor"));
      return -1;
  }
  /* fd is now invalid; only access the file using file variable */


477

478
- Close a file descriptor:
479 480

  if (VIR_CLOSE(fd) < 0) {
481 482 483 484 485
      virReportSystemError(errno, "%s", _("failed to close file"));
  }



486
- Close a file:
487 488 489

  if (VIR_FCLOSE(file) < 0) {
      virReportSystemError(errno, "%s", _("failed to close file"));
490 491 492 493
  }



494 495
- Close a file or file descriptor in an error path, without losing the previous
"errno" value:
496 497

  VIR_FORCE_CLOSE(fd);
498
  VIR_FORCE_FCLOSE(file);
499 500


501 502 503



504 505 506

String comparisons
==================
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
Do not use the strcmp, strncmp, etc functions directly. Instead use one of the
following semantically named macros

- For strict equality:

  STREQ(a,b)
  STRNEQ(a,b)



- For case insensitive equality:

  STRCASEEQ(a,b)
  STRCASENEQ(a,b)


523

524
- For strict equality of a substring:
525

526 527
  STREQLEN(a,b,n)
  STRNEQLEN(a,b,n)
528 529 530



531
- For case insensitive equality of a substring:
532

533 534
  STRCASEEQLEN(a,b,n)
  STRCASENEQLEN(a,b,n)
535 536 537



538 539 540 541 542
- For strict equality of a prefix:

  STRPREFIX(a,b)


543

544 545 546 547 548 549 550
- To avoid having to check if a or b are NULL:

  STREQ_NULLABLE(a, b)
  STRNEQ_NULLABLE(a, b)



551 552 553



C
Chris Lalancette 已提交
554 555
String copying
==============
556 557 558
Do not use the strncpy function. According to the man page, it does *not*
guarantee a NULL-terminated buffer, which makes it extremely dangerous to use.
Instead, use one of the functionally equivalent functions:
C
Chris Lalancette 已提交
559

560
  virStrncpy(char *dest, const char *src, size_t n, size_t destbytes)
C
Chris Lalancette 已提交
561

562 563 564 565 566 567
The first three arguments have the same meaning as for strncpy; namely the
destination, source, and number of bytes to copy, respectively. The last
argument is the number of bytes available in the destination string; if a copy
of the source string (including a \0) will not fit into the destination, no
bytes are copied and the routine returns NULL. Otherwise, n bytes from the
source are copied into the destination and a trailing \0 is appended.
C
Chris Lalancette 已提交
568

569
  virStrcpy(char *dest, const char *src, size_t destbytes)
C
Chris Lalancette 已提交
570

571 572 573
Use this variant if you know you want to copy the entire src string into dest.
Note that this is a macro, so arguments could be evaluated more than once.
This is equivalent to virStrncpy(dest, src, strlen(src), destbytes)
C
Chris Lalancette 已提交
574

575 576 577 578 579 580 581
  virStrcpyStatic(char *dest, const char *src)

Use this variant if you know you want to copy the entire src string into dest
*and* you know that your destination string is a static string (i.e. that
sizeof(dest) returns something meaningful). Note that this is a macro, so
arguments could be evaluated more than once. This is equivalent to
virStrncpy(dest, src, strlen(src), sizeof(dest)).
C
Chris Lalancette 已提交
582 583


584 585
Variable length string buffer
=============================
586 587 588
If there is a need for complex string concatenations, avoid using the usual
sequence of malloc/strcpy/strcat/snprintf functions and make use of the
virBuffer API described in buf.h
589

590
Typical usage is as follows:
591 592

  char *
593 594
  somefunction(...)
  {
595 596 597 598 599
     virBuffer buf = VIR_BUFFER_INITIALIZER;

     ...

     virBufferAddLit(&buf, "<domain>\n");
600
     virBufferAsprintf(&buf, "  <memory>%d</memory>\n", memory);
601 602 603
     ...
     virBufferAddLit(&buf, "</domain>\n");

604
     ...
605 606

     if (virBufferError(&buf)) {
607
         virBufferFreeAndReset(&buf);
608
         virReportOOMError();
609 610 611 612 613
         return NULL;
     }

     return virBufferContentAndReset(&buf);
  }
614 615 616 617


Include files
=============
618 619 620
There are now quite a large number of include files, both libvirt internal and
external, and system includes. To manage all this complexity it's best to
stick to the following general plan for all *.c source files:
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636

  /*
   * Copyright notice
   * ....
   * ....
   * ....
   *
   */

  #include <config.h>             Must come first in every file.

  #include <stdio.h>              Any system includes you need.
  #include <string.h>
  #include <limits.h>

  #if HAVE_NUMACTL                Some system includes aren't supported
J
Jim Meyering 已提交
637
  # include <numa.h>              everywhere so need these #if guards.
638 639 640 641 642 643 644
  #endif

  #include "internal.h"           Include this first, after system includes.

  #include "util.h"               Any libvirt internal header files.
  #include "buf.h"

645 646
  static int
  myInternalFunc()                The actual code.
647
  {
648
      ...
649

650 651 652
Of particular note: *Do not* include libvirt/libvirt.h or libvirt/virterror.h.
It is included by "internal.h" already and there are some special reasons why
you cannot include these files explicitly.
653 654


655 656
Printf-style functions
======================
657 658 659 660 661 662 663 664 665 666 667
Whenever you add a new printf-style function, i.e., one with a format string
argument and following "..." in its prototype, be sure to use gcc's printf
attribute directive in the prototype. For example, here's the one for
virAsprintf, in util.h:

  int virAsprintf(char **strp, const char *fmt, ...)
      ATTRIBUTE_FORMAT(printf, 2, 3);

This makes it so gcc's -Wformat and -Wformat-security options can do their
jobs and cross-check format strings with the number and types of arguments.

E
Eric Blake 已提交
668 669 670 671 672 673
When printing to a string, consider using virBuffer for incremental
allocations, virAsprintf for a one-shot allocation, and snprintf for
fixed-width buffers. Do not use sprintf, even if you can prove the buffer
won't overflow, since gnulib does not provide the same portability guarantees
for sprintf as it does for snprintf.

674 675 676 677 678 679 680 681 682

Use of goto
===========
The use of goto is not forbidden, and goto is widely used throughout libvirt.
While the uncontrolled use of goto will quickly lead to unmaintainable code,
there is a place for it in well structured code where its use increases
readability and maintainability. In general, if goto is used for error
recovery, it's likely to be ok, otherwise, be cautious or avoid it all
together.
683

684 685 686 687 688 689 690 691 692
The typical use of goto is to jump to cleanup code in the case of a long list
of actions, any of which may fail and cause the entire operation to fail. In
this case, a function will have a single label at the end of the function.
It's almost always ok to use this style. In particular, if the cleanup code
only involves free'ing memory, then having multiple labels is overkill.
VIR_FREE() and every function named XXXFree() in libvirt is required to handle
NULL as its arg. Thus you can safely call free on all the variables even if
they were not yet allocated (yes they have to have been initialized to NULL).
This is much simpler and clearer than having multiple labels.
693

694
There are a couple of signs that a particular use of goto is not ok:
695

696 697 698
- You're using multiple labels. If you find yourself using multiple labels,
you're strongly encouraged to rework your code to eliminate all but one of
them.
699

700 701 702 703 704
- The goto jumps back up to a point above the current line of code being
executed. Please use some combination of looping constructs to re-execute code
instead; it's almost certainly going to be more understandable by others. One
well-known exception to this rule is restarting an i/o operation following
EINTR.
705

706 707 708 709
- The goto jumps down to an arbitrary place in the middle of a function followed
by further potentially failing calls. You should almost certainly be using a
conditional and a block instead of a goto. Perhaps some of your function's
logic would be better pulled out into a helper function.
710 711


712 713 714 715 716 717 718 719 720 721 722 723

Although libvirt does not encourage the Linux kernel wind/unwind style of
multiple labels, there's a good general discussion of the issue archived at

  KernelTrap
  http://kerneltrap.org/node/553/2131

When using goto, please use one of these standard labels if it makes sense:

      error: A path only taken upon return with an error code
    cleanup: A path taken upon return with success code + optional error
  no_memory: A path only taken upon return with an OOM error code
724
      retry: If needing to jump upwards (e.g., retry on EINTR)
725 726 727 728 729 730


Libvirt committer guidelines
============================
The AUTHORS files indicates the list of people with commit access right who
can actually merge the patches.
731

J
Jim Meyering 已提交
732
The general rule for committing a patch is to make sure it has been reviewed
733 734 735 736 737 738 739 740 741 742 743
properly in the mailing-list first, usually if a couple of people gave an ACK
or +1 to a patch and nobody raised an objection on the list it should be good
to go. If the patch touches a part of the code where you're not the main
maintainer, or where you do not have a very clear idea of how things work,
it's better to wait for a more authoritative feedback though. Before
committing, please also rebuild locally, run 'make check syntax-check', and
make sure you don't raise errors. Try to look for warnings too; for example,
configure with

  --enable-compile-warnings=error

744 745
which adds -Werror to compile flags, so no warnings get missed

746 747 748 749 750 751 752 753 754 755 756 757 758 759
An exception to 'review and approval on the list first' is fixing failures to
build:

- if a recently committed patch breaks compilation on a platform or for a given
driver, then it's fine to commit a minimal fix directly without getting the
review feedback first

- if make check or make syntax-check breaks, if there is an obvious fix, it's
fine to commit immediately. The patch should still be sent to the list (or
tell what the fix was if trivial), and 'make check syntax-check' should pass
too, before committing anything

- fixes for documentation and code comments can be managed in the same way, but
still make sure they get reviewed if non-trivial.