ktest: Updated the sample.conf for the latest options
[linux-2.6.git] / tools / testing / ktest / sample.conf
1 #
2 # Config file for ktest.pl
3 #
4 # Note, all paths must be absolute
5 #
6
7 # Options set in the beginning of the file are considered to be
8 # default options. These options can be overriden by test specific
9 # options, with the following exceptions:
10 #
11 #  LOG_FILE
12 #  CLEAR_LOG
13 #  POWEROFF_ON_SUCCESS
14 #  REBOOT_ON_SUCCESS
15 #
16 # Test specific options are set after the label:
17 #
18 # TEST_START
19 #
20 # The options after a TEST_START label are specific to that test.
21 # Each TEST_START label will set up a new test. If you want to
22 # perform a test more than once, you can add the ITERATE label
23 # to it followed by the number of times you want that test
24 # to iterate. If the ITERATE is left off, the test will only
25 # be performed once.
26 #
27 # TEST_START ITERATE 10
28 #
29 # You can skip a test by adding SKIP (before or after the ITERATE
30 # and number)
31 #
32 # TEST_START SKIP
33 #
34 # TEST_START SKIP ITERATE 10
35 #
36 # TEST_START ITERATE 10 SKIP
37 #
38 # The SKIP label causes the options and the test itself to be ignored.
39 # This is useful to set up several different tests in one config file, and
40 # only enabling the ones you want to use for a current test run.
41 #
42 # You can add default options anywhere in the file as well
43 # with the DEFAULTS tag. This allows you to have default options
44 # after the test options to keep the test options at the top
45 # of the file. You can even place the DEFAULTS tag between
46 # test cases (but not in the middle of a single test case)
47 #
48 # TEST_START
49 # MIN_CONFIG = /home/test/config-test1
50 #
51 # DEFAULTS
52 # MIN_CONFIG = /home/test/config-default
53 #
54 # TEST_START ITERATE 10
55 #
56 # The above will run the first test with MIN_CONFIG set to
57 # /home/test/config-test-1. Then 10 tests will be executed
58 # with MIN_CONFIG with /home/test/config-default.
59 #
60 # You can also disable defaults with the SKIP option
61 #
62 # DEFAULTS SKIP
63 # MIN_CONFIG = /home/test/config-use-sometimes
64 #
65 # DEFAULTS
66 # MIN_CONFIG = /home/test/config-most-times
67 #
68 # The above will ignore the first MIN_CONFIG. If you want to
69 # use the first MIN_CONFIG, remove the SKIP from the first
70 # DEFAULTS tag and add it to the second. Be careful, options
71 # may only be declared once per test or default. If you have
72 # the same option name under the same test or as default
73 # ktest will fail to execute, and no tests will run.
74 #
75
76
77 #### Mandatory Default Options ####
78
79 # These options must be in the default section, although most
80 # may be overridden by test options.
81
82 # The machine hostname that you will test
83 #MACHINE = target
84
85 # The box is expected to have ssh on normal bootup, provide the user
86 #  (most likely root, since you need privileged operations)
87 #SSH_USER = root
88
89 # The directory that contains the Linux source code
90 #BUILD_DIR = /home/test/linux.git
91
92 # The directory that the objects will be built
93 # (can not be same as BUILD_DIR)
94 #OUTPUT_DIR = /home/test/build/target
95
96 # The location of the compiled file to copy to the target
97 # (relative to OUTPUT_DIR)
98 #BUILD_TARGET = arch/x86/boot/bzImage
99
100 # The place to put your image on the test machine
101 #TARGET_IMAGE = /boot/vmlinuz-test
102
103 # A script or command to reboot the box
104 #
105 # Here is a digital loggers power switch example
106 #POWER_CYCLE = wget --no-proxy -O /dev/null -q  --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
107 #
108 # Here is an example to reboot a virtual box on the current host
109 # with the name "Guest".
110 #POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
111
112 # The script or command that reads the console
113 #
114 #  If you use ttywatch server, something like the following would work.
115 #CONSOLE = nc -d localhost 3001
116 #
117 # For a virtual machine with guest name "Guest".
118 #CONSOLE =  virsh console Guest
119
120 # Required version ending to differentiate the test
121 # from other linux builds on the system.
122 #LOCALVERSION = -test
123
124 # The grub title name for the test kernel to boot
125 # (Only mandatory if REBOOT_TYPE = grub)
126 #
127 # Note, ktest.pl will not update the grub menu.lst, you need to
128 # manually add an option for the test. ktest.pl will search
129 # the grub menu.lst for this option to find what kernel to
130 # reboot into.
131 #
132 # For example, if in the /boot/grub/menu.lst the test kernel title has:
133 # title Test Kernel
134 # kernel vmlinuz-test
135 #GRUB_MENU = Test Kernel
136
137 # A script to reboot the target into the test kernel
138 # (Only mandatory if REBOOT_TYPE = script)
139 #REBOOT_SCRIPT =
140
141 #### Optional Config Options (all have defaults) ####
142
143 # Start a test setup. If you leave this off, all options
144 # will be default and the test will run once.
145 # This is a label and not really an option (it takes no value).
146 # You can append ITERATE and a number after it to iterate the
147 # test a number of times, or SKIP to ignore this test.
148 #
149 #TEST_START
150 #TEST_START ITERATE 5
151 #TEST_START SKIP
152
153 # Have the following options as default again. Used after tests
154 # have already been defined by TEST_START. Optionally, you can
155 # just define all default options before the first TEST_START
156 # and you do not need this option.
157 #
158 # This is a label and not really an option (it takes no value).
159 # You can append SKIP to this label and the options within this
160 # section will be ignored.
161 #
162 # DEFAULTS
163 # DEFAULTS SKIP
164
165 # The default test type (default test)
166 # The test types may be:
167 #   build - only build the kernel, do nothing else
168 #   boot - build and boot the kernel
169 #   test - build, boot and if TEST is set, run the test script
170 #          (If TEST is not set, it defaults back to boot)
171 #   bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
172 #   patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
173 #TEST_TYPE = test
174
175 # Test to run if there is a successful boot and TEST_TYPE is test.
176 # Must exit with 0 on success and non zero on error
177 # default (undefined)
178 #TEST = ssh user@machine /root/run_test
179
180 # The build type is any make config type or special command
181 #  (default randconfig)
182 #   nobuild - skip the clean and build step
183 #   useconfig:/path/to/config - use the given config and run
184 #              oldconfig on it.
185 # This option is ignored if TEST_TYPE is patchcheck or bisect
186 #BUILD_TYPE = randconfig
187
188 # The make command (default make)
189 # If you are building a 32bit x86 on a 64 bit host
190 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
191
192 # Any build options for the make of the kernel (not for other makes, like configs)
193 # (default "")
194 #BUILD_OPTIONS = -j20
195
196 # If you need an initrd, you can add a script or code here to install
197 # it. The environment variable KERNEL_VERSION will be set to the
198 # kernel version that is used. Remember to add the initrd line
199 # to your grub menu.lst file.
200 #
201 # Here's a couple of examples to use:
202 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
203 #
204 # or on some systems:
205 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
206
207 # Way to reboot the box to the test kernel.
208 # Only valid options so far are "grub" and "script"
209 # (default grub)
210 # If you specify grub, it will assume grub version 1
211 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
212 # and select that target to reboot to the kernel. If this is not
213 # your setup, then specify "script" and have a command or script
214 # specified in REBOOT_SCRIPT to boot to the target.
215 #
216 # The entry in /boot/grub/menu.lst must be entered in manually.
217 # The test will not modify that file.
218 #REBOOT_TYPE = grub
219
220 # The min config that is needed to build for the machine
221 # A nice way to create this is with the following:
222 #
223 #   $ ssh target
224 #   $ lsmod > mymods
225 #   $ scp mymods host:/tmp
226 #   $ exit
227 #   $ cd linux.git
228 #   $ rm .config
229 #   $ make LSMOD=mymods localyesconfig
230 #   $ grep '^CONFIG' .config > /home/test/config-min
231 #
232 # If you want even less configs:
233 #
234 #   log in directly to target (do not ssh)
235 #
236 #   $ su
237 #   # lsmod | cut -d' ' -f1 | xargs rmmod
238 #
239 #   repeat the above several times
240 #
241 #   # lsmod > mymods
242 #   # reboot
243 #
244 # May need to reboot to get your network back to copy the mymods
245 # to the host, and then remove the previous .config and run the
246 # localyesconfig again. The CONFIG_MIN generated like this will
247 # not guarantee network activity to the box so the TEST_TYPE of
248 # test may fail.
249 #
250 # You might also want to set:
251 #   CONFIG_CMDLINE="<your options here>"
252 #  randconfig may set the above and override your real command
253 #  line options.
254 # (default undefined)
255 #MIN_CONFIG = /home/test/config-min
256
257 # Sometimes there's options that just break the boot and
258 # you do not care about. Here are a few:
259 #   # CONFIG_STAGING is not set
260 #  Staging drivers are horrible, and can break the build.
261 #   # CONFIG_SCSI_DEBUG is not set
262 #  SCSI_DEBUG may change your root partition
263 #   # CONFIG_KGDB_SERIAL_CONSOLE is not set
264 #  KGDB may cause oops waiting for a connection that's not there.
265 # This option points to the file containing config options that will be prepended
266 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
267 #
268 # Note, config options in MIN_CONFIG will override these options.
269 #
270 # (default undefined)
271 #ADD_CONFIG = /home/test/config-broken
272
273 # The location on the host where to write temp files
274 # (default /tmp/ktest)
275 #TMP_DIR = /tmp/ktest
276
277 # Optional log file to write the status (recommended)
278 #  Note, this is a DEFAULT section only option.
279 # (default undefined)
280 #LOG_FILE = /home/test/logfiles/target.log
281
282 # Remove old logfile if it exists before starting all tests.
283 #  Note, this is a DEFAULT section only option.
284 # (default 0)
285 #CLEAR_LOG = 0
286
287 # Line to define a successful boot up in console output.
288 # This is what the line contains, not the entire line. If you need
289 # the entire line to match, then use regural expression syntax like:
290 #  (do not add any quotes around it)
291 #
292 #  SUCCESS_LINE = ^MyBox Login:$
293 #
294 # (default "login:")
295 #SUCCESS_LINE = login:
296
297 # Stop testing if a build fails. If set, the script will end if
298 # a failure is detected, otherwise it will save off the .config,
299 # dmesg and bootlog in a directory called
300 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
301 # if the STORE_FAILURES directory is set.
302 # (default 1)
303 # Note, even if this is set to zero, there are some errors that still
304 # stop the tests.
305 #DIE_ON_FAILURE = 1
306
307 # Directory to store failure directories on failure. If this is not
308 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
309 # bootlog. This option is ignored if DIE_ON_FAILURE is not set.
310 # (default undefined)
311 #STORE_FAILURES = /home/test/failures
312
313 # Build without doing a make mrproper, or removing .config
314 # (default 0)
315 #BUILD_NOCLEAN = 0
316
317 # As the test reads the console, after it hits the SUCCESS_LINE
318 # the time it waits for the monitor to settle down between reads
319 # can usually be lowered.
320 # (in seconds) (default 1)
321 #BOOTED_TIMEOUT = 1
322
323 # The timeout in seconds when we consider the box hung after
324 # the console stop producing output. Be sure to leave enough
325 # time here to get pass a reboot. Some machines may not produce
326 # any console output for a long time during a reboot. You do
327 # not want the test to fail just because the system was in
328 # the process of rebooting to the test kernel.
329 # (default 120)
330 #TIMEOUT = 120
331
332 # In between tests, a reboot of the box may occur, and this
333 # is the time to wait for the console after it stops producing
334 # output. Some machines may not produce a large lag on reboot
335 # so this should accommodate it.
336 # The difference between this and TIMEOUT, is that TIMEOUT happens
337 # when rebooting to the test kernel. This sleep time happens
338 # after a test has completed and we are about to start running
339 # another test. If a reboot to the reliable kernel happens,
340 # we wait SLEEP_TIME for the console to stop producing output
341 # before starting the next test.
342 # (default 60)
343 #SLEEP_TIME = 60
344
345 # The time in between bisects to sleep (in seconds)
346 # (default 60)
347 #BISECT_SLEEP_TIME = 60
348
349 # Reboot the target box on error (default 0)
350 #REBOOT_ON_ERROR = 0
351
352 # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
353 #  Note, this is a DEFAULT section only option.
354 # (default 0)
355 #POWEROFF_ON_ERROR = 0
356
357 # Power off the target after all tests have completed successfully
358 #  Note, this is a DEFAULT section only option.
359 # (default 0)
360 #POWEROFF_ON_SUCCESS = 0
361
362 # Reboot the target after all test completed successfully (default 1)
363 # (ignored if POWEROFF_ON_SUCCESS is set)
364 #REBOOT_ON_SUCCESS = 1
365
366 # In case there are isses with rebooting, you can specify this
367 # to always powercycle after this amount of time after calling
368 # reboot.
369 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
370 # makes it powercycle immediately after rebooting. Do not define
371 # it if you do not want it.
372 # (default undefined)
373 #POWERCYCLE_AFTER_REBOOT = 5
374
375 # In case there's isses with halting, you can specify this
376 # to always poweroff after this amount of time after calling
377 # halt.
378 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
379 # makes it poweroff immediately after halting. Do not define
380 # it if you do not want it.
381 # (default undefined)
382 #POWEROFF_AFTER_HALT = 20
383
384 # A script or command to power off the box (default undefined)
385 # Needed for POWEROFF_ON_ERROR and SUCCESS
386 #
387 # Example for digital loggers power switch:
388 #POWER_OFF = wget --no-proxy -O /dev/null -q  --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
389 #
390 # Example for a virtual guest call "Guest".
391 #POWER_OFF = virsh destroy Guest
392
393 # The way to execute a command on the target
394 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
395 # The variables SSH_USER, MACHINE and SSH_COMMAND are defined
396 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
397
398 # The way to copy a file to the target
399 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
400 # The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
401 #SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
402
403 # The nice way to reboot the target
404 # (default ssh $SSH_USER@$MACHINE reboot)
405 # The variables SSH_USER and MACHINE are defined.
406 #REBOOT = ssh $SSH_USER@$MACHINE reboot
407
408 #### Per test run options ####
409 # The following options are only allowed in TEST_START sections.
410 # They are ignored in the DEFAULTS sections.
411 #
412 # All of these are optional and undefined by default, although
413 #  some of these options are required for TEST_TYPE of patchcheck
414 #  and bisect.
415 #
416 #
417 # CHECKOUT = branch
418 #
419 #  If the BUILD_DIR is a git repository, then you can set this option
420 #  to checkout the given branch before running the TEST. If you
421 #  specify this for the first run, that branch will be used for
422 #  all preceding tests until a new CHECKOUT is set.
423 #
424 #
425 #
426 # For TEST_TYPE = patchcheck
427 #
428 #  This expects the BUILD_DIR to be a git repository, and
429 #  will checkout the PATCHCHECK_START commit.
430 #
431 #  The option BUILD_TYPE will be ignored.
432 #
433 #  The MIN_CONFIG will be used for all builds of the patchcheck. The build type
434 #  used for patchcheck is oldconfig.
435 #
436 #  PATCHCHECK_START is required and is the first patch to
437 #   test (the SHA1 of the commit). You may also specify anything
438 #   that git checkout allows (branch name, tage, HEAD~3).
439 #
440 #  PATCHCHECK_END is the last patch to check (default HEAD)
441 #
442 #  PATCHCHECK_TYPE is required and is the type of test to run:
443 #      build, boot, test.
444 #
445 #   Note, the build test will look for warnings, if a warning occurred
446 #     in a file that a commit touches, the build will fail.
447 #
448 #   If BUILD_NOCLEAN is set, then make mrproper will not be run on
449 #   any of the builds, just like all other TEST_TYPE tests. But
450 #   what makes patchcheck different from the other tests, is if
451 #   BUILD_NOCLEAN is not set, only the first and last patch run
452 #   make mrproper. This helps speed up the test.
453 #
454 # Example:
455 #   TEST_START
456 #   TEST_TYPE = patchcheck
457 #   CHECKOUT = mybranch
458 #   PATCHCHECK_TYPE = boot
459 #   PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
460 #   PATCHCHECK_END = HEAD~2
461 #
462 #
463 #
464 # For TEST_TYPE = bisect
465 #
466 #  You can specify a git bisect if the BUILD_DIR is a git repository.
467 #  The MIN_CONFIG will be used for all builds of the bisect. The build type
468 #  used for bisecting is oldconfig.
469 #
470 #  The option BUILD_TYPE will be ignored.
471 #
472 #  BISECT_TYPE is the type of test to perform:
473 #       build   - bad fails to build
474 #       boot    - bad builds but fails to boot
475 #       test    - bad boots but fails a test
476 #
477 # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
478 # BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
479 #
480 # The above three options are required for a bisect operation.
481 #
482 # BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
483 #
484 #   If an operation failed in the bisect that was not expected to
485 #   fail. Then the test ends. The state of the BUILD_DIR will be
486 #   left off at where the failure occurred. You can examine the
487 #   reason for the failure, and perhaps even find a git commit
488 #   that would work to continue with. You can run:
489 #
490 #   git bisect log > /path/to/replay/file
491 #
492 #   The adding:
493 #
494 #    BISECT_REPLAY= /path/to/replay/file
495 #
496 #   And running the test again. The test will perform the initial
497 #    git bisect start, git bisect good, and git bisect bad, and
498 #    then it will run git bisect replay on this file, before
499 #    continuing with the bisect.
500 #
501 # BISECT_START = commit (optional, default undefined)
502 #
503 #   As with BISECT_REPLAY, if the test failed on a commit that
504 #   just happen to have a bad commit in the middle of the bisect,
505 #   and you need to skip it. If BISECT_START is defined, it
506 #   will checkout that commit after doing the initial git bisect start,
507 #   git bisect good, git bisect bad, and running the git bisect replay
508 #   if the BISECT_REPLAY is set.
509 #
510 # BISECT_REVERSE = 1 (optional, default 0)
511 #
512 #   In those strange instances where it was broken forever
513 #   and you are trying to find where it started to work!
514 #   Set BISECT_GOOD to the commit that was last known to fail
515 #   Set BISECT_BAD to the commit that is known to start working.
516 #   With BISECT_REVERSE = 1, The test will consider failures as
517 #   good, and success as bad.
518 #
519 # BISECT_CHECK = 1 (optional, default 0)
520 #
521 #   Just to be sure the good is good and bad is bad, setting
522 #   BISECT_CHECK to 1 will start the bisect by first checking
523 #   out BISECT_BAD and makes sure it fails, then it will check
524 #   out BISECT_GOOD and makes sure it succeeds before starting
525 #   the bisect (it works for BISECT_REVERSE too).
526 #
527 #   You can limit the test to just check BISECT_GOOD or
528 #   BISECT_BAD with BISECT_CHECK = good or
529 #   BISECT_CHECK = bad, respectively.
530 #
531 # Example:
532 #   TEST_START
533 #   TEST_TYPE = bisect
534 #   BISECT_GOOD = v2.6.36
535 #   BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
536 #   BISECT_TYPE = build
537 #   MIN_CONFIG = /home/test/config-bisect
538 #
539 #
540 #
541 # For TEST_TYPE = config_bisect
542 #
543 #  In those cases that you have two different configs. One of them
544 #  work, the other does not, and you do not know what config causes
545 #  the problem.
546 #  The TEST_TYPE config_bisect will bisect the bad config looking for
547 #  what config causes the failure.
548 #
549 #  The way it works is this:
550 #
551 #   First it finds a config to work with. Since a different version, or
552 #   MIN_CONFIG may cause different dependecies, it must run through this
553 #   preparation.
554 #
555 #   Overwrites any config set in the bad config with a config set in
556 #   either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
557 #   are minimal and do not disable configs you want to test:
558 #   (ie.  # CONFIG_FOO is not set).
559 #
560 #   An oldconfig is run on the bad config and any new config that
561 #   appears will be added to the configs to test.
562 #
563 #   Finally, it generates a config with the above result and runs it
564 #   again through make oldconfig to produce a config that should be
565 #   satisfied by kconfig.
566 #
567 #   Then it starts the bisect.
568 #
569 #   The configs to test are cut in half. If all the configs in this
570 #   half depend on a config in the other half, then the other half
571 #   is tested instead. If no configs are enabled by either half, then
572 #   this means a circular dependency exists and the test fails.
573 #
574 #   A config is created with the test half, and the bisect test is run.
575 #
576 #   If the bisect succeeds, then all configs in the generated config
577 #   are removed from the configs to test and added to the configs that
578 #   will be enabled for all builds (they will be enabled, but not be part
579 #   of the configs to examine).
580 #
581 #   If the bisect fails, then all test configs that were not enabled by
582 #   the config file are removed from the test. These configs will not
583 #   be enabled in future tests. Since current config failed, we consider
584 #   this to be a subset of the config that we started with.
585 #
586 #   When we are down to one config, it is considered the bad config.
587 #
588 #   Note, the config chosen may not be the true bad config. Due to
589 #   dependencies and selections of the kbuild system, mulitple
590 #   configs may be needed to cause a failure. If you disable the
591 #   config that was found and restart the test, if the test fails
592 #   again, it is recommended to rerun the config_bisect with a new
593 #   bad config without the found config enabled.
594 #
595 #  The option BUILD_TYPE will be ignored.
596 #
597 #  CONFIG_BISECT_TYPE is the type of test to perform:
598 #       build   - bad fails to build
599 #       boot    - bad builds but fails to boot
600 #       test    - bad boots but fails a test
601 #
602 #   CONFIG_BISECT is the config that failed to boot
603 #
604 # Example:
605 #   TEST_START
606 #   TEST_TYPE = config_bisect
607 #   CONFIG_BISECT_TYPE = build
608 #   CONFIG_BISECT = /home/test/Ā¢onfig-bad
609 #   MIN_CONFIG = /home/test/config-min
610 #