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