1 # 2 # Config file for ktest.pl 3 # 4 # Place your customized version of this, in the working directory that 5 # ktest.pl is run from. By default, ktest.pl will look for a file 6 # called "ktest.conf", but you can name it anything you like and specify 7 # the name of your config file as the first argument of ktest.pl. 8 # 9 # Note, all paths must be absolute 10 # 11 12 # Options set in the beginning of the file are considered to be 13 # default options. These options can be overridden by test specific 14 # options, with the following exceptions: 15 # 16 # LOG_FILE 17 # CLEAR_LOG 18 # POWEROFF_ON_SUCCESS 19 # REBOOT_ON_SUCCESS 20 # 21 # Test specific options are set after the label: 22 # 23 # TEST_START 24 # 25 # The options after a TEST_START label are specific to that test. 26 # Each TEST_START label will set up a new test. If you want to 27 # perform a test more than once, you can add the ITERATE label 28 # to it followed by the number of times you want that test 29 # to iterate. If the ITERATE is left off, the test will only 30 # be performed once. 31 # 32 # TEST_START ITERATE 10 33 # 34 # You can skip a test by adding SKIP (before or after the ITERATE 35 # and number) 36 # 37 # TEST_START SKIP 38 # 39 # TEST_START SKIP ITERATE 10 40 # 41 # TEST_START ITERATE 10 SKIP 42 # 43 # The SKIP label causes the options and the test itself to be ignored. 44 # This is useful to set up several different tests in one config file, and 45 # only enabling the ones you want to use for a current test run. 46 # 47 # You can add default options anywhere in the file as well 48 # with the DEFAULTS tag. This allows you to have default options 49 # after the test options to keep the test options at the top 50 # of the file. You can even place the DEFAULTS tag between 51 # test cases (but not in the middle of a single test case) 52 # 53 # TEST_START 54 # MIN_CONFIG = /home/test/config-test1 55 # 56 # DEFAULTS 57 # MIN_CONFIG = /home/test/config-default 58 # 59 # TEST_START ITERATE 10 60 # 61 # The above will run the first test with MIN_CONFIG set to 62 # /home/test/config-test-1. Then 10 tests will be executed 63 # with MIN_CONFIG with /home/test/config-default. 64 # 65 # You can also disable defaults with the SKIP option 66 # 67 # DEFAULTS SKIP 68 # MIN_CONFIG = /home/test/config-use-sometimes 69 # 70 # DEFAULTS 71 # MIN_CONFIG = /home/test/config-most-times 72 # 73 # The above will ignore the first MIN_CONFIG. If you want to 74 # use the first MIN_CONFIG, remove the SKIP from the first 75 # DEFAULTS tag and add it to the second. Be careful, options 76 # may only be declared once per test or default. If you have 77 # the same option name under the same test or as default 78 # ktest will fail to execute, and no tests will run. 79 # 80 # DEFAULTS OVERRIDE 81 # 82 # Options defined in the DEFAULTS section can not be duplicated 83 # even if they are defined in two different DEFAULT sections. 84 # This is done to catch mistakes where an option is added but 85 # the previous option was forgotten about and not commented. 86 # 87 # The OVERRIDE keyword can be added to a section to allow this 88 # section to override other DEFAULT sections values that have 89 # been defined previously. It will only override options that 90 # have been defined before its use. Options defined later 91 # in a non override section will still error. The same option 92 # can not be defined in the same section even if that section 93 # is marked OVERRIDE. 94 # 95 # 96 # 97 # Both TEST_START and DEFAULTS sections can also have the IF keyword 98 # The value after the IF must evaluate into a 0 or non 0 positive 99 # integer, and can use the config variables (explained below). 100 # 101 # DEFAULTS IF ${IS_X86_32} 102 # 103 # The above will process the DEFAULTS section if the config 104 # variable IS_X86_32 evaluates to a non zero positive integer 105 # otherwise if it evaluates to zero, it will act the same 106 # as if the SKIP keyword was used. 107 # 108 # The ELSE keyword can be used directly after a section with 109 # a IF statement. 110 # 111 # TEST_START IF ${RUN_NET_TESTS} 112 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network 113 # 114 # ELSE 115 # 116 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-normal 117 # 118 # 119 # The ELSE keyword can also contain an IF statement to allow multiple 120 # if then else sections. But all the sections must be either 121 # DEFAULT or TEST_START, they can not be a mixture. 122 # 123 # TEST_START IF ${RUN_NET_TESTS} 124 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network 125 # 126 # ELSE IF ${RUN_DISK_TESTS} 127 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-tests 128 # 129 # ELSE IF ${RUN_CPU_TESTS} 130 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-cpu 131 # 132 # ELSE 133 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network 134 # 135 # The if statement may also have comparisons that will and for 136 # == and !=, strings may be used for both sides. 137 # 138 # BOX_TYPE := x86_32 139 # 140 # DEFAULTS IF ${BOX_TYPE} == x86_32 141 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-32 142 # ELSE 143 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-64 144 # 145 # The DEFINED keyword can be used by the IF statements too. 146 # It returns true if the given config variable or option has been defined 147 # or false otherwise. 148 # 149 # 150 # DEFAULTS IF DEFINED USE_CC 151 # CC := ${USE_CC} 152 # ELSE 153 # CC := gcc 154 # 155 # 156 # As well as NOT DEFINED. 157 # 158 # DEFAULTS IF NOT DEFINED MAKE_CMD 159 # MAKE_CMD := make ARCH=x86 160 # 161 # 162 # And/or ops (&&,||) may also be used to make complex conditionals. 163 # 164 # TEST_START IF (DEFINED ALL_TESTS || ${MYTEST} == boottest) && ${MACHINE} == gandalf 165 # 166 # Notice the use of parentheses. Without any parentheses the above would be 167 # processed the same as: 168 # 169 # TEST_START IF DEFINED ALL_TESTS || (${MYTEST} == boottest && ${MACHINE} == gandalf) 170 # 171 # 172 # 173 # INCLUDE file 174 # 175 # The INCLUDE keyword may be used in DEFAULT sections. This will 176 # read another config file and process that file as well. The included 177 # file can include other files, add new test cases or default 178 # statements. Config variables will be passed to these files and changes 179 # to config variables will be seen by top level config files. Including 180 # a file is processed just like the contents of the file was cut and pasted 181 # into the top level file, except, that include files that end with 182 # TEST_START sections will have that section ended at the end of 183 # the include file. That is, an included file is included followed 184 # by another DEFAULT keyword. 185 # 186 # Unlike other files referenced in this config, the file path does not need 187 # to be absolute. If the file does not start with '/', then the directory 188 # that the current config file was located in is used. If no config by the 189 # given name is found there, then the current directory is searched. 190 # 191 # INCLUDE myfile 192 # DEFAULT 193 # 194 # is the same as: 195 # 196 # INCLUDE myfile 197 # 198 # Note, if the include file does not contain a full path, the file is 199 # searched first by the location of the original include file, and then 200 # by the location that ktest.pl was executed in. 201 # 202 203 #### Config variables #### 204 # 205 # This config file can also contain "config variables". 206 # These are assigned with ":=" instead of the ktest option 207 # assignment "=". 208 # 209 # The difference between ktest options and config variables 210 # is that config variables can be used multiple times, 211 # where each instance will override the previous instance. 212 # And that they only live at time of processing this config. 213 # 214 # The advantage to config variables are that they can be used 215 # by any option or any other config variables to define thing 216 # that you may use over and over again in the options. 217 # 218 # For example: 219 # 220 # USER := root 221 # TARGET := mybox 222 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test 223 # 224 # TEST_START 225 # MIN_CONFIG = config1 226 # TEST = ${TEST_CASE} 227 # 228 # TEST_START 229 # MIN_CONFIG = config2 230 # TEST = ${TEST_CASE} 231 # 232 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2 233 # 234 # TEST_START 235 # MIN_CONFIG = config1 236 # TEST = ${TEST_CASE} 237 # 238 # TEST_START 239 # MIN_CONFIG = config2 240 # TEST = ${TEST_CASE} 241 # 242 # TEST_DIR := /home/me/test 243 # 244 # BUILD_DIR = ${TEST_DIR}/linux.git 245 # OUTPUT_DIR = ${TEST_DIR}/test 246 # 247 # Note, the config variables are evaluated immediately, thus 248 # updating TARGET after TEST_CASE has been assigned does nothing 249 # to TEST_CASE. 250 # 251 # As shown in the example, to evaluate a config variable, you 252 # use the ${X} convention. Simple $X will not work. 253 # 254 # If the config variable does not exist, the ${X} will not 255 # be evaluated. Thus: 256 # 257 # MAKE_CMD = PATH=/mypath:${PATH} make 258 # 259 # If PATH is not a config variable, then the ${PATH} in 260 # the MAKE_CMD option will be evaluated by the shell when 261 # the MAKE_CMD option is passed into shell processing. 262 # 263 # Shell commands can also be inserted with the ${shell <command>} 264 # expression. Note, this is case sensitive, thus ${SHELL <command>} 265 # will not work. 266 # 267 # HOSTNAME := ${shell hostname} 268 # DEFAULTS IF "${HOSTNAME}" == "frodo" 269 # 270 271 #### Using options in other options #### 272 # 273 # Options that are defined in the config file may also be used 274 # by other options. All options are evaluated at time of 275 # use (except that config variables are evaluated at config 276 # processing time). 277 # 278 # If an ktest option is used within another option, instead of 279 # typing it again in that option you can simply use the option 280 # just like you can config variables. 281 # 282 # MACHINE = mybox 283 # 284 # TEST = ssh root@${MACHINE} /path/to/test 285 # 286 # The option will be used per test case. Thus: 287 # 288 # TEST_TYPE = test 289 # TEST = ssh root@{MACHINE} 290 # 291 # TEST_START 292 # MACHINE = box1 293 # 294 # TEST_START 295 # MACHINE = box2 296 # 297 # For both test cases, MACHINE will be evaluated at the time 298 # of the test case. The first test will run ssh root@box1 299 # and the second will run ssh root@box2. 300 301 #### Mandatory Default Options #### 302 303 # These options must be in the default section, although most 304 # may be overridden by test options. 305 306 # The machine hostname that you will test 307 #MACHINE = target 308 309 # The box is expected to have ssh on normal bootup, provide the user 310 # (most likely root, since you need privileged operations) 311 #SSH_USER = root 312 313 # The directory that contains the Linux source code 314 #BUILD_DIR = /home/test/linux.git 315 316 # The directory that the objects will be built 317 # (can not be same as BUILD_DIR) 318 #OUTPUT_DIR = /home/test/build/target 319 320 # The location of the compiled file to copy to the target 321 # (relative to OUTPUT_DIR) 322 #BUILD_TARGET = arch/x86/boot/bzImage 323 324 # The place to put your image on the test machine 325 #TARGET_IMAGE = /boot/vmlinuz-test 326 327 # A script or command to reboot the box 328 # 329 # Here is a digital loggers power switch example 330 #POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL' 331 # 332 # Here is an example to reboot a virtual box on the current host 333 # with the name "Guest". 334 #POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest 335 336 # The script or command that reads the console 337 # 338 # If you use ttywatch server, something like the following would work. 339 #CONSOLE = nc -d localhost 3001 340 # 341 # For a virtual machine with guest name "Guest". 342 #CONSOLE = virsh console Guest 343 344 # Signal to send to kill console. 345 # ktest.pl will create a child process to monitor the console. 346 # When the console is finished, ktest will kill the child process 347 # with this signal. 348 # (default INT) 349 #CLOSE_CONSOLE_SIGNAL = HUP 350 351 # Required version ending to differentiate the test 352 # from other linux builds on the system. 353 #LOCALVERSION = -test 354 355 # For REBOOT_TYPE = grub2, you must specify where the grub.cfg 356 # file is. This is the file that is searched to find the menu 357 # option to boot to with GRUB_REBOOT 358 #GRUB_FILE = /boot/grub2/grub.cfg 359 360 # The tool for REBOOT_TYPE = grub2 or grub2bls to set the next reboot kernel 361 # to boot into (one shot mode). 362 # (default grub2_reboot) 363 #GRUB_REBOOT = grub2_reboot 364 365 # The grub title name for the test kernel to boot 366 # (Only mandatory if REBOOT_TYPE = grub or grub2 or grub2bls) 367 # 368 # Note, ktest.pl will not update the grub menu.lst, you need to 369 # manually add an option for the test. ktest.pl will search 370 # the grub menu.lst for this option to find what kernel to 371 # reboot into. 372 # 373 # For example, if in the /boot/grub/menu.lst the test kernel title has: 374 # title Test Kernel 375 # kernel vmlinuz-test 376 # 377 # For grub2, a search of top level "menuentry"s are done. No 378 # submenu is searched. The menu is found by searching for the 379 # contents of GRUB_MENU in the line that starts with "menuentry". 380 # You may want to include the quotes around the option. For example: 381 # for: menuentry 'Test Kernel' 382 # do a: GRUB_MENU = 'Test Kernel' 383 # For customizing, add your entry in /etc/grub.d/40_custom. 384 # 385 # For grub2bls, a search of "title"s are done. The menu is found 386 # by searching for the contents of GRUB_MENU in the line that starts 387 # with "title". 388 # 389 #GRUB_MENU = Test Kernel 390 391 # For REBOOT_TYPE = syslinux, the name of the syslinux executable 392 # (on the target) to use to set up the next reboot to boot the 393 # test kernel. 394 # (default extlinux) 395 #SYSLINUX = syslinux 396 397 # For REBOOT_TYPE = syslinux, the path that is passed to to the 398 # syslinux command where syslinux is installed. 399 # (default /boot/extlinux) 400 #SYSLINUX_PATH = /boot/syslinux 401 402 # For REBOOT_TYPE = syslinux, the syslinux label that references the 403 # test kernel in the syslinux config file. 404 # (default undefined) 405 #SYSLINUX_LABEL = "test-kernel" 406 407 # A script to reboot the target into the test kernel 408 # This and SWITCH_TO_TEST are about the same, except 409 # SWITCH_TO_TEST is run even for REBOOT_TYPE = grub. 410 # This may be left undefined. 411 # (default undefined) 412 #REBOOT_SCRIPT = 413 414 #### Optional Config Options (all have defaults) #### 415 416 # Email options for receiving notifications. Users must setup 417 # the specified mailer prior to using this feature. 418 # 419 # (default undefined) 420 #MAILTO = 421 # 422 # Supported mailers: sendmail, mail, mailx 423 # (default sendmail) 424 #MAILER = sendmail 425 # 426 # The executable to run 427 # (default: for sendmail "/usr/sbin/sendmail", otherwise equals ${MAILER}) 428 #MAIL_EXEC = /usr/sbin/sendmail 429 # 430 # The command used to send mail, which uses the above options 431 # can be modified. By default if the mailer is "sendmail" then 432 # MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | $MAIL_PATH/$MAILER -t $MAILTO 433 # For mail or mailx: 434 # MAIL_COMMAND = "$MAIL_PATH/$MAILER -s \'$SUBJECT\' $MAILTO <<< \'$MESSAGE\' 435 # ktest.pl will do the substitution for MAIL_PATH, MAILER, MAILTO at the time 436 # it sends the mail if "$FOO" format is used. If "${FOO}" format is used, 437 # then the substitutions will occur at the time the config file is read. 438 # But note, MAIL_PATH and MAILER require being set by the config file if 439 # ${MAIL_PATH} or ${MAILER} are used, but not if $MAIL_PATH or $MAILER are. 440 #MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | $MAIL_PATH/$MAILER -t $MAILTO 441 # 442 # Errors are defined as those would terminate the script 443 # (default 1) 444 #EMAIL_ON_ERROR = 1 445 # (default 1) 446 #EMAIL_WHEN_FINISHED = 1 447 # (default 0) 448 #EMAIL_WHEN_STARTED = 1 449 # 450 # Users can cancel the test by Ctrl^C 451 # (default 0) 452 #EMAIL_WHEN_CANCELED = 1 453 # 454 # If a test ends with an error and EMAIL_ON_ERROR is set as well 455 # as a LOG_FILE is defined, then the log of the failing test will 456 # be included in the email that is sent. 457 # It is possible that the log may be very large, in which case, 458 # only the last amount of the log should be sent. To limit how 459 # much of the log is sent, set MAIL_MAX_SIZE. This will be the 460 # size in bytes of the last portion of the log of the failed 461 # test file. That is, if this is set to 100000, then only the 462 # last 100 thousand bytes of the log file will be included in 463 # the email. 464 # (default undef) 465 #MAIL_MAX_SIZE = 1000000 466 467 # Start a test setup. If you leave this off, all options 468 # will be default and the test will run once. 469 # This is a label and not really an option (it takes no value). 470 # You can append ITERATE and a number after it to iterate the 471 # test a number of times, or SKIP to ignore this test. 472 # 473 #TEST_START 474 #TEST_START ITERATE 5 475 #TEST_START SKIP 476 477 # Have the following options as default again. Used after tests 478 # have already been defined by TEST_START. Optionally, you can 479 # just define all default options before the first TEST_START 480 # and you do not need this option. 481 # 482 # This is a label and not really an option (it takes no value). 483 # You can append SKIP to this label and the options within this 484 # section will be ignored. 485 # 486 # DEFAULTS 487 # DEFAULTS SKIP 488 489 # If you want to execute some command before the first test runs 490 # you can set this option. Note, it can be set as a default option 491 # or an option in the first test case. All other test cases will 492 # ignore it. If both the default and first test have this option 493 # set, then the first test will take precedence. 494 # 495 # default (undefined) 496 #PRE_KTEST = ${SSH} ~/set_up_test 497 498 # If you want to execute some command after all the tests have 499 # completed, you can set this option. Note, it can be set as a 500 # default or any test case can override it. If multiple test cases 501 # set this option, then the last test case that set it will take 502 # precedence 503 # 504 # default (undefined) 505 #POST_KTEST = ${SSH} ~/dismantle_test 506 507 # If you want to remove the kernel entry in Boot Loader Specification (BLS) 508 # environment, use kernel-install command. 509 # Here's the example: 510 #POST_KTEST = ssh root@Test "/usr/bin/kernel-install remove $KERNEL_VERSION" 511 512 # The default test type (default test) 513 # The test types may be: 514 # build - only build the kernel, do nothing else 515 # install - build and install, but do nothing else (does not reboot) 516 # boot - build, install, and boot the kernel 517 # test - build, boot and if TEST is set, run the test script 518 # (If TEST is not set, it defaults back to boot) 519 # bisect - Perform a bisect on the kernel (see BISECT_TYPE below) 520 # patchcheck - Do a test on a series of commits in git (see PATCHCHECK below) 521 #TEST_TYPE = test 522 523 # Test to run if there is a successful boot and TEST_TYPE is test. 524 # Must exit with 0 on success and non zero on error 525 # default (undefined) 526 #TEST = ssh user@machine /root/run_test 527 528 # The build type is any make config type or special command 529 # (default oldconfig) 530 # nobuild - skip the clean and build step 531 # useconfig:/path/to/config - use the given config and run 532 # oldconfig on it. 533 # This option is ignored if TEST_TYPE is patchcheck or bisect 534 #BUILD_TYPE = randconfig 535 536 # The make command (default make) 537 # If you are building a 32bit x86 on a 64 bit host 538 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386 539 540 # Any build options for the make of the kernel (not for other makes, like configs) 541 # (default "") 542 #BUILD_OPTIONS = -j20 543 544 # If you need to do some special handling before installing 545 # you can add a script with this option. 546 # The environment variable KERNEL_VERSION will be set to the 547 # kernel version that is used. 548 # 549 # default (undefined) 550 #PRE_INSTALL = ssh user@target rm -rf '/lib/modules/*-test*' 551 552 # If you need an initrd, you can add a script or code here to install 553 # it. The environment variable KERNEL_VERSION will be set to the 554 # kernel version that is used. Remember to add the initrd line 555 # to your grub menu.lst file. 556 # 557 # Here's a couple of examples to use: 558 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION 559 # 560 # or on some systems: 561 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION 562 563 # If you want to add the kernel entry in Boot Loader Specification (BLS) 564 # environment, use kernel-install command. 565 # Here's the example: 566 #POST_INSTALL = ssh root@Test "/usr/bin/kernel-install add $KERNEL_VERSION /boot/vmlinuz-$KERNEL_VERSION" 567 568 # If for some reason you just want to boot the kernel and you do not 569 # want the test to install anything new. For example, you may just want 570 # to boot test the same kernel over and over and do not want to go through 571 # the hassle of installing anything, you can set this option to 1 572 # (default 0) 573 #NO_INSTALL = 1 574 575 # If there is a command that you want to run before the individual test 576 # case executes, then you can set this option 577 # 578 # default (undefined) 579 #PRE_TEST = ${SSH} reboot_to_special_kernel 580 581 # To kill the entire test if PRE_TEST is defined but fails set this 582 # to 1. 583 # (default 0) 584 #PRE_TEST_DIE = 1 585 586 # If there is a command you want to run after the individual test case 587 # completes, then you can set this option. 588 # 589 # default (undefined) 590 #POST_TEST = cd ${BUILD_DIR}; git reset --hard 591 592 # If there is a script that you require to run before the build is done 593 # you can specify it with PRE_BUILD. 594 # 595 # One example may be if you must add a temporary patch to the build to 596 # fix a unrelated bug to perform a patchcheck test. This will apply the 597 # patch before each build that is made. Use the POST_BUILD to do a git reset --hard 598 # to remove the patch. 599 # 600 # (default undef) 601 #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch 602 603 # To specify if the test should fail if the PRE_BUILD fails, 604 # PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD 605 # result is ignored. 606 # (default 0) 607 # PRE_BUILD_DIE = 1 608 609 # If there is a script that should run after the build is done 610 # you can specify it with POST_BUILD. 611 # 612 # As the example in PRE_BUILD, POST_BUILD can be used to reset modifications 613 # made by the PRE_BUILD. 614 # 615 # (default undef) 616 #POST_BUILD = cd ${BUILD_DIR} && git reset --hard 617 618 # To specify if the test should fail if the POST_BUILD fails, 619 # POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD 620 # result is ignored. 621 # (default 0) 622 #POST_BUILD_DIE = 1 623 624 # Way to reboot the box to the test kernel. 625 # Only valid options so far are "grub", "grub2", "syslinux" and "script" 626 # (default grub) 627 # If you specify grub, it will assume grub version 1 628 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU 629 # and select that target to reboot to the kernel. If this is not 630 # your setup, then specify "script" and have a command or script 631 # specified in REBOOT_SCRIPT to boot to the target. 632 # 633 # For REBOOT_TYPE = grub2, you must define both GRUB_MENU and 634 # GRUB_FILE. 635 # 636 # For REBOOT_TYPE = grub2bls, you must define GRUB_MENU. 637 # 638 # For REBOOT_TYPE = syslinux, you must define SYSLINUX_LABEL, and 639 # perhaps modify SYSLINUX (default extlinux) and SYSLINUX_PATH 640 # (default /boot/extlinux) 641 # 642 # The entry in /boot/grub/menu.lst must be entered in manually. 643 # The test will not modify that file. 644 #REBOOT_TYPE = grub 645 646 # If you are using a machine that doesn't boot with grub, and 647 # perhaps gets its kernel from a remote server (tftp), then 648 # you can use this option to update the target image with the 649 # test image. 650 # 651 # You could also do the same with POST_INSTALL, but the difference 652 # between that option and this option is that POST_INSTALL runs 653 # after the install, where this one runs just before a reboot. 654 # (default undefined) 655 #SWITCH_TO_TEST = cp ${OUTPUT_DIR}/${BUILD_TARGET} ${TARGET_IMAGE} 656 657 # If you are using a machine that doesn't boot with grub, and 658 # perhaps gets its kernel from a remote server (tftp), then 659 # you can use this option to update the target image with the 660 # the known good image to reboot safely back into. 661 # 662 # This option holds a command that will execute before needing 663 # to reboot to a good known image. 664 # (default undefined) 665 #SWITCH_TO_GOOD = ssh ${SSH_USER}/${MACHINE} cp good_image ${TARGET_IMAGE} 666 667 # The min config that is needed to build for the machine 668 # A nice way to create this is with the following: 669 # 670 # $ ssh target 671 # $ lsmod > mymods 672 # $ scp mymods host:/tmp 673 # $ exit 674 # $ cd linux.git 675 # $ rm .config 676 # $ make LSMOD=mymods localyesconfig 677 # $ grep '^CONFIG' .config > /home/test/config-min 678 # 679 # If you want even less configs: 680 # 681 # log in directly to target (do not ssh) 682 # 683 # $ su 684 # # lsmod | cut -d' ' -f1 | xargs rmmod 685 # 686 # repeat the above several times 687 # 688 # # lsmod > mymods 689 # # reboot 690 # 691 # May need to reboot to get your network back to copy the mymods 692 # to the host, and then remove the previous .config and run the 693 # localyesconfig again. The CONFIG_MIN generated like this will 694 # not guarantee network activity to the box so the TEST_TYPE of 695 # test may fail. 696 # 697 # You might also want to set: 698 # CONFIG_CMDLINE="<your options here>" 699 # randconfig may set the above and override your real command 700 # line options. 701 # (default undefined) 702 #MIN_CONFIG = /home/test/config-min 703 704 # Sometimes there's options that just break the boot and 705 # you do not care about. Here are a few: 706 # # CONFIG_STAGING is not set 707 # Staging drivers are horrible, and can break the build. 708 # # CONFIG_SCSI_DEBUG is not set 709 # SCSI_DEBUG may change your root partition 710 # # CONFIG_KGDB_SERIAL_CONSOLE is not set 711 # KGDB may cause oops waiting for a connection that's not there. 712 # This option points to the file containing config options that will be prepended 713 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set) 714 # 715 # Note, config options in MIN_CONFIG will override these options. 716 # 717 # (default undefined) 718 #ADD_CONFIG = /home/test/config-broken 719 720 # The location on the host where to write temp files 721 # (default /tmp/ktest/${MACHINE}) 722 #TMP_DIR = /tmp/ktest/${MACHINE} 723 724 # Optional log file to write the status (recommended) 725 # Note, this is a DEFAULT section only option. 726 # (default undefined) 727 #LOG_FILE = /home/test/logfiles/target.log 728 729 # Remove old logfile if it exists before starting all tests. 730 # Note, this is a DEFAULT section only option. 731 # (default 0) 732 #CLEAR_LOG = 0 733 734 # Line to define a successful boot up in console output. 735 # This is what the line contains, not the entire line. If you need 736 # the entire line to match, then use regular expression syntax like: 737 # (do not add any quotes around it) 738 # 739 # SUCCESS_LINE = ^MyBox Login:$ 740 # 741 # (default "login:") 742 #SUCCESS_LINE = login: 743 744 # To speed up between reboots, defining a line that the 745 # default kernel produces that represents that the default 746 # kernel has successfully booted and can be used to pass 747 # a new test kernel to it. Otherwise ktest.pl will wait till 748 # SLEEP_TIME to continue. 749 # (default undefined) 750 #REBOOT_SUCCESS_LINE = login: 751 752 # In case the console constantly fills the screen, having 753 # a specified time to stop the test after success is recommended. 754 # (in seconds) 755 # (default 10) 756 #STOP_AFTER_SUCCESS = 10 757 758 # In case the console constantly fills the screen, having 759 # a specified time to stop the test after failure is recommended. 760 # (in seconds) 761 # (default 60) 762 #STOP_AFTER_FAILURE = 60 763 764 # In case the console constantly fills the screen, having 765 # a specified time to stop the test if it never succeeds nor fails 766 # is recommended. 767 # Note: this is ignored if a success or failure is detected. 768 # (in seconds) 769 # (default 600, -1 is to never stop) 770 #STOP_TEST_AFTER = 600 771 772 # Stop testing if a build fails. If set, the script will end if 773 # a failure is detected, otherwise it will save off the .config, 774 # dmesg and bootlog in a directory called 775 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss 776 # if the STORE_FAILURES directory is set. 777 # (default 1) 778 # Note, even if this is set to zero, there are some errors that still 779 # stop the tests. 780 #DIE_ON_FAILURE = 1 781 782 # Directory to store failure directories on failure. If this is not 783 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and 784 # bootlog. This option is ignored if DIE_ON_FAILURE is not set. 785 # (default undefined) 786 #STORE_FAILURES = /home/test/failures 787 788 # Directory to store success directories on success. If this is not 789 # set, the .config, dmesg and bootlog will not be saved if a 790 # test succeeds. 791 # (default undefined) 792 #STORE_SUCCESSES = /home/test/successes 793 794 # Build without doing a make mrproper, or removing .config 795 # (default 0) 796 #BUILD_NOCLEAN = 0 797 798 # As the test reads the console, after it hits the SUCCESS_LINE 799 # the time it waits for the monitor to settle down between reads 800 # can usually be lowered. 801 # (in seconds) (default 1) 802 #BOOTED_TIMEOUT = 1 803 804 # The timeout in seconds when we consider the box hung after 805 # the console stop producing output. Be sure to leave enough 806 # time here to get pass a reboot. Some machines may not produce 807 # any console output for a long time during a reboot. You do 808 # not want the test to fail just because the system was in 809 # the process of rebooting to the test kernel. 810 # (default 120) 811 #TIMEOUT = 120 812 813 # The timeout in seconds when to test if the box can be rebooted 814 # or not. Before issuing the reboot command, a ssh connection 815 # is attempted to see if the target machine is still active. 816 # If the target does not connect within this timeout, a power cycle 817 # is issued instead of a reboot. 818 # CONNECT_TIMEOUT = 25 819 820 # The timeout in seconds for how long to wait for any running command 821 # to timeout. If not defined, it will let it go indefinitely. 822 # (default undefined) 823 #RUN_TIMEOUT = 600 824 825 # In between tests, a reboot of the box may occur, and this 826 # is the time to wait for the console after it stops producing 827 # output. Some machines may not produce a large lag on reboot 828 # so this should accommodate it. 829 # The difference between this and TIMEOUT, is that TIMEOUT happens 830 # when rebooting to the test kernel. This sleep time happens 831 # after a test has completed and we are about to start running 832 # another test. If a reboot to the reliable kernel happens, 833 # we wait SLEEP_TIME for the console to stop producing output 834 # before starting the next test. 835 # 836 # You can speed up reboot times even more by setting REBOOT_SUCCESS_LINE. 837 # (default 60) 838 #SLEEP_TIME = 60 839 840 # The time in between bisects to sleep (in seconds) 841 # (default 60) 842 #BISECT_SLEEP_TIME = 60 843 844 # The max wait time (in seconds) for waiting for the console to finish. 845 # If for some reason, the console is outputting content without 846 # ever finishing, this will cause ktest to get stuck. This 847 # option is the max time ktest will wait for the monitor (console) 848 # to settle down before continuing. 849 # (default 1800) 850 #MAX_MONITOR_WAIT 851 852 # The time in between patch checks to sleep (in seconds) 853 # (default 60) 854 #PATCHCHECK_SLEEP_TIME = 60 855 856 # Reboot the target box on error (default 0) 857 #REBOOT_ON_ERROR = 0 858 859 # Power off the target on error (ignored if REBOOT_ON_ERROR is set) 860 # Note, this is a DEFAULT section only option. 861 # (default 0) 862 #POWEROFF_ON_ERROR = 0 863 864 # Power off the target after all tests have completed successfully 865 # Note, this is a DEFAULT section only option. 866 # (default 0) 867 #POWEROFF_ON_SUCCESS = 0 868 869 # Reboot the target after all test completed successfully (default 1) 870 # (ignored if POWEROFF_ON_SUCCESS is set) 871 #REBOOT_ON_SUCCESS = 1 872 873 # In case there are issues with rebooting, you can specify this 874 # to always powercycle after this amount of time after calling 875 # reboot. 876 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just 877 # makes it powercycle immediately after rebooting. Do not define 878 # it if you do not want it. 879 # (default undefined) 880 #POWERCYCLE_AFTER_REBOOT = 5 881 882 # In case there's issues with halting, you can specify this 883 # to always poweroff after this amount of time after calling 884 # halt. 885 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just 886 # makes it poweroff immediately after halting. Do not define 887 # it if you do not want it. 888 # (default undefined) 889 #POWEROFF_AFTER_HALT = 20 890 891 # A script or command to power off the box (default undefined) 892 # Needed for POWEROFF_ON_ERROR and SUCCESS 893 # 894 # Example for digital loggers power switch: 895 #POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF' 896 # 897 # Example for a virtual guest call "Guest". 898 #POWER_OFF = virsh destroy Guest 899 900 # To have the build fail on "new" warnings, create a file that 901 # contains a list of all known warnings (they must match exactly 902 # to the line with 'warning:', 'error:' or 'Error:'. If the option 903 # WARNINGS_FILE is set, then that file will be read, and if the 904 # build detects a warning, it will examine this file and if the 905 # warning does not exist in it, it will fail the build. 906 # 907 # Note, if this option is defined to a file that does not exist 908 # then any warning will fail the build. 909 # (see make_warnings_file below) 910 # 911 # (optional, default undefined) 912 #WARNINGS_FILE = ${OUTPUT_DIR}/warnings_file 913 914 # The way to execute a command on the target 915 # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";) 916 # The variables SSH_USER, MACHINE and SSH_COMMAND are defined 917 #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND"; 918 919 # The way to copy a file to the target (install and modules) 920 # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE) 921 # The variables SSH_USER, MACHINE are defined by the config 922 # SRC_FILE and DST_FILE are ktest internal variables and 923 # should only have '$' and not the '${}' notation. 924 # (default scp $SRC_FILE ${SSH_USER}@${MACHINE}:$DST_FILE) 925 #SCP_TO_TARGET = echo skip scp for $SRC_FILE $DST_FILE 926 927 # If install needs to be different than modules, then this 928 # option will override the SCP_TO_TARGET for installation. 929 # (default ${SCP_TO_TARGET} ) 930 #SCP_TO_TARGET_INSTALL = scp $SRC_FILE tftp@tftpserver:$DST_FILE 931 932 # The nice way to reboot the target 933 # (default ssh $SSH_USER@$MACHINE reboot) 934 # The variables SSH_USER and MACHINE are defined. 935 #REBOOT = ssh $SSH_USER@$MACHINE reboot 936 937 # The return code of REBOOT 938 # (default 255) 939 #REBOOT_RETURN_CODE = 255 940 941 # The way triple faults are detected is by testing the kernel 942 # banner. If the kernel banner for the kernel we are testing is 943 # found, and then later a kernel banner for another kernel version 944 # is found, it is considered that we encountered a triple fault, 945 # and there is no panic or callback, but simply a reboot. 946 # To disable this (because it did a false positive) set the following 947 # to 0. 948 # (default 1) 949 #DETECT_TRIPLE_FAULT = 0 950 951 # All options in the config file should be either used by ktest 952 # or could be used within a value of another option. If an option 953 # in the config file is not used, ktest will warn about it and ask 954 # if you want to continue. 955 # 956 # If you don't care if there are non-used options, enable this 957 # option. Be careful though, a non-used option is usually a sign 958 # of an option name being typed incorrectly. 959 # (default 0) 960 #IGNORE_UNUSED = 1 961 962 # When testing a kernel that happens to have WARNINGs, and call 963 # traces, ktest.pl will detect these and fail a boot or test run 964 # due to warnings. By setting this option, ktest will ignore 965 # call traces, and will not fail a test if the kernel produces 966 # an oops. Use this option with care. 967 # (default 0) 968 #IGNORE_ERRORS = 1 969 970 #### Per test run options #### 971 # The following options are only allowed in TEST_START sections. 972 # They are ignored in the DEFAULTS sections. 973 # 974 # All of these are optional and undefined by default, although 975 # some of these options are required for TEST_TYPE of patchcheck 976 # and bisect. 977 # 978 # 979 # CHECKOUT = branch 980 # 981 # If the BUILD_DIR is a git repository, then you can set this option 982 # to checkout the given branch before running the TEST. If you 983 # specify this for the first run, that branch will be used for 984 # all preceding tests until a new CHECKOUT is set. 985 # 986 # 987 # TEST_NAME = name 988 # 989 # If you want the test to have a name that is displayed in 990 # the test result banner at the end of the test, then use this 991 # option. This is useful to search for the RESULT keyword and 992 # not have to translate a test number to a test in the config. 993 # 994 # For TEST_TYPE = patchcheck 995 # 996 # This expects the BUILD_DIR to be a git repository, and 997 # will checkout the PATCHCHECK_START commit. 998 # 999 # The option BUILD_TYPE will be ignored. 1000 # 1001 # The MIN_CONFIG will be used for all builds of the patchcheck. The build type 1002 # used for patchcheck is oldconfig. 1003 # 1004 # PATCHCHECK_START is required and is the first patch to 1005 # test (the SHA1 of the commit). You may also specify anything 1006 # that git checkout allows (branch name, tag, HEAD~3). 1007 # 1008 # PATCHCHECK_END is the last patch to check (default HEAD) 1009 # 1010 # PATCHCHECK_CHERRY if set to non zero, then git cherry will be 1011 # performed against PATCHCHECK_START and PATCHCHECK_END. That is 1012 # 1013 # git cherry ${PATCHCHECK_START} ${PATCHCHECK_END} 1014 # 1015 # Then the changes found will be tested. 1016 # 1017 # Note, PATCHCHECK_CHERRY requires PATCHCHECK_END to be defined. 1018 # (default 0) 1019 # 1020 # PATCHCHECK_TYPE is required and is the type of test to run: 1021 # build, boot, test. 1022 # 1023 # Note, the build test will look for warnings, if a warning occurred 1024 # in a file that a commit touches, the build will fail, unless 1025 # IGNORE_WARNINGS is set for the given commit's sha1 1026 # 1027 # IGNORE_WARNINGS can be used to disable the failure of patchcheck 1028 # on a particular commit (SHA1). You can add more than one commit 1029 # by adding a list of SHA1s that are space delimited. 1030 # 1031 # If BUILD_NOCLEAN is set, then make mrproper will not be run on 1032 # any of the builds, just like all other TEST_TYPE tests. But 1033 # what makes patchcheck different from the other tests, is if 1034 # BUILD_NOCLEAN is not set, only the first and last patch run 1035 # make mrproper. This helps speed up the test. 1036 # 1037 # Example: 1038 # TEST_START 1039 # TEST_TYPE = patchcheck 1040 # CHECKOUT = mybranch 1041 # PATCHCHECK_TYPE = boot 1042 # PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7 1043 # PATCHCHECK_END = HEAD~2 1044 # IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128 1045 # 1046 # 1047 # 1048 # For TEST_TYPE = bisect 1049 # 1050 # You can specify a git bisect if the BUILD_DIR is a git repository. 1051 # The MIN_CONFIG will be used for all builds of the bisect. The build type 1052 # used for bisecting is oldconfig. 1053 # 1054 # The option BUILD_TYPE will be ignored. 1055 # 1056 # BISECT_TYPE is the type of test to perform: 1057 # build - bad fails to build 1058 # boot - bad builds but fails to boot 1059 # test - bad boots but fails a test 1060 # 1061 # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types) 1062 # BISECT_BAD is the commit to label as bad (accepts all git bad commit types) 1063 # 1064 # The above three options are required for a bisect operation. 1065 # 1066 # BISECT_REPLAY = /path/to/replay/file (optional, default undefined) 1067 # 1068 # If an operation failed in the bisect that was not expected to 1069 # fail. Then the test ends. The state of the BUILD_DIR will be 1070 # left off at where the failure occurred. You can examine the 1071 # reason for the failure, and perhaps even find a git commit 1072 # that would work to continue with. You can run: 1073 # 1074 # git bisect log > /path/to/replay/file 1075 # 1076 # The adding: 1077 # 1078 # BISECT_REPLAY= /path/to/replay/file 1079 # 1080 # And running the test again. The test will perform the initial 1081 # git bisect start, git bisect good, and git bisect bad, and 1082 # then it will run git bisect replay on this file, before 1083 # continuing with the bisect. 1084 # 1085 # BISECT_START = commit (optional, default undefined) 1086 # 1087 # As with BISECT_REPLAY, if the test failed on a commit that 1088 # just happen to have a bad commit in the middle of the bisect, 1089 # and you need to skip it. If BISECT_START is defined, it 1090 # will checkout that commit after doing the initial git bisect start, 1091 # git bisect good, git bisect bad, and running the git bisect replay 1092 # if the BISECT_REPLAY is set. 1093 # 1094 # BISECT_SKIP = 1 (optional, default 0) 1095 # 1096 # If BISECT_TYPE is set to test but the build fails, ktest will 1097 # simply fail the test and end their. You could use BISECT_REPLAY 1098 # and BISECT_START to resume after you found a new starting point, 1099 # or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1, 1100 # when something other than the BISECT_TYPE fails, ktest.pl will 1101 # run "git bisect skip" and try again. 1102 # 1103 # BISECT_FILES = <path> (optional, default undefined) 1104 # 1105 # To just run the git bisect on a specific path, set BISECT_FILES. 1106 # For example: 1107 # 1108 # BISECT_FILES = arch/x86 kernel/time 1109 # 1110 # Will run the bisect with "git bisect start -- arch/x86 kernel/time" 1111 # 1112 # BISECT_REVERSE = 1 (optional, default 0) 1113 # 1114 # In those strange instances where it was broken forever 1115 # and you are trying to find where it started to work! 1116 # Set BISECT_GOOD to the commit that was last known to fail 1117 # Set BISECT_BAD to the commit that is known to start working. 1118 # With BISECT_REVERSE = 1, The test will consider failures as 1119 # good, and success as bad. 1120 # 1121 # BISECT_MANUAL = 1 (optional, default 0) 1122 # 1123 # In case there's a problem with automating the bisect for 1124 # whatever reason. (Can't reboot, want to inspect each iteration) 1125 # Doing a BISECT_MANUAL will have the test wait for you to 1126 # tell it if the test passed or failed after each iteration. 1127 # This is basically the same as running git bisect yourself 1128 # but ktest will rebuild and install the kernel for you. 1129 # 1130 # BISECT_CHECK = 1 (optional, default 0) 1131 # 1132 # Just to be sure the good is good and bad is bad, setting 1133 # BISECT_CHECK to 1 will start the bisect by first checking 1134 # out BISECT_BAD and makes sure it fails, then it will check 1135 # out BISECT_GOOD and makes sure it succeeds before starting 1136 # the bisect (it works for BISECT_REVERSE too). 1137 # 1138 # You can limit the test to just check BISECT_GOOD or 1139 # BISECT_BAD with BISECT_CHECK = good or 1140 # BISECT_CHECK = bad, respectively. 1141 # 1142 # BISECT_TRIES = 5 (optional, default 1) 1143 # 1144 # For those cases that it takes several tries to hit a bug, 1145 # the BISECT_TRIES is useful. It is the number of times the 1146 # test is ran before it says the kernel is good. The first failure 1147 # will stop trying and mark the current SHA1 as bad. 1148 # 1149 # Note, as with all race bugs, there's no guarantee that if 1150 # it succeeds, it is really a good bisect. But it helps in case 1151 # the bug is some what reliable. 1152 # 1153 # You can set BISECT_TRIES to zero, and all tests will be considered 1154 # good, unless you also set BISECT_MANUAL. 1155 # 1156 # BISECT_RET_GOOD = 0 (optional, default undefined) 1157 # 1158 # In case the specificed test returns something other than just 1159 # 0 for good, and non-zero for bad, you can override 0 being 1160 # good by defining BISECT_RET_GOOD. 1161 # 1162 # BISECT_RET_BAD = 1 (optional, default undefined) 1163 # 1164 # In case the specificed test returns something other than just 1165 # 0 for good, and non-zero for bad, you can override non-zero being 1166 # bad by defining BISECT_RET_BAD. 1167 # 1168 # BISECT_RET_ABORT = 255 (optional, default undefined) 1169 # 1170 # If you need to abort the bisect if the test discovers something 1171 # that was wrong, you can define BISECT_RET_ABORT to be the error 1172 # code returned by the test in order to abort the bisect. 1173 # 1174 # BISECT_RET_SKIP = 2 (optional, default undefined) 1175 # 1176 # If the test detects that the current commit is neither good 1177 # nor bad, but something else happened (another bug detected) 1178 # you can specify BISECT_RET_SKIP to an error code that the 1179 # test returns when it should skip the current commit. 1180 # 1181 # BISECT_RET_DEFAULT = good (optional, default undefined) 1182 # 1183 # You can override the default of what to do when the above 1184 # options are not hit. This may be one of, "good", "bad", 1185 # "abort" or "skip" (without the quotes). 1186 # 1187 # Note, if you do not define any of the previous BISECT_RET_* 1188 # and define BISECT_RET_DEFAULT, all bisects results will do 1189 # what the BISECT_RET_DEFAULT has. 1190 # 1191 # 1192 # Example: 1193 # TEST_START 1194 # TEST_TYPE = bisect 1195 # BISECT_GOOD = v2.6.36 1196 # BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e 1197 # BISECT_TYPE = build 1198 # MIN_CONFIG = /home/test/config-bisect 1199 # 1200 # 1201 # 1202 # For TEST_TYPE = config_bisect 1203 # 1204 # In those cases that you have two different configs. One of them 1205 # work, the other does not, and you do not know what config causes 1206 # the problem. 1207 # The TEST_TYPE config_bisect will bisect the bad config looking for 1208 # what config causes the failure. 1209 # 1210 # The way it works is this: 1211 # 1212 # You can specify a good config with CONFIG_BISECT_GOOD, otherwise it 1213 # will use the MIN_CONFIG, and if that's not specified, it will use 1214 # the config that comes with "make defconfig". 1215 # 1216 # It runs both the good and bad configs through a make oldconfig to 1217 # make sure that they are set up for the kernel that is checked out. 1218 # 1219 # It then reads the configs that are set, as well as the ones that are 1220 # not set for both the good and bad configs, and then compares them. 1221 # It will set half of the good configs within the bad config (note, 1222 # "set" means to make the bad config match the good config, a config 1223 # in the good config that is off, will be turned off in the bad 1224 # config. That is considered a "set"). 1225 # 1226 # It tests this new config and if it works, it becomes the new good 1227 # config, otherwise it becomes the new bad config. It continues this 1228 # process until there's only one config left and it will report that 1229 # config. 1230 # 1231 # The "bad config" can also be a config that is needed to boot but was 1232 # disabled because it depended on something that wasn't set. 1233 # 1234 # During this process, it saves the current good and bad configs in 1235 # ${TMP_DIR}/good_config and ${TMP_DIR}/bad_config respectively. 1236 # If you stop the test, you can copy them to a new location to 1237 # reuse them again. 1238 # 1239 # Although the MIN_CONFIG may be the config it starts with, the 1240 # MIN_CONFIG is ignored. 1241 # 1242 # The option BUILD_TYPE will be ignored. 1243 # 1244 # CONFIG_BISECT_TYPE is the type of test to perform: 1245 # build - bad fails to build 1246 # boot - bad builds but fails to boot 1247 # test - bad boots but fails a test 1248 # 1249 # CONFIG_BISECT is the config that failed to boot 1250 # 1251 # If BISECT_MANUAL is set, it will pause between iterations. 1252 # This is useful to use just ktest.pl just for the config bisect. 1253 # If you set it to build, it will run the bisect and you can 1254 # control what happens in between iterations. It will ask you if 1255 # the test succeeded or not and continue the config bisect. 1256 # 1257 # CONFIG_BISECT_GOOD (optional) 1258 # If you have a good config to start with, then you 1259 # can specify it with CONFIG_BISECT_GOOD. Otherwise 1260 # the MIN_CONFIG is the base, if MIN_CONFIG is not set 1261 # It will build a config with "make defconfig" 1262 # 1263 # CONFIG_BISECT_CHECK (optional) 1264 # Set this to 1 if you want to confirm that the config ktest 1265 # generates (the bad config with the min config) is still bad. 1266 # It may be that the min config fixes what broke the bad config 1267 # and the test will not return a result. 1268 # Set it to "good" to test only the good config and set it 1269 # to "bad" to only test the bad config. 1270 # 1271 # CONFIG_BISECT_EXEC (optional) 1272 # The config bisect is a separate program that comes with ktest.pl. 1273 # By default, it will look for: 1274 # `pwd`/config-bisect.pl # the location ktest.pl was executed from. 1275 # If it does not find it there, it will look for: 1276 # `dirname <ktest.pl>`/config-bisect.pl # The directory that holds ktest.pl 1277 # If it does not find it there, it will look for: 1278 # ${BUILD_DIR}/tools/testing/ktest/config-bisect.pl 1279 # Setting CONFIG_BISECT_EXEC will override where it looks. 1280 # 1281 # Example: 1282 # TEST_START 1283 # TEST_TYPE = config_bisect 1284 # CONFIG_BISECT_TYPE = build 1285 # CONFIG_BISECT = /home/test/config-bad 1286 # MIN_CONFIG = /home/test/config-min 1287 # BISECT_MANUAL = 1 1288 # 1289 # 1290 # 1291 # For TEST_TYPE = make_min_config 1292 # 1293 # After doing a make localyesconfig, your kernel configuration may 1294 # not be the most useful minimum configuration. Having a true minimum 1295 # config that you can use against other configs is very useful if 1296 # someone else has a config that breaks on your code. By only forcing 1297 # those configurations that are truly required to boot your machine 1298 # will give you less of a chance that one of your set configurations 1299 # will make the bug go away. This will give you a better chance to 1300 # be able to reproduce the reported bug matching the broken config. 1301 # 1302 # Note, this does take some time, and may require you to run the 1303 # test over night, or perhaps over the weekend. But it also allows 1304 # you to interrupt it, and gives you the current minimum config 1305 # that was found till that time. 1306 # 1307 # Note, this test automatically assumes a BUILD_TYPE of oldconfig 1308 # and its test type acts like boot. 1309 # TODO: add a test version that makes the config do more than just 1310 # boot, like having network access. 1311 # 1312 # To save time, the test does not just grab any option and test 1313 # it. The Kconfig files are examined to determine the dependencies 1314 # of the configs. If a config is chosen that depends on another 1315 # config, that config will be checked first. By checking the 1316 # parents first, we can eliminate whole groups of configs that 1317 # may have been enabled. 1318 # 1319 # For example, if a USB device config is chosen and depends on CONFIG_USB, 1320 # the CONFIG_USB will be tested before the device. If CONFIG_USB is 1321 # found not to be needed, it, as well as all configs that depend on 1322 # it, will be disabled and removed from the current min_config. 1323 # 1324 # OUTPUT_MIN_CONFIG is the path and filename of the file that will 1325 # be created from the MIN_CONFIG. If you interrupt the test, set 1326 # this file as your new min config, and use it to continue the test. 1327 # This file does not need to exist on start of test. 1328 # This file is not created until a config is found that can be removed. 1329 # If this file exists, you will be prompted if you want to use it 1330 # as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG 1331 # is not defined. 1332 # (required field) 1333 # 1334 # START_MIN_CONFIG is the config to use to start the test with. 1335 # you can set this as the same OUTPUT_MIN_CONFIG, but if you do 1336 # the OUTPUT_MIN_CONFIG file must exist. 1337 # (default MIN_CONFIG) 1338 # 1339 # IGNORE_CONFIG is used to specify a config file that has configs that 1340 # you already know must be set. Configs are written here that have 1341 # been tested and proved to be required. It is best to define this 1342 # file if you intend on interrupting the test and running it where 1343 # it left off. New configs that it finds will be written to this file 1344 # and will not be tested again in later runs. 1345 # (optional) 1346 # 1347 # MIN_CONFIG_TYPE can be either 'boot' or 'test'. With 'boot' it will 1348 # test if the created config can just boot the machine. If this is 1349 # set to 'test', then the TEST option must be defined and the created 1350 # config will not only boot the target, but also make sure that the 1351 # config lets the test succeed. This is useful to make sure the final 1352 # config that is generated allows network activity (ssh). 1353 # (optional) 1354 # 1355 # USE_OUTPUT_MIN_CONFIG set this to 1 if you do not want to be prompted 1356 # about using the OUTPUT_MIN_CONFIG as the MIN_CONFIG as the starting 1357 # point. Set it to 0 if you want to always just use the given MIN_CONFIG. 1358 # If it is not defined, it will prompt you to pick which config 1359 # to start with (MIN_CONFIG or OUTPUT_MIN_CONFIG). 1360 # 1361 # Example: 1362 # 1363 # TEST_TYPE = make_min_config 1364 # OUTPUT_MIN_CONFIG = /path/to/config-new-min 1365 # START_MIN_CONFIG = /path/to/config-min 1366 # IGNORE_CONFIG = /path/to/config-tested 1367 # MIN_CONFIG_TYPE = test 1368 # TEST = ssh ${USER}@${MACHINE} echo hi 1369 # 1370 # 1371 # 1372 # 1373 # For TEST_TYPE = make_warnings_file 1374 # 1375 # If you want the build to fail when a new warning is discovered 1376 # you set the WARNINGS_FILE to point to a file of known warnings. 1377 # 1378 # The test "make_warnings_file" will let you create a new warnings 1379 # file before you run other tests, like patchcheck. 1380 # 1381 # What this test does is to run just a build, you still need to 1382 # specify BUILD_TYPE to tell the test what type of config to use. 1383 # A BUILD_TYPE of nobuild will fail this test. 1384 # 1385 # The test will do the build and scan for all warnings. Any warning 1386 # it discovers will be saved in the WARNINGS_FILE (required) option. 1387 # 1388 # It is recommended (but not necessary) to make sure BUILD_NOCLEAN is 1389 # off, so that a full build is done (make mrproper is performed). 1390 # That way, all warnings will be captured. 1391 # 1392 # Example: 1393 # 1394 # TEST_TYPE = make_warnings_file 1395 # WARNINGS_FILE = ${OUTPUT_DIR} 1396 # BUILD_TYPE = useconfig:oldconfig 1397 # CHECKOUT = v3.8 1398 # BUILD_NOCLEAN = 0 1399 #
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.