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.
77 # Options defined in the DEFAULTS section can not be duplicated
78 # even if they are defined in two different DEFAULT sections.
79 # This is done to catch mistakes where an option is added but
80 # the previous option was forgotten about and not commented.
82 # The OVERRIDE keyword can be added to a section to allow this
83 # section to override other DEFAULT sections values that have
84 # been defined previously. It will only override options that
85 # have been defined before its use. Options defined later
86 # in a non override section will still error. The same option
87 # can not be defined in the same section even if that section
92 # Both TEST_START and DEFAULTS sections can also have the IF keyword
93 # The value after the IF must evaluate into a 0 or non 0 positive
94 # integer, and can use the config variables (explained below).
96 # DEFAULTS IF ${IS_X86_32}
98 # The above will process the DEFAULTS section if the config
99 # variable IS_X86_32 evaluates to a non zero positive integer
100 # otherwise if it evaluates to zero, it will act the same
101 # as if the SKIP keyword was used.
103 # The ELSE keyword can be used directly after a section with
106 # TEST_START IF ${RUN_NET_TESTS}
107 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
111 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-normal
114 # The ELSE keyword can also contain an IF statement to allow multiple
115 # if then else sections. But all the sections must be either
116 # DEFAULT or TEST_START, they can not be a mixture.
118 # TEST_START IF ${RUN_NET_TESTS}
119 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
121 # ELSE IF ${RUN_DISK_TESTS}
122 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-tests
124 # ELSE IF ${RUN_CPU_TESTS}
125 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-cpu
128 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
130 # The if statement may also have comparisons that will and for
131 # == and !=, strings may be used for both sides.
135 # DEFAULTS IF ${BOX_TYPE} == x86_32
136 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-32
138 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-64
143 # The INCLUDE keyword may be used in DEFAULT sections. This will
144 # read another config file and process that file as well. The included
145 # file can include other files, add new test cases or default
146 # statements. Config variables will be passed to these files and changes
147 # to config variables will be seen by top level config files. Including
148 # a file is processed just like the contents of the file was cut and pasted
149 # into the top level file, except, that include files that end with
150 # TEST_START sections will have that section ended at the end of
151 # the include file. That is, an included file is included followed
152 # by another DEFAULT keyword.
154 # Unlike other files referenced in this config, the file path does not need
155 # to be absolute. If the file does not start with '/', then the directory
156 # that the current config file was located in is used. If no config by the
157 # given name is found there, then the current directory is searched.
166 # Note, if the include file does not contain a full path, the file is
167 # searched first by the location of the original include file, and then
168 # by the location that ktest.pl was executed in.
171 #### Config variables ####
173 # This config file can also contain "config variables".
174 # These are assigned with ":=" instead of the ktest option
177 # The difference between ktest options and config variables
178 # is that config variables can be used multiple times,
179 # where each instance will override the previous instance.
180 # And that they only live at time of processing this config.
182 # The advantage to config variables are that they can be used
183 # by any option or any other config variables to define thing
184 # that you may use over and over again in the options.
190 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
193 # MIN_CONFIG = config1
194 # TEST = ${TEST_CASE}
197 # MIN_CONFIG = config2
198 # TEST = ${TEST_CASE}
200 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
203 # MIN_CONFIG = config1
204 # TEST = ${TEST_CASE}
207 # MIN_CONFIG = config2
208 # TEST = ${TEST_CASE}
210 # TEST_DIR := /home/me/test
212 # BUILD_DIR = ${TEST_DIR}/linux.git
213 # OUTPUT_DIR = ${TEST_DIR}/test
215 # Note, the config variables are evaluated immediately, thus
216 # updating TARGET after TEST_CASE has been assigned does nothing
219 # As shown in the example, to evaluate a config variable, you
220 # use the ${X} convention. Simple $X will not work.
222 # If the config variable does not exist, the ${X} will not
223 # be evaluated. Thus:
225 # MAKE_CMD = PATH=/mypath:${PATH} make
227 # If PATH is not a config variable, then the ${PATH} in
228 # the MAKE_CMD option will be evaluated by the shell when
229 # the MAKE_CMD option is passed into shell processing.
231 #### Using options in other options ####
233 # Options that are defined in the config file may also be used
234 # by other options. All options are evaulated at time of
235 # use (except that config variables are evaluated at config
238 # If an ktest option is used within another option, instead of
239 # typing it again in that option you can simply use the option
240 # just like you can config variables.
244 # TEST = ssh root@${MACHINE} /path/to/test
246 # The option will be used per test case. Thus:
249 # TEST = ssh root@{MACHINE}
257 # For both test cases, MACHINE will be evaluated at the time
258 # of the test case. The first test will run ssh root@box1
259 # and the second will run ssh root@box2.
261 #### Mandatory Default Options ####
263 # These options must be in the default section, although most
264 # may be overridden by test options.
266 # The machine hostname that you will test
269 # The box is expected to have ssh on normal bootup, provide the user
270 # (most likely root, since you need privileged operations)
273 # The directory that contains the Linux source code
274 #BUILD_DIR = /home/test/linux.git
276 # The directory that the objects will be built
277 # (can not be same as BUILD_DIR)
278 #OUTPUT_DIR = /home/test/build/target
280 # The location of the compiled file to copy to the target
281 # (relative to OUTPUT_DIR)
282 #BUILD_TARGET = arch/x86/boot/bzImage
284 # The place to put your image on the test machine
285 #TARGET_IMAGE = /boot/vmlinuz-test
287 # A script or command to reboot the box
289 # Here is a digital loggers power switch example
290 #POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
292 # Here is an example to reboot a virtual box on the current host
293 # with the name "Guest".
294 #POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
296 # The script or command that reads the console
298 # If you use ttywatch server, something like the following would work.
299 #CONSOLE = nc -d localhost 3001
301 # For a virtual machine with guest name "Guest".
302 #CONSOLE = virsh console Guest
304 # Required version ending to differentiate the test
305 # from other linux builds on the system.
306 #LOCALVERSION = -test
308 # The grub title name for the test kernel to boot
309 # (Only mandatory if REBOOT_TYPE = grub)
311 # Note, ktest.pl will not update the grub menu.lst, you need to
312 # manually add an option for the test. ktest.pl will search
313 # the grub menu.lst for this option to find what kernel to
316 # For example, if in the /boot/grub/menu.lst the test kernel title has:
318 # kernel vmlinuz-test
319 #GRUB_MENU = Test Kernel
321 # A script to reboot the target into the test kernel
322 # (Only mandatory if REBOOT_TYPE = script)
325 #### Optional Config Options (all have defaults) ####
327 # Start a test setup. If you leave this off, all options
328 # will be default and the test will run once.
329 # This is a label and not really an option (it takes no value).
330 # You can append ITERATE and a number after it to iterate the
331 # test a number of times, or SKIP to ignore this test.
334 #TEST_START ITERATE 5
337 # Have the following options as default again. Used after tests
338 # have already been defined by TEST_START. Optionally, you can
339 # just define all default options before the first TEST_START
340 # and you do not need this option.
342 # This is a label and not really an option (it takes no value).
343 # You can append SKIP to this label and the options within this
344 # section will be ignored.
349 # The default test type (default test)
350 # The test types may be:
351 # build - only build the kernel, do nothing else
352 # install - build and install, but do nothing else (does not reboot)
353 # boot - build, install, and boot the kernel
354 # test - build, boot and if TEST is set, run the test script
355 # (If TEST is not set, it defaults back to boot)
356 # bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
357 # patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
360 # Test to run if there is a successful boot and TEST_TYPE is test.
361 # Must exit with 0 on success and non zero on error
362 # default (undefined)
363 #TEST = ssh user@machine /root/run_test
365 # The build type is any make config type or special command
366 # (default randconfig)
367 # nobuild - skip the clean and build step
368 # useconfig:/path/to/config - use the given config and run
370 # This option is ignored if TEST_TYPE is patchcheck or bisect
371 #BUILD_TYPE = randconfig
373 # The make command (default make)
374 # If you are building a 32bit x86 on a 64 bit host
375 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
377 # Any build options for the make of the kernel (not for other makes, like configs)
379 #BUILD_OPTIONS = -j20
381 # If you need an initrd, you can add a script or code here to install
382 # it. The environment variable KERNEL_VERSION will be set to the
383 # kernel version that is used. Remember to add the initrd line
384 # to your grub menu.lst file.
386 # Here's a couple of examples to use:
387 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
389 # or on some systems:
390 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
392 # If for some reason you just want to boot the kernel and you do not
393 # want the test to install anything new. For example, you may just want
394 # to boot test the same kernel over and over and do not want to go through
395 # the hassle of installing anything, you can set this option to 1
399 # If there is a script that you require to run before the build is done
400 # you can specify it with PRE_BUILD.
402 # One example may be if you must add a temporary patch to the build to
403 # fix a unrelated bug to perform a patchcheck test. This will apply the
404 # patch before each build that is made. Use the POST_BUILD to do a git reset --hard
405 # to remove the patch.
408 #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
410 # To specify if the test should fail if the PRE_BUILD fails,
411 # PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
416 # If there is a script that should run after the build is done
417 # you can specify it with POST_BUILD.
419 # As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
420 # made by the PRE_BUILD.
423 #POST_BUILD = cd ${BUILD_DIR} && git reset --hard
425 # To specify if the test should fail if the POST_BUILD fails,
426 # POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
431 # Way to reboot the box to the test kernel.
432 # Only valid options so far are "grub" and "script"
434 # If you specify grub, it will assume grub version 1
435 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
436 # and select that target to reboot to the kernel. If this is not
437 # your setup, then specify "script" and have a command or script
438 # specified in REBOOT_SCRIPT to boot to the target.
440 # The entry in /boot/grub/menu.lst must be entered in manually.
441 # The test will not modify that file.
444 # The min config that is needed to build for the machine
445 # A nice way to create this is with the following:
449 # $ scp mymods host:/tmp
453 # $ make LSMOD=mymods localyesconfig
454 # $ grep '^CONFIG' .config > /home/test/config-min
456 # If you want even less configs:
458 # log in directly to target (do not ssh)
461 # # lsmod | cut -d' ' -f1 | xargs rmmod
463 # repeat the above several times
468 # May need to reboot to get your network back to copy the mymods
469 # to the host, and then remove the previous .config and run the
470 # localyesconfig again. The CONFIG_MIN generated like this will
471 # not guarantee network activity to the box so the TEST_TYPE of
474 # You might also want to set:
475 # CONFIG_CMDLINE="<your options here>"
476 # randconfig may set the above and override your real command
478 # (default undefined)
479 #MIN_CONFIG = /home/test/config-min
481 # Sometimes there's options that just break the boot and
482 # you do not care about. Here are a few:
483 # # CONFIG_STAGING is not set
484 # Staging drivers are horrible, and can break the build.
485 # # CONFIG_SCSI_DEBUG is not set
486 # SCSI_DEBUG may change your root partition
487 # # CONFIG_KGDB_SERIAL_CONSOLE is not set
488 # KGDB may cause oops waiting for a connection that's not there.
489 # This option points to the file containing config options that will be prepended
490 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
492 # Note, config options in MIN_CONFIG will override these options.
494 # (default undefined)
495 #ADD_CONFIG = /home/test/config-broken
497 # The location on the host where to write temp files
498 # (default /tmp/ktest/${MACHINE})
499 #TMP_DIR = /tmp/ktest/${MACHINE}
501 # Optional log file to write the status (recommended)
502 # Note, this is a DEFAULT section only option.
503 # (default undefined)
504 #LOG_FILE = /home/test/logfiles/target.log
506 # Remove old logfile if it exists before starting all tests.
507 # Note, this is a DEFAULT section only option.
511 # Line to define a successful boot up in console output.
512 # This is what the line contains, not the entire line. If you need
513 # the entire line to match, then use regural expression syntax like:
514 # (do not add any quotes around it)
516 # SUCCESS_LINE = ^MyBox Login:$
519 #SUCCESS_LINE = login:
521 # To speed up between reboots, defining a line that the
522 # default kernel produces that represents that the default
523 # kernel has successfully booted and can be used to pass
524 # a new test kernel to it. Otherwise ktest.pl will wait till
525 # SLEEP_TIME to continue.
526 # (default undefined)
527 #REBOOT_SUCCESS_LINE = login:
529 # In case the console constantly fills the screen, having
530 # a specified time to stop the test after success is recommended.
533 #STOP_AFTER_SUCCESS = 10
535 # In case the console constantly fills the screen, having
536 # a specified time to stop the test after failure is recommended.
539 #STOP_AFTER_FAILURE = 60
541 # In case the console constantly fills the screen, having
542 # a specified time to stop the test if it never succeeds nor fails
544 # Note: this is ignored if a success or failure is detected.
546 # (default 600, -1 is to never stop)
547 #STOP_TEST_AFTER = 600
549 # Stop testing if a build fails. If set, the script will end if
550 # a failure is detected, otherwise it will save off the .config,
551 # dmesg and bootlog in a directory called
552 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
553 # if the STORE_FAILURES directory is set.
555 # Note, even if this is set to zero, there are some errors that still
559 # Directory to store failure directories on failure. If this is not
560 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
561 # bootlog. This option is ignored if DIE_ON_FAILURE is not set.
562 # (default undefined)
563 #STORE_FAILURES = /home/test/failures
565 # Build without doing a make mrproper, or removing .config
569 # As the test reads the console, after it hits the SUCCESS_LINE
570 # the time it waits for the monitor to settle down between reads
571 # can usually be lowered.
572 # (in seconds) (default 1)
575 # The timeout in seconds when we consider the box hung after
576 # the console stop producing output. Be sure to leave enough
577 # time here to get pass a reboot. Some machines may not produce
578 # any console output for a long time during a reboot. You do
579 # not want the test to fail just because the system was in
580 # the process of rebooting to the test kernel.
584 # In between tests, a reboot of the box may occur, and this
585 # is the time to wait for the console after it stops producing
586 # output. Some machines may not produce a large lag on reboot
587 # so this should accommodate it.
588 # The difference between this and TIMEOUT, is that TIMEOUT happens
589 # when rebooting to the test kernel. This sleep time happens
590 # after a test has completed and we are about to start running
591 # another test. If a reboot to the reliable kernel happens,
592 # we wait SLEEP_TIME for the console to stop producing output
593 # before starting the next test.
595 # You can speed up reboot times even more by setting REBOOT_SUCCESS_LINE.
599 # The time in between bisects to sleep (in seconds)
601 #BISECT_SLEEP_TIME = 60
603 # The time in between patch checks to sleep (in seconds)
605 #PATCHCHECK_SLEEP_TIME = 60
607 # Reboot the target box on error (default 0)
610 # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
611 # Note, this is a DEFAULT section only option.
613 #POWEROFF_ON_ERROR = 0
615 # Power off the target after all tests have completed successfully
616 # Note, this is a DEFAULT section only option.
618 #POWEROFF_ON_SUCCESS = 0
620 # Reboot the target after all test completed successfully (default 1)
621 # (ignored if POWEROFF_ON_SUCCESS is set)
622 #REBOOT_ON_SUCCESS = 1
624 # In case there are isses with rebooting, you can specify this
625 # to always powercycle after this amount of time after calling
627 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
628 # makes it powercycle immediately after rebooting. Do not define
629 # it if you do not want it.
630 # (default undefined)
631 #POWERCYCLE_AFTER_REBOOT = 5
633 # In case there's isses with halting, you can specify this
634 # to always poweroff after this amount of time after calling
636 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
637 # makes it poweroff immediately after halting. Do not define
638 # it if you do not want it.
639 # (default undefined)
640 #POWEROFF_AFTER_HALT = 20
642 # A script or command to power off the box (default undefined)
643 # Needed for POWEROFF_ON_ERROR and SUCCESS
645 # Example for digital loggers power switch:
646 #POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
648 # Example for a virtual guest call "Guest".
649 #POWER_OFF = virsh destroy Guest
651 # The way to execute a command on the target
652 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
653 # The variables SSH_USER, MACHINE and SSH_COMMAND are defined
654 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
656 # The way to copy a file to the target
657 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
658 # The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
659 #SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
661 # The nice way to reboot the target
662 # (default ssh $SSH_USER@$MACHINE reboot)
663 # The variables SSH_USER and MACHINE are defined.
664 #REBOOT = ssh $SSH_USER@$MACHINE reboot
666 # The way triple faults are detected is by testing the kernel
667 # banner. If the kernel banner for the kernel we are testing is
668 # found, and then later a kernel banner for another kernel version
669 # is found, it is considered that we encountered a triple fault,
670 # and there is no panic or callback, but simply a reboot.
671 # To disable this (because it did a false positive) set the following
674 #DETECT_TRIPLE_FAULT = 0
676 #### Per test run options ####
677 # The following options are only allowed in TEST_START sections.
678 # They are ignored in the DEFAULTS sections.
680 # All of these are optional and undefined by default, although
681 # some of these options are required for TEST_TYPE of patchcheck
687 # If the BUILD_DIR is a git repository, then you can set this option
688 # to checkout the given branch before running the TEST. If you
689 # specify this for the first run, that branch will be used for
690 # all preceding tests until a new CHECKOUT is set.
695 # If you want the test to have a name that is displayed in
696 # the test result banner at the end of the test, then use this
697 # option. This is useful to search for the RESULT keyword and
698 # not have to translate a test number to a test in the config.
700 # For TEST_TYPE = patchcheck
702 # This expects the BUILD_DIR to be a git repository, and
703 # will checkout the PATCHCHECK_START commit.
705 # The option BUILD_TYPE will be ignored.
707 # The MIN_CONFIG will be used for all builds of the patchcheck. The build type
708 # used for patchcheck is oldconfig.
710 # PATCHCHECK_START is required and is the first patch to
711 # test (the SHA1 of the commit). You may also specify anything
712 # that git checkout allows (branch name, tage, HEAD~3).
714 # PATCHCHECK_END is the last patch to check (default HEAD)
716 # PATCHCHECK_TYPE is required and is the type of test to run:
719 # Note, the build test will look for warnings, if a warning occurred
720 # in a file that a commit touches, the build will fail, unless
721 # IGNORE_WARNINGS is set for the given commit's sha1
723 # IGNORE_WARNINGS can be used to disable the failure of patchcheck
724 # on a particuler commit (SHA1). You can add more than one commit
725 # by adding a list of SHA1s that are space delimited.
727 # If BUILD_NOCLEAN is set, then make mrproper will not be run on
728 # any of the builds, just like all other TEST_TYPE tests. But
729 # what makes patchcheck different from the other tests, is if
730 # BUILD_NOCLEAN is not set, only the first and last patch run
731 # make mrproper. This helps speed up the test.
735 # TEST_TYPE = patchcheck
736 # CHECKOUT = mybranch
737 # PATCHCHECK_TYPE = boot
738 # PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
739 # PATCHCHECK_END = HEAD~2
740 # IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
744 # For TEST_TYPE = bisect
746 # You can specify a git bisect if the BUILD_DIR is a git repository.
747 # The MIN_CONFIG will be used for all builds of the bisect. The build type
748 # used for bisecting is oldconfig.
750 # The option BUILD_TYPE will be ignored.
752 # BISECT_TYPE is the type of test to perform:
753 # build - bad fails to build
754 # boot - bad builds but fails to boot
755 # test - bad boots but fails a test
757 # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
758 # BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
760 # The above three options are required for a bisect operation.
762 # BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
764 # If an operation failed in the bisect that was not expected to
765 # fail. Then the test ends. The state of the BUILD_DIR will be
766 # left off at where the failure occurred. You can examine the
767 # reason for the failure, and perhaps even find a git commit
768 # that would work to continue with. You can run:
770 # git bisect log > /path/to/replay/file
774 # BISECT_REPLAY= /path/to/replay/file
776 # And running the test again. The test will perform the initial
777 # git bisect start, git bisect good, and git bisect bad, and
778 # then it will run git bisect replay on this file, before
779 # continuing with the bisect.
781 # BISECT_START = commit (optional, default undefined)
783 # As with BISECT_REPLAY, if the test failed on a commit that
784 # just happen to have a bad commit in the middle of the bisect,
785 # and you need to skip it. If BISECT_START is defined, it
786 # will checkout that commit after doing the initial git bisect start,
787 # git bisect good, git bisect bad, and running the git bisect replay
788 # if the BISECT_REPLAY is set.
790 # BISECT_SKIP = 1 (optional, default 0)
792 # If BISECT_TYPE is set to test but the build fails, ktest will
793 # simply fail the test and end their. You could use BISECT_REPLAY
794 # and BISECT_START to resume after you found a new starting point,
795 # or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
796 # when something other than the BISECT_TYPE fails, ktest.pl will
797 # run "git bisect skip" and try again.
799 # BISECT_FILES = <path> (optional, default undefined)
801 # To just run the git bisect on a specific path, set BISECT_FILES.
804 # BISECT_FILES = arch/x86 kernel/time
806 # Will run the bisect with "git bisect start -- arch/x86 kernel/time"
808 # BISECT_REVERSE = 1 (optional, default 0)
810 # In those strange instances where it was broken forever
811 # and you are trying to find where it started to work!
812 # Set BISECT_GOOD to the commit that was last known to fail
813 # Set BISECT_BAD to the commit that is known to start working.
814 # With BISECT_REVERSE = 1, The test will consider failures as
815 # good, and success as bad.
817 # BISECT_MANUAL = 1 (optional, default 0)
819 # In case there's a problem with automating the bisect for
820 # whatever reason. (Can't reboot, want to inspect each iteration)
821 # Doing a BISECT_MANUAL will have the test wait for you to
822 # tell it if the test passed or failed after each iteration.
823 # This is basicall the same as running git bisect yourself
824 # but ktest will rebuild and install the kernel for you.
826 # BISECT_CHECK = 1 (optional, default 0)
828 # Just to be sure the good is good and bad is bad, setting
829 # BISECT_CHECK to 1 will start the bisect by first checking
830 # out BISECT_BAD and makes sure it fails, then it will check
831 # out BISECT_GOOD and makes sure it succeeds before starting
832 # the bisect (it works for BISECT_REVERSE too).
834 # You can limit the test to just check BISECT_GOOD or
835 # BISECT_BAD with BISECT_CHECK = good or
836 # BISECT_CHECK = bad, respectively.
841 # BISECT_GOOD = v2.6.36
842 # BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
843 # BISECT_TYPE = build
844 # MIN_CONFIG = /home/test/config-bisect
848 # For TEST_TYPE = config_bisect
850 # In those cases that you have two different configs. One of them
851 # work, the other does not, and you do not know what config causes
853 # The TEST_TYPE config_bisect will bisect the bad config looking for
854 # what config causes the failure.
856 # The way it works is this:
858 # First it finds a config to work with. Since a different version, or
859 # MIN_CONFIG may cause different dependecies, it must run through this
862 # Overwrites any config set in the bad config with a config set in
863 # either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
864 # are minimal and do not disable configs you want to test:
865 # (ie. # CONFIG_FOO is not set).
867 # An oldconfig is run on the bad config and any new config that
868 # appears will be added to the configs to test.
870 # Finally, it generates a config with the above result and runs it
871 # again through make oldconfig to produce a config that should be
872 # satisfied by kconfig.
874 # Then it starts the bisect.
876 # The configs to test are cut in half. If all the configs in this
877 # half depend on a config in the other half, then the other half
878 # is tested instead. If no configs are enabled by either half, then
879 # this means a circular dependency exists and the test fails.
881 # A config is created with the test half, and the bisect test is run.
883 # If the bisect succeeds, then all configs in the generated config
884 # are removed from the configs to test and added to the configs that
885 # will be enabled for all builds (they will be enabled, but not be part
886 # of the configs to examine).
888 # If the bisect fails, then all test configs that were not enabled by
889 # the config file are removed from the test. These configs will not
890 # be enabled in future tests. Since current config failed, we consider
891 # this to be a subset of the config that we started with.
893 # When we are down to one config, it is considered the bad config.
895 # Note, the config chosen may not be the true bad config. Due to
896 # dependencies and selections of the kbuild system, mulitple
897 # configs may be needed to cause a failure. If you disable the
898 # config that was found and restart the test, if the test fails
899 # again, it is recommended to rerun the config_bisect with a new
900 # bad config without the found config enabled.
902 # The option BUILD_TYPE will be ignored.
904 # CONFIG_BISECT_TYPE is the type of test to perform:
905 # build - bad fails to build
906 # boot - bad builds but fails to boot
907 # test - bad boots but fails a test
909 # CONFIG_BISECT is the config that failed to boot
911 # If BISECT_MANUAL is set, it will pause between iterations.
912 # This is useful to use just ktest.pl just for the config bisect.
913 # If you set it to build, it will run the bisect and you can
914 # control what happens in between iterations. It will ask you if
915 # the test succeeded or not and continue the config bisect.
917 # CONFIG_BISECT_GOOD (optional)
918 # If you have a good config to start with, then you
919 # can specify it with CONFIG_BISECT_GOOD. Otherwise
920 # the MIN_CONFIG is the base.
924 # TEST_TYPE = config_bisect
925 # CONFIG_BISECT_TYPE = build
926 # CONFIG_BISECT = /home/test/Ā¢onfig-bad
927 # MIN_CONFIG = /home/test/config-min
932 # For TEST_TYPE = make_min_config
934 # After doing a make localyesconfig, your kernel configuration may
935 # not be the most useful minimum configuration. Having a true minimum
936 # config that you can use against other configs is very useful if
937 # someone else has a config that breaks on your code. By only forcing
938 # those configurations that are truly required to boot your machine
939 # will give you less of a chance that one of your set configurations
940 # will make the bug go away. This will give you a better chance to
941 # be able to reproduce the reported bug matching the broken config.
943 # Note, this does take some time, and may require you to run the
944 # test over night, or perhaps over the weekend. But it also allows
945 # you to interrupt it, and gives you the current minimum config
946 # that was found till that time.
948 # Note, this test automatically assumes a BUILD_TYPE of oldconfig
949 # and its test type acts like boot.
950 # TODO: add a test version that makes the config do more than just
951 # boot, like having network access.
953 # To save time, the test does not just grab any option and test
954 # it. The Kconfig files are examined to determine the dependencies
955 # of the configs. If a config is chosen that depends on another
956 # config, that config will be checked first. By checking the
957 # parents first, we can eliminate whole groups of configs that
958 # may have been enabled.
960 # For example, if a USB device config is chosen and depends on CONFIG_USB,
961 # the CONFIG_USB will be tested before the device. If CONFIG_USB is
962 # found not to be needed, it, as well as all configs that depend on
963 # it, will be disabled and removed from the current min_config.
965 # OUTPUT_MIN_CONFIG is the path and filename of the file that will
966 # be created from the MIN_CONFIG. If you interrupt the test, set
967 # this file as your new min config, and use it to continue the test.
968 # This file does not need to exist on start of test.
969 # This file is not created until a config is found that can be removed.
970 # If this file exists, you will be prompted if you want to use it
971 # as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG
975 # START_MIN_CONFIG is the config to use to start the test with.
976 # you can set this as the same OUTPUT_MIN_CONFIG, but if you do
977 # the OUTPUT_MIN_CONFIG file must exist.
978 # (default MIN_CONFIG)
980 # IGNORE_CONFIG is used to specify a config file that has configs that
981 # you already know must be set. Configs are written here that have
982 # been tested and proved to be required. It is best to define this
983 # file if you intend on interrupting the test and running it where
984 # it left off. New configs that it finds will be written to this file
985 # and will not be tested again in later runs.
990 # TEST_TYPE = make_min_config
991 # OUTPUT_MIN_CONFIG = /path/to/config-new-min
992 # START_MIN_CONFIG = /path/to/config-min
993 # IGNORE_CONFIG = /path/to/config-tested