ktest: Add CONFIG_BISECT_GOOD option
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / tools / testing / ktest / sample.conf
blobbe531c20643d8010b34e0548de39061af760e360
2 # Config file for ktest.pl
4 # Note, all paths must be absolute
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:
11 #  LOG_FILE
12 #  CLEAR_LOG
13 #  POWEROFF_ON_SUCCESS
14 #  REBOOT_ON_SUCCESS
16 # Test specific options are set after the label:
18 # TEST_START
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.
27 # TEST_START ITERATE 10
29 # You can skip a test by adding SKIP (before or after the ITERATE
30 # and number)
32 # TEST_START SKIP
34 # TEST_START SKIP ITERATE 10
36 # TEST_START ITERATE 10 SKIP
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.
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)
48 # TEST_START
49 # MIN_CONFIG = /home/test/config-test1
51 # DEFAULTS
52 # MIN_CONFIG = /home/test/config-default
54 # TEST_START ITERATE 10
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.
60 # You can also disable defaults with the SKIP option
62 # DEFAULTS SKIP
63 # MIN_CONFIG = /home/test/config-use-sometimes
65 # DEFAULTS
66 # MIN_CONFIG = /home/test/config-most-times
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.
76 #### Config variables ####
78 # This config file can also contain "config variables".
79 # These are assigned with ":=" instead of the ktest option
80 # assigment "=".
82 # The difference between ktest options and config variables
83 # is that config variables can be used multiple times,
84 # where each instance will override the previous instance.
85 # And that they only live at time of processing this config.
87 # The advantage to config variables are that they can be used
88 # by any option or any other config variables to define thing
89 # that you may use over and over again in the options.
91 # For example:
93 # USER      := root
94 # TARGET    := mybox
95 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
97 # TEST_START
98 # MIN_CONFIG = config1
99 # TEST = ${TEST_CASE}
101 # TEST_START
102 # MIN_CONFIG = config2
103 # TEST = ${TEST_CASE}
105 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
107 # TEST_START
108 # MIN_CONFIG = config1
109 # TEST = ${TEST_CASE}
111 # TEST_START
112 # MIN_CONFIG = config2
113 # TEST = ${TEST_CASE}
115 # TEST_DIR := /home/me/test
117 # BUILD_DIR = ${TEST_DIR}/linux.git
118 # OUTPUT_DIR = ${TEST_DIR}/test
120 # Note, the config variables are evaluated immediately, thus
121 # updating TARGET after TEST_CASE has been assigned does nothing
122 # to TEST_CASE.
124 # As shown in the example, to evaluate a config variable, you
125 # use the ${X} convention. Simple $X will not work.
127 # If the config variable does not exist, the ${X} will not
128 # be evaluated. Thus:
130 # MAKE_CMD = PATH=/mypath:${PATH} make
132 # If PATH is not a config variable, then the ${PATH} in
133 # the MAKE_CMD option will be evaluated by the shell when
134 # the MAKE_CMD option is passed into shell processing.
136 #### Using options in other options ####
138 # Options that are defined in the config file may also be used
139 # by other options. All options are evaulated at time of
140 # use (except that config variables are evaluated at config
141 # processing time).
143 # If an ktest option is used within another option, instead of
144 # typing it again in that option you can simply use the option
145 # just like you can config variables.
147 # MACHINE = mybox
149 # TEST = ssh root@${MACHINE} /path/to/test
151 # The option will be used per test case. Thus:
153 # TEST_TYPE = test
154 # TEST = ssh root@{MACHINE}
156 # TEST_START
157 # MACHINE = box1
159 # TEST_START
160 # MACHINE = box2
162 # For both test cases, MACHINE will be evaluated at the time
163 # of the test case. The first test will run ssh root@box1
164 # and the second will run ssh root@box2.
166 #### Mandatory Default Options ####
168 # These options must be in the default section, although most
169 # may be overridden by test options.
171 # The machine hostname that you will test
172 #MACHINE = target
174 # The box is expected to have ssh on normal bootup, provide the user
175 #  (most likely root, since you need privileged operations)
176 #SSH_USER = root
178 # The directory that contains the Linux source code
179 #BUILD_DIR = /home/test/linux.git
181 # The directory that the objects will be built
182 # (can not be same as BUILD_DIR)
183 #OUTPUT_DIR = /home/test/build/target
185 # The location of the compiled file to copy to the target
186 # (relative to OUTPUT_DIR)
187 #BUILD_TARGET = arch/x86/boot/bzImage
189 # The place to put your image on the test machine
190 #TARGET_IMAGE = /boot/vmlinuz-test
192 # A script or command to reboot the box
194 # Here is a digital loggers power switch example
195 #POWER_CYCLE = wget --no-proxy -O /dev/null -q  --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
197 # Here is an example to reboot a virtual box on the current host
198 # with the name "Guest".
199 #POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
201 # The script or command that reads the console
203 #  If you use ttywatch server, something like the following would work.
204 #CONSOLE = nc -d localhost 3001
206 # For a virtual machine with guest name "Guest".
207 #CONSOLE =  virsh console Guest
209 # Required version ending to differentiate the test
210 # from other linux builds on the system.
211 #LOCALVERSION = -test
213 # The grub title name for the test kernel to boot
214 # (Only mandatory if REBOOT_TYPE = grub)
216 # Note, ktest.pl will not update the grub menu.lst, you need to
217 # manually add an option for the test. ktest.pl will search
218 # the grub menu.lst for this option to find what kernel to
219 # reboot into.
221 # For example, if in the /boot/grub/menu.lst the test kernel title has:
222 # title Test Kernel
223 # kernel vmlinuz-test
224 #GRUB_MENU = Test Kernel
226 # A script to reboot the target into the test kernel
227 # (Only mandatory if REBOOT_TYPE = script)
228 #REBOOT_SCRIPT =
230 #### Optional Config Options (all have defaults) ####
232 # Start a test setup. If you leave this off, all options
233 # will be default and the test will run once.
234 # This is a label and not really an option (it takes no value).
235 # You can append ITERATE and a number after it to iterate the
236 # test a number of times, or SKIP to ignore this test.
238 #TEST_START
239 #TEST_START ITERATE 5
240 #TEST_START SKIP
242 # Have the following options as default again. Used after tests
243 # have already been defined by TEST_START. Optionally, you can
244 # just define all default options before the first TEST_START
245 # and you do not need this option.
247 # This is a label and not really an option (it takes no value).
248 # You can append SKIP to this label and the options within this
249 # section will be ignored.
251 # DEFAULTS
252 # DEFAULTS SKIP
254 # The default test type (default test)
255 # The test types may be:
256 #   build - only build the kernel, do nothing else
257 #   boot - build and boot the kernel
258 #   test - build, boot and if TEST is set, run the test script
259 #          (If TEST is not set, it defaults back to boot)
260 #   bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
261 #   patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
262 #TEST_TYPE = test
264 # Test to run if there is a successful boot and TEST_TYPE is test.
265 # Must exit with 0 on success and non zero on error
266 # default (undefined)
267 #TEST = ssh user@machine /root/run_test
269 # The build type is any make config type or special command
270 #  (default randconfig)
271 #   nobuild - skip the clean and build step
272 #   useconfig:/path/to/config - use the given config and run
273 #              oldconfig on it.
274 # This option is ignored if TEST_TYPE is patchcheck or bisect
275 #BUILD_TYPE = randconfig
277 # The make command (default make)
278 # If you are building a 32bit x86 on a 64 bit host
279 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
281 # Any build options for the make of the kernel (not for other makes, like configs)
282 # (default "")
283 #BUILD_OPTIONS = -j20
285 # If you need an initrd, you can add a script or code here to install
286 # it. The environment variable KERNEL_VERSION will be set to the
287 # kernel version that is used. Remember to add the initrd line
288 # to your grub menu.lst file.
290 # Here's a couple of examples to use:
291 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
293 # or on some systems:
294 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
296 # Way to reboot the box to the test kernel.
297 # Only valid options so far are "grub" and "script"
298 # (default grub)
299 # If you specify grub, it will assume grub version 1
300 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
301 # and select that target to reboot to the kernel. If this is not
302 # your setup, then specify "script" and have a command or script
303 # specified in REBOOT_SCRIPT to boot to the target.
305 # The entry in /boot/grub/menu.lst must be entered in manually.
306 # The test will not modify that file.
307 #REBOOT_TYPE = grub
309 # The min config that is needed to build for the machine
310 # A nice way to create this is with the following:
312 #   $ ssh target
313 #   $ lsmod > mymods
314 #   $ scp mymods host:/tmp
315 #   $ exit
316 #   $ cd linux.git
317 #   $ rm .config
318 #   $ make LSMOD=mymods localyesconfig
319 #   $ grep '^CONFIG' .config > /home/test/config-min
321 # If you want even less configs:
323 #   log in directly to target (do not ssh)
325 #   $ su
326 #   # lsmod | cut -d' ' -f1 | xargs rmmod
328 #   repeat the above several times
330 #   # lsmod > mymods
331 #   # reboot
333 # May need to reboot to get your network back to copy the mymods
334 # to the host, and then remove the previous .config and run the
335 # localyesconfig again. The CONFIG_MIN generated like this will
336 # not guarantee network activity to the box so the TEST_TYPE of
337 # test may fail.
339 # You might also want to set:
340 #   CONFIG_CMDLINE="<your options here>"
341 #  randconfig may set the above and override your real command
342 #  line options.
343 # (default undefined)
344 #MIN_CONFIG = /home/test/config-min
346 # Sometimes there's options that just break the boot and
347 # you do not care about. Here are a few:
348 #   # CONFIG_STAGING is not set
349 #  Staging drivers are horrible, and can break the build.
350 #   # CONFIG_SCSI_DEBUG is not set
351 #  SCSI_DEBUG may change your root partition
352 #   # CONFIG_KGDB_SERIAL_CONSOLE is not set
353 #  KGDB may cause oops waiting for a connection that's not there.
354 # This option points to the file containing config options that will be prepended
355 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
357 # Note, config options in MIN_CONFIG will override these options.
359 # (default undefined)
360 #ADD_CONFIG = /home/test/config-broken
362 # The location on the host where to write temp files
363 # (default /tmp/ktest)
364 #TMP_DIR = /tmp/ktest
366 # Optional log file to write the status (recommended)
367 #  Note, this is a DEFAULT section only option.
368 # (default undefined)
369 #LOG_FILE = /home/test/logfiles/target.log
371 # Remove old logfile if it exists before starting all tests.
372 #  Note, this is a DEFAULT section only option.
373 # (default 0)
374 #CLEAR_LOG = 0
376 # Line to define a successful boot up in console output.
377 # This is what the line contains, not the entire line. If you need
378 # the entire line to match, then use regural expression syntax like:
379 #  (do not add any quotes around it)
381 #  SUCCESS_LINE = ^MyBox Login:$
383 # (default "login:")
384 #SUCCESS_LINE = login:
386 # In case the console constantly fills the screen, having
387 # a specified time to stop the test after success is recommended.
388 # (in seconds)
389 # (default 10)
390 #STOP_AFTER_SUCCESS = 10
392 # In case the console constantly fills the screen, having
393 # a specified time to stop the test after failure is recommended.
394 # (in seconds)
395 # (default 60)
396 #STOP_AFTER_FAILURE = 60
398 # In case the console constantly fills the screen, having
399 # a specified time to stop the test if it never succeeds nor fails
400 # is recommended.
401 # Note: this is ignored if a success or failure is detected.
402 # (in seconds)
403 # (default 600, -1 is to never stop)
404 #STOP_TEST_AFTER = 600
406 # Stop testing if a build fails. If set, the script will end if
407 # a failure is detected, otherwise it will save off the .config,
408 # dmesg and bootlog in a directory called
409 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
410 # if the STORE_FAILURES directory is set.
411 # (default 1)
412 # Note, even if this is set to zero, there are some errors that still
413 # stop the tests.
414 #DIE_ON_FAILURE = 1
416 # Directory to store failure directories on failure. If this is not
417 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
418 # bootlog. This option is ignored if DIE_ON_FAILURE is not set.
419 # (default undefined)
420 #STORE_FAILURES = /home/test/failures
422 # Build without doing a make mrproper, or removing .config
423 # (default 0)
424 #BUILD_NOCLEAN = 0
426 # As the test reads the console, after it hits the SUCCESS_LINE
427 # the time it waits for the monitor to settle down between reads
428 # can usually be lowered.
429 # (in seconds) (default 1)
430 #BOOTED_TIMEOUT = 1
432 # The timeout in seconds when we consider the box hung after
433 # the console stop producing output. Be sure to leave enough
434 # time here to get pass a reboot. Some machines may not produce
435 # any console output for a long time during a reboot. You do
436 # not want the test to fail just because the system was in
437 # the process of rebooting to the test kernel.
438 # (default 120)
439 #TIMEOUT = 120
441 # In between tests, a reboot of the box may occur, and this
442 # is the time to wait for the console after it stops producing
443 # output. Some machines may not produce a large lag on reboot
444 # so this should accommodate it.
445 # The difference between this and TIMEOUT, is that TIMEOUT happens
446 # when rebooting to the test kernel. This sleep time happens
447 # after a test has completed and we are about to start running
448 # another test. If a reboot to the reliable kernel happens,
449 # we wait SLEEP_TIME for the console to stop producing output
450 # before starting the next test.
451 # (default 60)
452 #SLEEP_TIME = 60
454 # The time in between bisects to sleep (in seconds)
455 # (default 60)
456 #BISECT_SLEEP_TIME = 60
458 # The time in between patch checks to sleep (in seconds)
459 # (default 60)
460 #PATCHCHECK_SLEEP_TIME = 60
462 # Reboot the target box on error (default 0)
463 #REBOOT_ON_ERROR = 0
465 # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
466 #  Note, this is a DEFAULT section only option.
467 # (default 0)
468 #POWEROFF_ON_ERROR = 0
470 # Power off the target after all tests have completed successfully
471 #  Note, this is a DEFAULT section only option.
472 # (default 0)
473 #POWEROFF_ON_SUCCESS = 0
475 # Reboot the target after all test completed successfully (default 1)
476 # (ignored if POWEROFF_ON_SUCCESS is set)
477 #REBOOT_ON_SUCCESS = 1
479 # In case there are isses with rebooting, you can specify this
480 # to always powercycle after this amount of time after calling
481 # reboot.
482 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
483 # makes it powercycle immediately after rebooting. Do not define
484 # it if you do not want it.
485 # (default undefined)
486 #POWERCYCLE_AFTER_REBOOT = 5
488 # In case there's isses with halting, you can specify this
489 # to always poweroff after this amount of time after calling
490 # halt.
491 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
492 # makes it poweroff immediately after halting. Do not define
493 # it if you do not want it.
494 # (default undefined)
495 #POWEROFF_AFTER_HALT = 20
497 # A script or command to power off the box (default undefined)
498 # Needed for POWEROFF_ON_ERROR and SUCCESS
500 # Example for digital loggers power switch:
501 #POWER_OFF = wget --no-proxy -O /dev/null -q  --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
503 # Example for a virtual guest call "Guest".
504 #POWER_OFF = virsh destroy Guest
506 # The way to execute a command on the target
507 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
508 # The variables SSH_USER, MACHINE and SSH_COMMAND are defined
509 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
511 # The way to copy a file to the target
512 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
513 # The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
514 #SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
516 # The nice way to reboot the target
517 # (default ssh $SSH_USER@$MACHINE reboot)
518 # The variables SSH_USER and MACHINE are defined.
519 #REBOOT = ssh $SSH_USER@$MACHINE reboot
521 # The way triple faults are detected is by testing the kernel
522 # banner. If the kernel banner for the kernel we are testing is
523 # found, and then later a kernel banner for another kernel version
524 # is found, it is considered that we encountered a triple fault,
525 # and there is no panic or callback, but simply a reboot.
526 # To disable this (because it did a false positive) set the following
527 # to 0.
528 # (default 1)
529 #DETECT_TRIPLE_FAULT = 0
531 #### Per test run options ####
532 # The following options are only allowed in TEST_START sections.
533 # They are ignored in the DEFAULTS sections.
535 # All of these are optional and undefined by default, although
536 #  some of these options are required for TEST_TYPE of patchcheck
537 #  and bisect.
540 # CHECKOUT = branch
542 #  If the BUILD_DIR is a git repository, then you can set this option
543 #  to checkout the given branch before running the TEST. If you
544 #  specify this for the first run, that branch will be used for
545 #  all preceding tests until a new CHECKOUT is set.
549 # For TEST_TYPE = patchcheck
551 #  This expects the BUILD_DIR to be a git repository, and
552 #  will checkout the PATCHCHECK_START commit.
554 #  The option BUILD_TYPE will be ignored.
556 #  The MIN_CONFIG will be used for all builds of the patchcheck. The build type
557 #  used for patchcheck is oldconfig.
559 #  PATCHCHECK_START is required and is the first patch to
560 #   test (the SHA1 of the commit). You may also specify anything
561 #   that git checkout allows (branch name, tage, HEAD~3).
563 #  PATCHCHECK_END is the last patch to check (default HEAD)
565 #  PATCHCHECK_TYPE is required and is the type of test to run:
566 #      build, boot, test.
568 #   Note, the build test will look for warnings, if a warning occurred
569 #     in a file that a commit touches, the build will fail.
571 #   If BUILD_NOCLEAN is set, then make mrproper will not be run on
572 #   any of the builds, just like all other TEST_TYPE tests. But
573 #   what makes patchcheck different from the other tests, is if
574 #   BUILD_NOCLEAN is not set, only the first and last patch run
575 #   make mrproper. This helps speed up the test.
577 # Example:
578 #   TEST_START
579 #   TEST_TYPE = patchcheck
580 #   CHECKOUT = mybranch
581 #   PATCHCHECK_TYPE = boot
582 #   PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
583 #   PATCHCHECK_END = HEAD~2
587 # For TEST_TYPE = bisect
589 #  You can specify a git bisect if the BUILD_DIR is a git repository.
590 #  The MIN_CONFIG will be used for all builds of the bisect. The build type
591 #  used for bisecting is oldconfig.
593 #  The option BUILD_TYPE will be ignored.
595 #  BISECT_TYPE is the type of test to perform:
596 #       build   - bad fails to build
597 #       boot    - bad builds but fails to boot
598 #       test    - bad boots but fails a test
600 # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
601 # BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
603 # The above three options are required for a bisect operation.
605 # BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
607 #   If an operation failed in the bisect that was not expected to
608 #   fail. Then the test ends. The state of the BUILD_DIR will be
609 #   left off at where the failure occurred. You can examine the
610 #   reason for the failure, and perhaps even find a git commit
611 #   that would work to continue with. You can run:
613 #   git bisect log > /path/to/replay/file
615 #   The adding:
617 #    BISECT_REPLAY= /path/to/replay/file
619 #   And running the test again. The test will perform the initial
620 #    git bisect start, git bisect good, and git bisect bad, and
621 #    then it will run git bisect replay on this file, before
622 #    continuing with the bisect.
624 # BISECT_START = commit (optional, default undefined)
626 #   As with BISECT_REPLAY, if the test failed on a commit that
627 #   just happen to have a bad commit in the middle of the bisect,
628 #   and you need to skip it. If BISECT_START is defined, it
629 #   will checkout that commit after doing the initial git bisect start,
630 #   git bisect good, git bisect bad, and running the git bisect replay
631 #   if the BISECT_REPLAY is set.
633 # BISECT_SKIP = 1 (optional, default 0)
635 #   If BISECT_TYPE is set to test but the build fails, ktest will
636 #   simply fail the test and end their. You could use BISECT_REPLAY
637 #   and BISECT_START to resume after you found a new starting point,
638 #   or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
639 #   when something other than the BISECT_TYPE fails, ktest.pl will
640 #   run "git bisect skip" and try again.
642 # BISECT_FILES = <path> (optional, default undefined)
644 #   To just run the git bisect on a specific path, set BISECT_FILES.
645 #   For example:
647 #     BISECT_FILES = arch/x86 kernel/time
649 #   Will run the bisect with "git bisect start -- arch/x86 kernel/time"
651 # BISECT_REVERSE = 1 (optional, default 0)
653 #   In those strange instances where it was broken forever
654 #   and you are trying to find where it started to work!
655 #   Set BISECT_GOOD to the commit that was last known to fail
656 #   Set BISECT_BAD to the commit that is known to start working.
657 #   With BISECT_REVERSE = 1, The test will consider failures as
658 #   good, and success as bad.
660 # BISECT_MANUAL = 1 (optional, default 0)
662 #   In case there's a problem with automating the bisect for
663 #   whatever reason. (Can't reboot, want to inspect each iteration)
664 #   Doing a BISECT_MANUAL will have the test wait for you to
665 #   tell it if the test passed or failed after each iteration.
666 #   This is basicall the same as running git bisect yourself
667 #   but ktest will rebuild and install the kernel for you.
669 # BISECT_CHECK = 1 (optional, default 0)
671 #   Just to be sure the good is good and bad is bad, setting
672 #   BISECT_CHECK to 1 will start the bisect by first checking
673 #   out BISECT_BAD and makes sure it fails, then it will check
674 #   out BISECT_GOOD and makes sure it succeeds before starting
675 #   the bisect (it works for BISECT_REVERSE too).
677 #   You can limit the test to just check BISECT_GOOD or
678 #   BISECT_BAD with BISECT_CHECK = good or
679 #   BISECT_CHECK = bad, respectively.
681 # Example:
682 #   TEST_START
683 #   TEST_TYPE = bisect
684 #   BISECT_GOOD = v2.6.36
685 #   BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
686 #   BISECT_TYPE = build
687 #   MIN_CONFIG = /home/test/config-bisect
691 # For TEST_TYPE = config_bisect
693 #  In those cases that you have two different configs. One of them
694 #  work, the other does not, and you do not know what config causes
695 #  the problem.
696 #  The TEST_TYPE config_bisect will bisect the bad config looking for
697 #  what config causes the failure.
699 #  The way it works is this:
701 #   First it finds a config to work with. Since a different version, or
702 #   MIN_CONFIG may cause different dependecies, it must run through this
703 #   preparation.
705 #   Overwrites any config set in the bad config with a config set in
706 #   either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
707 #   are minimal and do not disable configs you want to test:
708 #   (ie.  # CONFIG_FOO is not set).
710 #   An oldconfig is run on the bad config and any new config that
711 #   appears will be added to the configs to test.
713 #   Finally, it generates a config with the above result and runs it
714 #   again through make oldconfig to produce a config that should be
715 #   satisfied by kconfig.
717 #   Then it starts the bisect.
719 #   The configs to test are cut in half. If all the configs in this
720 #   half depend on a config in the other half, then the other half
721 #   is tested instead. If no configs are enabled by either half, then
722 #   this means a circular dependency exists and the test fails.
724 #   A config is created with the test half, and the bisect test is run.
726 #   If the bisect succeeds, then all configs in the generated config
727 #   are removed from the configs to test and added to the configs that
728 #   will be enabled for all builds (they will be enabled, but not be part
729 #   of the configs to examine).
731 #   If the bisect fails, then all test configs that were not enabled by
732 #   the config file are removed from the test. These configs will not
733 #   be enabled in future tests. Since current config failed, we consider
734 #   this to be a subset of the config that we started with.
736 #   When we are down to one config, it is considered the bad config.
738 #   Note, the config chosen may not be the true bad config. Due to
739 #   dependencies and selections of the kbuild system, mulitple
740 #   configs may be needed to cause a failure. If you disable the
741 #   config that was found and restart the test, if the test fails
742 #   again, it is recommended to rerun the config_bisect with a new
743 #   bad config without the found config enabled.
745 #  The option BUILD_TYPE will be ignored.
747 #  CONFIG_BISECT_TYPE is the type of test to perform:
748 #       build   - bad fails to build
749 #       boot    - bad builds but fails to boot
750 #       test    - bad boots but fails a test
752 #  CONFIG_BISECT is the config that failed to boot
754 #  If BISECT_MANUAL is set, it will pause between iterations.
755 #  This is useful to use just ktest.pl just for the config bisect.
756 #  If you set it to build, it will run the bisect and you can
757 #  control what happens in between iterations. It will ask you if
758 #  the test succeeded or not and continue the config bisect.
760 # CONFIG_BISECT_GOOD (optional)
761 #  If you have a good config to start with, then you
762 #  can specify it with CONFIG_BISECT_GOOD. Otherwise
763 #  the MIN_CONFIG is the base.
765 # Example:
766 #   TEST_START
767 #   TEST_TYPE = config_bisect
768 #   CONFIG_BISECT_TYPE = build
769 #   CONFIG_BISECT = /home/test/Ā¢onfig-bad
770 #   MIN_CONFIG = /home/test/config-min
771 #   BISECT_MANUAL = 1