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.
76 #### Config variables ####
78 # This config file can also contain "config variables".
79 # These are assigned with ":=" instead of the ktest option
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.
95 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
98 # MIN_CONFIG = config1
102 # MIN_CONFIG = config2
103 # TEST = ${TEST_CASE}
105 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
108 # MIN_CONFIG = config1
109 # TEST = ${TEST_CASE}
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
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
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.
149 # TEST = ssh root@${MACHINE} /path/to/test
151 # The option will be used per test case. Thus:
154 # TEST = ssh root@{MACHINE}
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
174 # The box is expected to have ssh on normal bootup, provide the user
175 # (most likely root, since you need privileged operations)
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
221 # For example, if in the /boot/grub/menu.lst the test kernel title has:
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)
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.
239 #TEST_START ITERATE 5
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.
254 # The default test type (default test)
255 # The test types may be:
256 # build - only build the kernel, do nothing else
257 # install - build and install, but do nothing else (does not reboot)
258 # boot - build, install, and boot the kernel
259 # test - build, boot and if TEST is set, run the test script
260 # (If TEST is not set, it defaults back to boot)
261 # bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
262 # patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
265 # Test to run if there is a successful boot and TEST_TYPE is test.
266 # Must exit with 0 on success and non zero on error
267 # default (undefined)
268 #TEST = ssh user@machine /root/run_test
270 # The build type is any make config type or special command
271 # (default randconfig)
272 # nobuild - skip the clean and build step
273 # useconfig:/path/to/config - use the given config and run
275 # This option is ignored if TEST_TYPE is patchcheck or bisect
276 #BUILD_TYPE = randconfig
278 # The make command (default make)
279 # If you are building a 32bit x86 on a 64 bit host
280 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
282 # Any build options for the make of the kernel (not for other makes, like configs)
284 #BUILD_OPTIONS = -j20
286 # If you need an initrd, you can add a script or code here to install
287 # it. The environment variable KERNEL_VERSION will be set to the
288 # kernel version that is used. Remember to add the initrd line
289 # to your grub menu.lst file.
291 # Here's a couple of examples to use:
292 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
294 # or on some systems:
295 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
297 # If there is a script that you require to run before the build is done
298 # you can specify it with PRE_BUILD.
300 # One example may be if you must add a temporary patch to the build to
301 # fix a unrelated bug to perform a patchcheck test. This will apply the
302 # patch before each build that is made. Use the POST_BUILD to do a git reset --hard
303 # to remove the patch.
306 #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
308 # To specify if the test should fail if the PRE_BUILD fails,
309 # PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
314 # If there is a script that should run after the build is done
315 # you can specify it with POST_BUILD.
317 # As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
318 # made by the PRE_BUILD.
321 #POST_BUILD = cd ${BUILD_DIR} && git reset --hard
323 # To specify if the test should fail if the POST_BUILD fails,
324 # POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
329 # Way to reboot the box to the test kernel.
330 # Only valid options so far are "grub" and "script"
332 # If you specify grub, it will assume grub version 1
333 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
334 # and select that target to reboot to the kernel. If this is not
335 # your setup, then specify "script" and have a command or script
336 # specified in REBOOT_SCRIPT to boot to the target.
338 # The entry in /boot/grub/menu.lst must be entered in manually.
339 # The test will not modify that file.
342 # The min config that is needed to build for the machine
343 # A nice way to create this is with the following:
347 # $ scp mymods host:/tmp
351 # $ make LSMOD=mymods localyesconfig
352 # $ grep '^CONFIG' .config > /home/test/config-min
354 # If you want even less configs:
356 # log in directly to target (do not ssh)
359 # # lsmod | cut -d' ' -f1 | xargs rmmod
361 # repeat the above several times
366 # May need to reboot to get your network back to copy the mymods
367 # to the host, and then remove the previous .config and run the
368 # localyesconfig again. The CONFIG_MIN generated like this will
369 # not guarantee network activity to the box so the TEST_TYPE of
372 # You might also want to set:
373 # CONFIG_CMDLINE="<your options here>"
374 # randconfig may set the above and override your real command
376 # (default undefined)
377 #MIN_CONFIG = /home/test/config-min
379 # Sometimes there's options that just break the boot and
380 # you do not care about. Here are a few:
381 # # CONFIG_STAGING is not set
382 # Staging drivers are horrible, and can break the build.
383 # # CONFIG_SCSI_DEBUG is not set
384 # SCSI_DEBUG may change your root partition
385 # # CONFIG_KGDB_SERIAL_CONSOLE is not set
386 # KGDB may cause oops waiting for a connection that's not there.
387 # This option points to the file containing config options that will be prepended
388 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
390 # Note, config options in MIN_CONFIG will override these options.
392 # (default undefined)
393 #ADD_CONFIG = /home/test/config-broken
395 # The location on the host where to write temp files
396 # (default /tmp/ktest/${MACHINE})
397 #TMP_DIR = /tmp/ktest/${MACHINE}
399 # Optional log file to write the status (recommended)
400 # Note, this is a DEFAULT section only option.
401 # (default undefined)
402 #LOG_FILE = /home/test/logfiles/target.log
404 # Remove old logfile if it exists before starting all tests.
405 # Note, this is a DEFAULT section only option.
409 # Line to define a successful boot up in console output.
410 # This is what the line contains, not the entire line. If you need
411 # the entire line to match, then use regural expression syntax like:
412 # (do not add any quotes around it)
414 # SUCCESS_LINE = ^MyBox Login:$
417 #SUCCESS_LINE = login:
419 # In case the console constantly fills the screen, having
420 # a specified time to stop the test after success is recommended.
423 #STOP_AFTER_SUCCESS = 10
425 # In case the console constantly fills the screen, having
426 # a specified time to stop the test after failure is recommended.
429 #STOP_AFTER_FAILURE = 60
431 # In case the console constantly fills the screen, having
432 # a specified time to stop the test if it never succeeds nor fails
434 # Note: this is ignored if a success or failure is detected.
436 # (default 600, -1 is to never stop)
437 #STOP_TEST_AFTER = 600
439 # Stop testing if a build fails. If set, the script will end if
440 # a failure is detected, otherwise it will save off the .config,
441 # dmesg and bootlog in a directory called
442 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
443 # if the STORE_FAILURES directory is set.
445 # Note, even if this is set to zero, there are some errors that still
449 # Directory to store failure directories on failure. If this is not
450 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
451 # bootlog. This option is ignored if DIE_ON_FAILURE is not set.
452 # (default undefined)
453 #STORE_FAILURES = /home/test/failures
455 # Build without doing a make mrproper, or removing .config
459 # As the test reads the console, after it hits the SUCCESS_LINE
460 # the time it waits for the monitor to settle down between reads
461 # can usually be lowered.
462 # (in seconds) (default 1)
465 # The timeout in seconds when we consider the box hung after
466 # the console stop producing output. Be sure to leave enough
467 # time here to get pass a reboot. Some machines may not produce
468 # any console output for a long time during a reboot. You do
469 # not want the test to fail just because the system was in
470 # the process of rebooting to the test kernel.
474 # In between tests, a reboot of the box may occur, and this
475 # is the time to wait for the console after it stops producing
476 # output. Some machines may not produce a large lag on reboot
477 # so this should accommodate it.
478 # The difference between this and TIMEOUT, is that TIMEOUT happens
479 # when rebooting to the test kernel. This sleep time happens
480 # after a test has completed and we are about to start running
481 # another test. If a reboot to the reliable kernel happens,
482 # we wait SLEEP_TIME for the console to stop producing output
483 # before starting the next test.
487 # The time in between bisects to sleep (in seconds)
489 #BISECT_SLEEP_TIME = 60
491 # The time in between patch checks to sleep (in seconds)
493 #PATCHCHECK_SLEEP_TIME = 60
495 # Reboot the target box on error (default 0)
498 # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
499 # Note, this is a DEFAULT section only option.
501 #POWEROFF_ON_ERROR = 0
503 # Power off the target after all tests have completed successfully
504 # Note, this is a DEFAULT section only option.
506 #POWEROFF_ON_SUCCESS = 0
508 # Reboot the target after all test completed successfully (default 1)
509 # (ignored if POWEROFF_ON_SUCCESS is set)
510 #REBOOT_ON_SUCCESS = 1
512 # In case there are isses with rebooting, you can specify this
513 # to always powercycle after this amount of time after calling
515 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
516 # makes it powercycle immediately after rebooting. Do not define
517 # it if you do not want it.
518 # (default undefined)
519 #POWERCYCLE_AFTER_REBOOT = 5
521 # In case there's isses with halting, you can specify this
522 # to always poweroff after this amount of time after calling
524 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
525 # makes it poweroff immediately after halting. Do not define
526 # it if you do not want it.
527 # (default undefined)
528 #POWEROFF_AFTER_HALT = 20
530 # A script or command to power off the box (default undefined)
531 # Needed for POWEROFF_ON_ERROR and SUCCESS
533 # Example for digital loggers power switch:
534 #POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
536 # Example for a virtual guest call "Guest".
537 #POWER_OFF = virsh destroy Guest
539 # The way to execute a command on the target
540 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
541 # The variables SSH_USER, MACHINE and SSH_COMMAND are defined
542 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
544 # The way to copy a file to the target
545 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
546 # The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
547 #SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
549 # The nice way to reboot the target
550 # (default ssh $SSH_USER@$MACHINE reboot)
551 # The variables SSH_USER and MACHINE are defined.
552 #REBOOT = ssh $SSH_USER@$MACHINE reboot
554 # The way triple faults are detected is by testing the kernel
555 # banner. If the kernel banner for the kernel we are testing is
556 # found, and then later a kernel banner for another kernel version
557 # is found, it is considered that we encountered a triple fault,
558 # and there is no panic or callback, but simply a reboot.
559 # To disable this (because it did a false positive) set the following
562 #DETECT_TRIPLE_FAULT = 0
564 #### Per test run options ####
565 # The following options are only allowed in TEST_START sections.
566 # They are ignored in the DEFAULTS sections.
568 # All of these are optional and undefined by default, although
569 # some of these options are required for TEST_TYPE of patchcheck
575 # If the BUILD_DIR is a git repository, then you can set this option
576 # to checkout the given branch before running the TEST. If you
577 # specify this for the first run, that branch will be used for
578 # all preceding tests until a new CHECKOUT is set.
583 # If you want the test to have a name that is displayed in
584 # the test result banner at the end of the test, then use this
585 # option. This is useful to search for the RESULT keyword and
586 # not have to translate a test number to a test in the config.
588 # For TEST_TYPE = patchcheck
590 # This expects the BUILD_DIR to be a git repository, and
591 # will checkout the PATCHCHECK_START commit.
593 # The option BUILD_TYPE will be ignored.
595 # The MIN_CONFIG will be used for all builds of the patchcheck. The build type
596 # used for patchcheck is oldconfig.
598 # PATCHCHECK_START is required and is the first patch to
599 # test (the SHA1 of the commit). You may also specify anything
600 # that git checkout allows (branch name, tage, HEAD~3).
602 # PATCHCHECK_END is the last patch to check (default HEAD)
604 # PATCHCHECK_TYPE is required and is the type of test to run:
607 # Note, the build test will look for warnings, if a warning occurred
608 # in a file that a commit touches, the build will fail, unless
609 # IGNORE_WARNINGS is set for the given commit's sha1
611 # IGNORE_WARNINGS can be used to disable the failure of patchcheck
612 # on a particuler commit (SHA1). You can add more than one commit
613 # by adding a list of SHA1s that are space delimited.
615 # If BUILD_NOCLEAN is set, then make mrproper will not be run on
616 # any of the builds, just like all other TEST_TYPE tests. But
617 # what makes patchcheck different from the other tests, is if
618 # BUILD_NOCLEAN is not set, only the first and last patch run
619 # make mrproper. This helps speed up the test.
623 # TEST_TYPE = patchcheck
624 # CHECKOUT = mybranch
625 # PATCHCHECK_TYPE = boot
626 # PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
627 # PATCHCHECK_END = HEAD~2
628 # IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
632 # For TEST_TYPE = bisect
634 # You can specify a git bisect if the BUILD_DIR is a git repository.
635 # The MIN_CONFIG will be used for all builds of the bisect. The build type
636 # used for bisecting is oldconfig.
638 # The option BUILD_TYPE will be ignored.
640 # BISECT_TYPE is the type of test to perform:
641 # build - bad fails to build
642 # boot - bad builds but fails to boot
643 # test - bad boots but fails a test
645 # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
646 # BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
648 # The above three options are required for a bisect operation.
650 # BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
652 # If an operation failed in the bisect that was not expected to
653 # fail. Then the test ends. The state of the BUILD_DIR will be
654 # left off at where the failure occurred. You can examine the
655 # reason for the failure, and perhaps even find a git commit
656 # that would work to continue with. You can run:
658 # git bisect log > /path/to/replay/file
662 # BISECT_REPLAY= /path/to/replay/file
664 # And running the test again. The test will perform the initial
665 # git bisect start, git bisect good, and git bisect bad, and
666 # then it will run git bisect replay on this file, before
667 # continuing with the bisect.
669 # BISECT_START = commit (optional, default undefined)
671 # As with BISECT_REPLAY, if the test failed on a commit that
672 # just happen to have a bad commit in the middle of the bisect,
673 # and you need to skip it. If BISECT_START is defined, it
674 # will checkout that commit after doing the initial git bisect start,
675 # git bisect good, git bisect bad, and running the git bisect replay
676 # if the BISECT_REPLAY is set.
678 # BISECT_SKIP = 1 (optional, default 0)
680 # If BISECT_TYPE is set to test but the build fails, ktest will
681 # simply fail the test and end their. You could use BISECT_REPLAY
682 # and BISECT_START to resume after you found a new starting point,
683 # or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
684 # when something other than the BISECT_TYPE fails, ktest.pl will
685 # run "git bisect skip" and try again.
687 # BISECT_FILES = <path> (optional, default undefined)
689 # To just run the git bisect on a specific path, set BISECT_FILES.
692 # BISECT_FILES = arch/x86 kernel/time
694 # Will run the bisect with "git bisect start -- arch/x86 kernel/time"
696 # BISECT_REVERSE = 1 (optional, default 0)
698 # In those strange instances where it was broken forever
699 # and you are trying to find where it started to work!
700 # Set BISECT_GOOD to the commit that was last known to fail
701 # Set BISECT_BAD to the commit that is known to start working.
702 # With BISECT_REVERSE = 1, The test will consider failures as
703 # good, and success as bad.
705 # BISECT_MANUAL = 1 (optional, default 0)
707 # In case there's a problem with automating the bisect for
708 # whatever reason. (Can't reboot, want to inspect each iteration)
709 # Doing a BISECT_MANUAL will have the test wait for you to
710 # tell it if the test passed or failed after each iteration.
711 # This is basicall the same as running git bisect yourself
712 # but ktest will rebuild and install the kernel for you.
714 # BISECT_CHECK = 1 (optional, default 0)
716 # Just to be sure the good is good and bad is bad, setting
717 # BISECT_CHECK to 1 will start the bisect by first checking
718 # out BISECT_BAD and makes sure it fails, then it will check
719 # out BISECT_GOOD and makes sure it succeeds before starting
720 # the bisect (it works for BISECT_REVERSE too).
722 # You can limit the test to just check BISECT_GOOD or
723 # BISECT_BAD with BISECT_CHECK = good or
724 # BISECT_CHECK = bad, respectively.
729 # BISECT_GOOD = v2.6.36
730 # BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
731 # BISECT_TYPE = build
732 # MIN_CONFIG = /home/test/config-bisect
736 # For TEST_TYPE = config_bisect
738 # In those cases that you have two different configs. One of them
739 # work, the other does not, and you do not know what config causes
741 # The TEST_TYPE config_bisect will bisect the bad config looking for
742 # what config causes the failure.
744 # The way it works is this:
746 # First it finds a config to work with. Since a different version, or
747 # MIN_CONFIG may cause different dependecies, it must run through this
750 # Overwrites any config set in the bad config with a config set in
751 # either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
752 # are minimal and do not disable configs you want to test:
753 # (ie. # CONFIG_FOO is not set).
755 # An oldconfig is run on the bad config and any new config that
756 # appears will be added to the configs to test.
758 # Finally, it generates a config with the above result and runs it
759 # again through make oldconfig to produce a config that should be
760 # satisfied by kconfig.
762 # Then it starts the bisect.
764 # The configs to test are cut in half. If all the configs in this
765 # half depend on a config in the other half, then the other half
766 # is tested instead. If no configs are enabled by either half, then
767 # this means a circular dependency exists and the test fails.
769 # A config is created with the test half, and the bisect test is run.
771 # If the bisect succeeds, then all configs in the generated config
772 # are removed from the configs to test and added to the configs that
773 # will be enabled for all builds (they will be enabled, but not be part
774 # of the configs to examine).
776 # If the bisect fails, then all test configs that were not enabled by
777 # the config file are removed from the test. These configs will not
778 # be enabled in future tests. Since current config failed, we consider
779 # this to be a subset of the config that we started with.
781 # When we are down to one config, it is considered the bad config.
783 # Note, the config chosen may not be the true bad config. Due to
784 # dependencies and selections of the kbuild system, mulitple
785 # configs may be needed to cause a failure. If you disable the
786 # config that was found and restart the test, if the test fails
787 # again, it is recommended to rerun the config_bisect with a new
788 # bad config without the found config enabled.
790 # The option BUILD_TYPE will be ignored.
792 # CONFIG_BISECT_TYPE is the type of test to perform:
793 # build - bad fails to build
794 # boot - bad builds but fails to boot
795 # test - bad boots but fails a test
797 # CONFIG_BISECT is the config that failed to boot
799 # If BISECT_MANUAL is set, it will pause between iterations.
800 # This is useful to use just ktest.pl just for the config bisect.
801 # If you set it to build, it will run the bisect and you can
802 # control what happens in between iterations. It will ask you if
803 # the test succeeded or not and continue the config bisect.
805 # CONFIG_BISECT_GOOD (optional)
806 # If you have a good config to start with, then you
807 # can specify it with CONFIG_BISECT_GOOD. Otherwise
808 # the MIN_CONFIG is the base.
812 # TEST_TYPE = config_bisect
813 # CONFIG_BISECT_TYPE = build
814 # CONFIG_BISECT = /home/test/Ā¢onfig-bad
815 # MIN_CONFIG = /home/test/config-min
820 # For TEST_TYPE = make_min_config
822 # After doing a make localyesconfig, your kernel configuration may
823 # not be the most useful minimum configuration. Having a true minimum
824 # config that you can use against other configs is very useful if
825 # someone else has a config that breaks on your code. By only forcing
826 # those configurations that are truly required to boot your machine
827 # will give you less of a chance that one of your set configurations
828 # will make the bug go away. This will give you a better chance to
829 # be able to reproduce the reported bug matching the broken config.
831 # Note, this does take some time, and may require you to run the
832 # test over night, or perhaps over the weekend. But it also allows
833 # you to interrupt it, and gives you the current minimum config
834 # that was found till that time.
836 # Note, this test automatically assumes a BUILD_TYPE of oldconfig
837 # and its test type acts like boot.
838 # TODO: add a test version that makes the config do more than just
839 # boot, like having network access.
841 # To save time, the test does not just grab any option and test
842 # it. The Kconfig files are examined to determine the dependencies
843 # of the configs. If a config is chosen that depends on another
844 # config, that config will be checked first. By checking the
845 # parents first, we can eliminate whole groups of configs that
846 # may have been enabled.
848 # For example, if a USB device config is chosen and depends on CONFIG_USB,
849 # the CONFIG_USB will be tested before the device. If CONFIG_USB is
850 # found not to be needed, it, as well as all configs that depend on
851 # it, will be disabled and removed from the current min_config.
853 # OUTPUT_MIN_CONFIG is the path and filename of the file that will
854 # be created from the MIN_CONFIG. If you interrupt the test, set
855 # this file as your new min config, and use it to continue the test.
856 # This file does not need to exist on start of test.
857 # This file is not created until a config is found that can be removed.
858 # If this file exists, you will be prompted if you want to use it
859 # as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG
863 # START_MIN_CONFIG is the config to use to start the test with.
864 # you can set this as the same OUTPUT_MIN_CONFIG, but if you do
865 # the OUTPUT_MIN_CONFIG file must exist.
866 # (default MIN_CONFIG)
868 # IGNORE_CONFIG is used to specify a config file that has configs that
869 # you already know must be set. Configs are written here that have
870 # been tested and proved to be required. It is best to define this
871 # file if you intend on interrupting the test and running it where
872 # it left off. New configs that it finds will be written to this file
873 # and will not be tested again in later runs.
878 # TEST_TYPE = make_min_config
879 # OUTPUT_MIN_CONFIG = /path/to/config-new-min
880 # START_MIN_CONFIG = /path/to/config-min
881 # IGNORE_CONFIG = /path/to/config-tested