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