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:
16 # Test specific options are set after the label:
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
27 # TEST_START ITERATE 10
29 # You can skip a test by adding SKIP (before or after the ITERATE
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)
49 # MIN_CONFIG = /home/test/config-test1
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
63 # MIN_CONFIG = /home/test/config-use-sometimes
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.
75 # Both TEST_START and DEFAULTS sections can also have the IF keyword
76 # The value after the IF must evaluate into a 0 or non 0 positive
77 # integer, and can use the config variables (explained below).
79 # DEFAULTS IF ${IS_X86_32}
81 # The above will process the DEFAULTS section if the config
82 # variable IS_X86_32 evaluates to a non zero positive integer
83 # otherwise if it evaluates to zero, it will act the same
84 # as if the SKIP keyword was used.
86 # The ELSE keyword can be used directly after a section with
89 # TEST_START IF ${RUN_NET_TESTS}
90 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
94 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-normal
97 # The ELSE keyword can also contain an IF statement to allow multiple
98 # if then else sections. But all the sections must be either
99 # DEFAULT or TEST_START, they can not be a mixture.
101 # TEST_START IF ${RUN_NET_TESTS}
102 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
104 # ELSE IF ${RUN_DISK_TESTS}
105 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-tests
107 # ELSE IF ${RUN_CPU_TESTS}
108 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-cpu
111 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
114 #### Config variables ####
116 # This config file can also contain "config variables".
117 # These are assigned with ":=" instead of the ktest option
120 # The difference between ktest options and config variables
121 # is that config variables can be used multiple times,
122 # where each instance will override the previous instance.
123 # And that they only live at time of processing this config.
125 # The advantage to config variables are that they can be used
126 # by any option or any other config variables to define thing
127 # that you may use over and over again in the options.
133 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
136 # MIN_CONFIG = config1
137 # TEST = ${TEST_CASE}
140 # MIN_CONFIG = config2
141 # TEST = ${TEST_CASE}
143 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
146 # MIN_CONFIG = config1
147 # TEST = ${TEST_CASE}
150 # MIN_CONFIG = config2
151 # TEST = ${TEST_CASE}
153 # TEST_DIR := /home/me/test
155 # BUILD_DIR = ${TEST_DIR}/linux.git
156 # OUTPUT_DIR = ${TEST_DIR}/test
158 # Note, the config variables are evaluated immediately, thus
159 # updating TARGET after TEST_CASE has been assigned does nothing
162 # As shown in the example, to evaluate a config variable, you
163 # use the ${X} convention. Simple $X will not work.
165 # If the config variable does not exist, the ${X} will not
166 # be evaluated. Thus:
168 # MAKE_CMD = PATH=/mypath:${PATH} make
170 # If PATH is not a config variable, then the ${PATH} in
171 # the MAKE_CMD option will be evaluated by the shell when
172 # the MAKE_CMD option is passed into shell processing.
174 #### Using options in other options ####
176 # Options that are defined in the config file may also be used
177 # by other options. All options are evaulated at time of
178 # use (except that config variables are evaluated at config
181 # If an ktest option is used within another option, instead of
182 # typing it again in that option you can simply use the option
183 # just like you can config variables.
187 # TEST = ssh root@${MACHINE} /path/to/test
189 # The option will be used per test case. Thus:
192 # TEST = ssh root@{MACHINE}
200 # For both test cases, MACHINE will be evaluated at the time
201 # of the test case. The first test will run ssh root@box1
202 # and the second will run ssh root@box2.
204 #### Mandatory Default Options ####
206 # These options must be in the default section, although most
207 # may be overridden by test options.
209 # The machine hostname that you will test
212 # The box is expected to have ssh on normal bootup, provide the user
213 # (most likely root, since you need privileged operations)
216 # The directory that contains the Linux source code
217 #BUILD_DIR = /home/test/linux.git
219 # The directory that the objects will be built
220 # (can not be same as BUILD_DIR)
221 #OUTPUT_DIR = /home/test/build/target
223 # The location of the compiled file to copy to the target
224 # (relative to OUTPUT_DIR)
225 #BUILD_TARGET = arch/x86/boot/bzImage
227 # The place to put your image on the test machine
228 #TARGET_IMAGE = /boot/vmlinuz-test
230 # A script or command to reboot the box
232 # Here is a digital loggers power switch example
233 #POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
235 # Here is an example to reboot a virtual box on the current host
236 # with the name "Guest".
237 #POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
239 # The script or command that reads the console
241 # If you use ttywatch server, something like the following would work.
242 #CONSOLE = nc -d localhost 3001
244 # For a virtual machine with guest name "Guest".
245 #CONSOLE = virsh console Guest
247 # Required version ending to differentiate the test
248 # from other linux builds on the system.
249 #LOCALVERSION = -test
251 # The grub title name for the test kernel to boot
252 # (Only mandatory if REBOOT_TYPE = grub)
254 # Note, ktest.pl will not update the grub menu.lst, you need to
255 # manually add an option for the test. ktest.pl will search
256 # the grub menu.lst for this option to find what kernel to
259 # For example, if in the /boot/grub/menu.lst the test kernel title has:
261 # kernel vmlinuz-test
262 #GRUB_MENU = Test Kernel
264 # A script to reboot the target into the test kernel
265 # (Only mandatory if REBOOT_TYPE = script)
268 #### Optional Config Options (all have defaults) ####
270 # Start a test setup. If you leave this off, all options
271 # will be default and the test will run once.
272 # This is a label and not really an option (it takes no value).
273 # You can append ITERATE and a number after it to iterate the
274 # test a number of times, or SKIP to ignore this test.
277 #TEST_START ITERATE 5
280 # Have the following options as default again. Used after tests
281 # have already been defined by TEST_START. Optionally, you can
282 # just define all default options before the first TEST_START
283 # and you do not need this option.
285 # This is a label and not really an option (it takes no value).
286 # You can append SKIP to this label and the options within this
287 # section will be ignored.
292 # The default test type (default test)
293 # The test types may be:
294 # build - only build the kernel, do nothing else
295 # install - build and install, but do nothing else (does not reboot)
296 # boot - build, install, and boot the kernel
297 # test - build, boot and if TEST is set, run the test script
298 # (If TEST is not set, it defaults back to boot)
299 # bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
300 # patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
303 # Test to run if there is a successful boot and TEST_TYPE is test.
304 # Must exit with 0 on success and non zero on error
305 # default (undefined)
306 #TEST = ssh user@machine /root/run_test
308 # The build type is any make config type or special command
309 # (default randconfig)
310 # nobuild - skip the clean and build step
311 # useconfig:/path/to/config - use the given config and run
313 # This option is ignored if TEST_TYPE is patchcheck or bisect
314 #BUILD_TYPE = randconfig
316 # The make command (default make)
317 # If you are building a 32bit x86 on a 64 bit host
318 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
320 # Any build options for the make of the kernel (not for other makes, like configs)
322 #BUILD_OPTIONS = -j20
324 # If you need an initrd, you can add a script or code here to install
325 # it. The environment variable KERNEL_VERSION will be set to the
326 # kernel version that is used. Remember to add the initrd line
327 # to your grub menu.lst file.
329 # Here's a couple of examples to use:
330 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
332 # or on some systems:
333 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
335 # If for some reason you just want to boot the kernel and you do not
336 # want the test to install anything new. For example, you may just want
337 # to boot test the same kernel over and over and do not want to go through
338 # the hassle of installing anything, you can set this option to 1
342 # If there is a script that you require to run before the build is done
343 # you can specify it with PRE_BUILD.
345 # One example may be if you must add a temporary patch to the build to
346 # fix a unrelated bug to perform a patchcheck test. This will apply the
347 # patch before each build that is made. Use the POST_BUILD to do a git reset --hard
348 # to remove the patch.
351 #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
353 # To specify if the test should fail if the PRE_BUILD fails,
354 # PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
359 # If there is a script that should run after the build is done
360 # you can specify it with POST_BUILD.
362 # As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
363 # made by the PRE_BUILD.
366 #POST_BUILD = cd ${BUILD_DIR} && git reset --hard
368 # To specify if the test should fail if the POST_BUILD fails,
369 # POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
374 # Way to reboot the box to the test kernel.
375 # Only valid options so far are "grub" and "script"
377 # If you specify grub, it will assume grub version 1
378 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
379 # and select that target to reboot to the kernel. If this is not
380 # your setup, then specify "script" and have a command or script
381 # specified in REBOOT_SCRIPT to boot to the target.
383 # The entry in /boot/grub/menu.lst must be entered in manually.
384 # The test will not modify that file.
387 # The min config that is needed to build for the machine
388 # A nice way to create this is with the following:
392 # $ scp mymods host:/tmp
396 # $ make LSMOD=mymods localyesconfig
397 # $ grep '^CONFIG' .config > /home/test/config-min
399 # If you want even less configs:
401 # log in directly to target (do not ssh)
404 # # lsmod | cut -d' ' -f1 | xargs rmmod
406 # repeat the above several times
411 # May need to reboot to get your network back to copy the mymods
412 # to the host, and then remove the previous .config and run the
413 # localyesconfig again. The CONFIG_MIN generated like this will
414 # not guarantee network activity to the box so the TEST_TYPE of
417 # You might also want to set:
418 # CONFIG_CMDLINE="<your options here>"
419 # randconfig may set the above and override your real command
421 # (default undefined)
422 #MIN_CONFIG = /home/test/config-min
424 # Sometimes there's options that just break the boot and
425 # you do not care about. Here are a few:
426 # # CONFIG_STAGING is not set
427 # Staging drivers are horrible, and can break the build.
428 # # CONFIG_SCSI_DEBUG is not set
429 # SCSI_DEBUG may change your root partition
430 # # CONFIG_KGDB_SERIAL_CONSOLE is not set
431 # KGDB may cause oops waiting for a connection that's not there.
432 # This option points to the file containing config options that will be prepended
433 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
435 # Note, config options in MIN_CONFIG will override these options.
437 # (default undefined)
438 #ADD_CONFIG = /home/test/config-broken
440 # The location on the host where to write temp files
441 # (default /tmp/ktest/${MACHINE})
442 #TMP_DIR = /tmp/ktest/${MACHINE}
444 # Optional log file to write the status (recommended)
445 # Note, this is a DEFAULT section only option.
446 # (default undefined)
447 #LOG_FILE = /home/test/logfiles/target.log
449 # Remove old logfile if it exists before starting all tests.
450 # Note, this is a DEFAULT section only option.
454 # Line to define a successful boot up in console output.
455 # This is what the line contains, not the entire line. If you need
456 # the entire line to match, then use regural expression syntax like:
457 # (do not add any quotes around it)
459 # SUCCESS_LINE = ^MyBox Login:$
462 #SUCCESS_LINE = login:
464 # To speed up between reboots, defining a line that the
465 # default kernel produces that represents that the default
466 # kernel has successfully booted and can be used to pass
467 # a new test kernel to it. Otherwise ktest.pl will wait till
468 # SLEEP_TIME to continue.
469 # (default undefined)
470 #REBOOT_SUCCESS_LINE = login:
472 # In case the console constantly fills the screen, having
473 # a specified time to stop the test after success is recommended.
476 #STOP_AFTER_SUCCESS = 10
478 # In case the console constantly fills the screen, having
479 # a specified time to stop the test after failure is recommended.
482 #STOP_AFTER_FAILURE = 60
484 # In case the console constantly fills the screen, having
485 # a specified time to stop the test if it never succeeds nor fails
487 # Note: this is ignored if a success or failure is detected.
489 # (default 600, -1 is to never stop)
490 #STOP_TEST_AFTER = 600
492 # Stop testing if a build fails. If set, the script will end if
493 # a failure is detected, otherwise it will save off the .config,
494 # dmesg and bootlog in a directory called
495 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
496 # if the STORE_FAILURES directory is set.
498 # Note, even if this is set to zero, there are some errors that still
502 # Directory to store failure directories on failure. If this is not
503 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
504 # bootlog. This option is ignored if DIE_ON_FAILURE is not set.
505 # (default undefined)
506 #STORE_FAILURES = /home/test/failures
508 # Build without doing a make mrproper, or removing .config
512 # As the test reads the console, after it hits the SUCCESS_LINE
513 # the time it waits for the monitor to settle down between reads
514 # can usually be lowered.
515 # (in seconds) (default 1)
518 # The timeout in seconds when we consider the box hung after
519 # the console stop producing output. Be sure to leave enough
520 # time here to get pass a reboot. Some machines may not produce
521 # any console output for a long time during a reboot. You do
522 # not want the test to fail just because the system was in
523 # the process of rebooting to the test kernel.
527 # In between tests, a reboot of the box may occur, and this
528 # is the time to wait for the console after it stops producing
529 # output. Some machines may not produce a large lag on reboot
530 # so this should accommodate it.
531 # The difference between this and TIMEOUT, is that TIMEOUT happens
532 # when rebooting to the test kernel. This sleep time happens
533 # after a test has completed and we are about to start running
534 # another test. If a reboot to the reliable kernel happens,
535 # we wait SLEEP_TIME for the console to stop producing output
536 # before starting the next test.
538 # You can speed up reboot times even more by setting REBOOT_SUCCESS_LINE.
542 # The time in between bisects to sleep (in seconds)
544 #BISECT_SLEEP_TIME = 60
546 # The time in between patch checks to sleep (in seconds)
548 #PATCHCHECK_SLEEP_TIME = 60
550 # Reboot the target box on error (default 0)
553 # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
554 # Note, this is a DEFAULT section only option.
556 #POWEROFF_ON_ERROR = 0
558 # Power off the target after all tests have completed successfully
559 # Note, this is a DEFAULT section only option.
561 #POWEROFF_ON_SUCCESS = 0
563 # Reboot the target after all test completed successfully (default 1)
564 # (ignored if POWEROFF_ON_SUCCESS is set)
565 #REBOOT_ON_SUCCESS = 1
567 # In case there are isses with rebooting, you can specify this
568 # to always powercycle after this amount of time after calling
570 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
571 # makes it powercycle immediately after rebooting. Do not define
572 # it if you do not want it.
573 # (default undefined)
574 #POWERCYCLE_AFTER_REBOOT = 5
576 # In case there's isses with halting, you can specify this
577 # to always poweroff after this amount of time after calling
579 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
580 # makes it poweroff immediately after halting. Do not define
581 # it if you do not want it.
582 # (default undefined)
583 #POWEROFF_AFTER_HALT = 20
585 # A script or command to power off the box (default undefined)
586 # Needed for POWEROFF_ON_ERROR and SUCCESS
588 # Example for digital loggers power switch:
589 #POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
591 # Example for a virtual guest call "Guest".
592 #POWER_OFF = virsh destroy Guest
594 # The way to execute a command on the target
595 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
596 # The variables SSH_USER, MACHINE and SSH_COMMAND are defined
597 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
599 # The way to copy a file to the target
600 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
601 # The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
602 #SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
604 # The nice way to reboot the target
605 # (default ssh $SSH_USER@$MACHINE reboot)
606 # The variables SSH_USER and MACHINE are defined.
607 #REBOOT = ssh $SSH_USER@$MACHINE reboot
609 # The way triple faults are detected is by testing the kernel
610 # banner. If the kernel banner for the kernel we are testing is
611 # found, and then later a kernel banner for another kernel version
612 # is found, it is considered that we encountered a triple fault,
613 # and there is no panic or callback, but simply a reboot.
614 # To disable this (because it did a false positive) set the following
617 #DETECT_TRIPLE_FAULT = 0
619 #### Per test run options ####
620 # The following options are only allowed in TEST_START sections.
621 # They are ignored in the DEFAULTS sections.
623 # All of these are optional and undefined by default, although
624 # some of these options are required for TEST_TYPE of patchcheck
630 # If the BUILD_DIR is a git repository, then you can set this option
631 # to checkout the given branch before running the TEST. If you
632 # specify this for the first run, that branch will be used for
633 # all preceding tests until a new CHECKOUT is set.
638 # If you want the test to have a name that is displayed in
639 # the test result banner at the end of the test, then use this
640 # option. This is useful to search for the RESULT keyword and
641 # not have to translate a test number to a test in the config.
643 # For TEST_TYPE = patchcheck
645 # This expects the BUILD_DIR to be a git repository, and
646 # will checkout the PATCHCHECK_START commit.
648 # The option BUILD_TYPE will be ignored.
650 # The MIN_CONFIG will be used for all builds of the patchcheck. The build type
651 # used for patchcheck is oldconfig.
653 # PATCHCHECK_START is required and is the first patch to
654 # test (the SHA1 of the commit). You may also specify anything
655 # that git checkout allows (branch name, tage, HEAD~3).
657 # PATCHCHECK_END is the last patch to check (default HEAD)
659 # PATCHCHECK_TYPE is required and is the type of test to run:
662 # Note, the build test will look for warnings, if a warning occurred
663 # in a file that a commit touches, the build will fail, unless
664 # IGNORE_WARNINGS is set for the given commit's sha1
666 # IGNORE_WARNINGS can be used to disable the failure of patchcheck
667 # on a particuler commit (SHA1). You can add more than one commit
668 # by adding a list of SHA1s that are space delimited.
670 # If BUILD_NOCLEAN is set, then make mrproper will not be run on
671 # any of the builds, just like all other TEST_TYPE tests. But
672 # what makes patchcheck different from the other tests, is if
673 # BUILD_NOCLEAN is not set, only the first and last patch run
674 # make mrproper. This helps speed up the test.
678 # TEST_TYPE = patchcheck
679 # CHECKOUT = mybranch
680 # PATCHCHECK_TYPE = boot
681 # PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
682 # PATCHCHECK_END = HEAD~2
683 # IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
687 # For TEST_TYPE = bisect
689 # You can specify a git bisect if the BUILD_DIR is a git repository.
690 # The MIN_CONFIG will be used for all builds of the bisect. The build type
691 # used for bisecting is oldconfig.
693 # The option BUILD_TYPE will be ignored.
695 # BISECT_TYPE is the type of test to perform:
696 # build - bad fails to build
697 # boot - bad builds but fails to boot
698 # test - bad boots but fails a test
700 # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
701 # BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
703 # The above three options are required for a bisect operation.
705 # BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
707 # If an operation failed in the bisect that was not expected to
708 # fail. Then the test ends. The state of the BUILD_DIR will be
709 # left off at where the failure occurred. You can examine the
710 # reason for the failure, and perhaps even find a git commit
711 # that would work to continue with. You can run:
713 # git bisect log > /path/to/replay/file
717 # BISECT_REPLAY= /path/to/replay/file
719 # And running the test again. The test will perform the initial
720 # git bisect start, git bisect good, and git bisect bad, and
721 # then it will run git bisect replay on this file, before
722 # continuing with the bisect.
724 # BISECT_START = commit (optional, default undefined)
726 # As with BISECT_REPLAY, if the test failed on a commit that
727 # just happen to have a bad commit in the middle of the bisect,
728 # and you need to skip it. If BISECT_START is defined, it
729 # will checkout that commit after doing the initial git bisect start,
730 # git bisect good, git bisect bad, and running the git bisect replay
731 # if the BISECT_REPLAY is set.
733 # BISECT_SKIP = 1 (optional, default 0)
735 # If BISECT_TYPE is set to test but the build fails, ktest will
736 # simply fail the test and end their. You could use BISECT_REPLAY
737 # and BISECT_START to resume after you found a new starting point,
738 # or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
739 # when something other than the BISECT_TYPE fails, ktest.pl will
740 # run "git bisect skip" and try again.
742 # BISECT_FILES = <path> (optional, default undefined)
744 # To just run the git bisect on a specific path, set BISECT_FILES.
747 # BISECT_FILES = arch/x86 kernel/time
749 # Will run the bisect with "git bisect start -- arch/x86 kernel/time"
751 # BISECT_REVERSE = 1 (optional, default 0)
753 # In those strange instances where it was broken forever
754 # and you are trying to find where it started to work!
755 # Set BISECT_GOOD to the commit that was last known to fail
756 # Set BISECT_BAD to the commit that is known to start working.
757 # With BISECT_REVERSE = 1, The test will consider failures as
758 # good, and success as bad.
760 # BISECT_MANUAL = 1 (optional, default 0)
762 # In case there's a problem with automating the bisect for
763 # whatever reason. (Can't reboot, want to inspect each iteration)
764 # Doing a BISECT_MANUAL will have the test wait for you to
765 # tell it if the test passed or failed after each iteration.
766 # This is basicall the same as running git bisect yourself
767 # but ktest will rebuild and install the kernel for you.
769 # BISECT_CHECK = 1 (optional, default 0)
771 # Just to be sure the good is good and bad is bad, setting
772 # BISECT_CHECK to 1 will start the bisect by first checking
773 # out BISECT_BAD and makes sure it fails, then it will check
774 # out BISECT_GOOD and makes sure it succeeds before starting
775 # the bisect (it works for BISECT_REVERSE too).
777 # You can limit the test to just check BISECT_GOOD or
778 # BISECT_BAD with BISECT_CHECK = good or
779 # BISECT_CHECK = bad, respectively.
784 # BISECT_GOOD = v2.6.36
785 # BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
786 # BISECT_TYPE = build
787 # MIN_CONFIG = /home/test/config-bisect
791 # For TEST_TYPE = config_bisect
793 # In those cases that you have two different configs. One of them
794 # work, the other does not, and you do not know what config causes
796 # The TEST_TYPE config_bisect will bisect the bad config looking for
797 # what config causes the failure.
799 # The way it works is this:
801 # First it finds a config to work with. Since a different version, or
802 # MIN_CONFIG may cause different dependecies, it must run through this
805 # Overwrites any config set in the bad config with a config set in
806 # either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
807 # are minimal and do not disable configs you want to test:
808 # (ie. # CONFIG_FOO is not set).
810 # An oldconfig is run on the bad config and any new config that
811 # appears will be added to the configs to test.
813 # Finally, it generates a config with the above result and runs it
814 # again through make oldconfig to produce a config that should be
815 # satisfied by kconfig.
817 # Then it starts the bisect.
819 # The configs to test are cut in half. If all the configs in this
820 # half depend on a config in the other half, then the other half
821 # is tested instead. If no configs are enabled by either half, then
822 # this means a circular dependency exists and the test fails.
824 # A config is created with the test half, and the bisect test is run.
826 # If the bisect succeeds, then all configs in the generated config
827 # are removed from the configs to test and added to the configs that
828 # will be enabled for all builds (they will be enabled, but not be part
829 # of the configs to examine).
831 # If the bisect fails, then all test configs that were not enabled by
832 # the config file are removed from the test. These configs will not
833 # be enabled in future tests. Since current config failed, we consider
834 # this to be a subset of the config that we started with.
836 # When we are down to one config, it is considered the bad config.
838 # Note, the config chosen may not be the true bad config. Due to
839 # dependencies and selections of the kbuild system, mulitple
840 # configs may be needed to cause a failure. If you disable the
841 # config that was found and restart the test, if the test fails
842 # again, it is recommended to rerun the config_bisect with a new
843 # bad config without the found config enabled.
845 # The option BUILD_TYPE will be ignored.
847 # CONFIG_BISECT_TYPE is the type of test to perform:
848 # build - bad fails to build
849 # boot - bad builds but fails to boot
850 # test - bad boots but fails a test
852 # CONFIG_BISECT is the config that failed to boot
854 # If BISECT_MANUAL is set, it will pause between iterations.
855 # This is useful to use just ktest.pl just for the config bisect.
856 # If you set it to build, it will run the bisect and you can
857 # control what happens in between iterations. It will ask you if
858 # the test succeeded or not and continue the config bisect.
860 # CONFIG_BISECT_GOOD (optional)
861 # If you have a good config to start with, then you
862 # can specify it with CONFIG_BISECT_GOOD. Otherwise
863 # the MIN_CONFIG is the base.
867 # TEST_TYPE = config_bisect
868 # CONFIG_BISECT_TYPE = build
869 # CONFIG_BISECT = /home/test/Ā¢onfig-bad
870 # MIN_CONFIG = /home/test/config-min
875 # For TEST_TYPE = make_min_config
877 # After doing a make localyesconfig, your kernel configuration may
878 # not be the most useful minimum configuration. Having a true minimum
879 # config that you can use against other configs is very useful if
880 # someone else has a config that breaks on your code. By only forcing
881 # those configurations that are truly required to boot your machine
882 # will give you less of a chance that one of your set configurations
883 # will make the bug go away. This will give you a better chance to
884 # be able to reproduce the reported bug matching the broken config.
886 # Note, this does take some time, and may require you to run the
887 # test over night, or perhaps over the weekend. But it also allows
888 # you to interrupt it, and gives you the current minimum config
889 # that was found till that time.
891 # Note, this test automatically assumes a BUILD_TYPE of oldconfig
892 # and its test type acts like boot.
893 # TODO: add a test version that makes the config do more than just
894 # boot, like having network access.
896 # To save time, the test does not just grab any option and test
897 # it. The Kconfig files are examined to determine the dependencies
898 # of the configs. If a config is chosen that depends on another
899 # config, that config will be checked first. By checking the
900 # parents first, we can eliminate whole groups of configs that
901 # may have been enabled.
903 # For example, if a USB device config is chosen and depends on CONFIG_USB,
904 # the CONFIG_USB will be tested before the device. If CONFIG_USB is
905 # found not to be needed, it, as well as all configs that depend on
906 # it, will be disabled and removed from the current min_config.
908 # OUTPUT_MIN_CONFIG is the path and filename of the file that will
909 # be created from the MIN_CONFIG. If you interrupt the test, set
910 # this file as your new min config, and use it to continue the test.
911 # This file does not need to exist on start of test.
912 # This file is not created until a config is found that can be removed.
913 # If this file exists, you will be prompted if you want to use it
914 # as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG
918 # START_MIN_CONFIG is the config to use to start the test with.
919 # you can set this as the same OUTPUT_MIN_CONFIG, but if you do
920 # the OUTPUT_MIN_CONFIG file must exist.
921 # (default MIN_CONFIG)
923 # IGNORE_CONFIG is used to specify a config file that has configs that
924 # you already know must be set. Configs are written here that have
925 # been tested and proved to be required. It is best to define this
926 # file if you intend on interrupting the test and running it where
927 # it left off. New configs that it finds will be written to this file
928 # and will not be tested again in later runs.
933 # TEST_TYPE = make_min_config
934 # OUTPUT_MIN_CONFIG = /path/to/config-new-min
935 # START_MIN_CONFIG = /path/to/config-min
936 # IGNORE_CONFIG = /path/to/config-tested