CODING

   1 Patches to module-init-tools are welcome.  Please note the following
   2 design goals:
   3
   4 1) insmod and rmmod are designed to be as simple as possible.
   5
   6 2) modprobe is designed to be a swiss-army-knife, but the config file
   7    format is designed to be as simple as possible: let the user create
   8    complexity if they wish.
   9
  10 3) module-init-tools contains a testsuite.  Patches which do not pass
  11    the testsuite get a frowny face.
  12
  13 New tests
  14 ---------
  15
  16 The following tests have been recently added:
  17
  18         * Binary trie tests (test-modprobe-indexed)
  19
  20 The testsuite
  21 -------------
  22
  23 The testsuite is under tests/test-*: one directory for each tool.  You
  24 can run "make check" to run the testsuite: it will use valgrind (much
  25 slower, but catches more things) if it is installed.
  26
  27 "make check" simply invokes "./tests/runtests".
  28
  29 To start the tests at a particular test, use that test name on the
  30 command line, eg. "./tests/runtests 26blacklist.sh".  To see exactly
  31 what the test is doing, use -vv, eg
  32
  33         ./tests/runtests -vv 26blacklist.sh
  34
  35 Each test is a shell script run with "-e": ie. if any command fails,
  36 the test will fail.  The path is set up with special test versions of
  37 the utilities (and possibly valgrind wrappers), so just invoke
  38 "modprobe" etc. as normal.  Environment variables can be used to
  39 control normally hardwired behaviour:
  40
  41 1) $MODTEST_UNAME:
  42         The result "uname" is to return.  Set to 2.6.27 by default.
  43
  44 2) $MODTEST_OVERRIDE<n>, $MODTEST_OVERRIDE_WITH<n>
  45         These cause file operations on $MODTEST_OVERRIDE1 to occur on
  46         $MODTEST_OVERRIDE_WITH1, etc.  The numbers must be consecutive:
  47         the code stops searching for a replacement when a number is not
  48         found.  This is used to stop the utilities looking in
  49         /lib/modules/2.6.27/ for example.
  50
  51         Other environment variables can be found in testing.h.
  52
  53 There are various pre-compiled test modules under tests/data/.  Each
  54 one has big and little endian and 32 and 64-bit variants: modprobe
  55 must handle both 32 and 64 bit (for x86-64, PPC64, Sparc64, IA64), and
  56 depmod and modinfo must handle any endianness as well.  If you need to
  57 add a new module to test something, put the source under tests/src,
  58 make sure it passes for the cases you can test, and I'll compile and
  59 test the others.
  60
  61 When writing tests, make sure your test aborts on any unexpected
  62 behaviour: eg. compare the result is equal to what you expect, rather
  63 than not equal to something.
  64
  65 Cheers!
  66 Rusty and Jon.