blob: 0a290fb4cd5e746b278001719c4e2e518106b83b [file] [log] [blame]
Steven Rostedta75fece2010-11-02 14:58:27 -04001#
Steven Rostedta57419b2010-11-02 15:13:54 -04002# Config file for ktest.pl
Steven Rostedta75fece2010-11-02 14:58:27 -04003#
4# Note, all paths must be absolute
5#
6
Steven Rostedta57419b2010-11-02 15:13:54 -04007# Options set in the beginning of the file are considered to be
8# default options. These options can be overriden by test specific
9# options, with the following exceptions:
Steven Rostedta75fece2010-11-02 14:58:27 -040010#
Steven Rostedta75fece2010-11-02 14:58:27 -040011# LOG_FILE
12# CLEAR_LOG
13# POWEROFF_ON_SUCCESS
14# REBOOT_ON_SUCCESS
15#
Steven Rostedta57419b2010-11-02 15:13:54 -040016# Test specific options are set after the label:
17#
18# TEST_START
19#
20# The options after a TEST_START label are specific to that test.
21# Each TEST_START label will set up a new test. If you want to
22# perform a test more than once, you can add the ITERATE label
23# to it followed by the number of times you want that test
24# to iterate. If the ITERATE is left off, the test will only
25# be performed once.
26#
27# TEST_START ITERATE 10
28#
29# You can skip a test by adding SKIP (before or after the ITERATE
30# and number)
31#
32# TEST_START SKIP
33#
34# TEST_START SKIP ITERATE 10
35#
36# TEST_START ITERATE 10 SKIP
37#
38# The SKIP label causes the options and the test itself to be ignored.
39# This is useful to set up several different tests in one config file, and
40# only enabling the ones you want to use for a current test run.
41#
42# You can add default options anywhere in the file as well
43# with the DEFAULTS tag. This allows you to have default options
44# after the test options to keep the test options at the top
45# of the file. You can even place the DEFAULTS tag between
46# test cases (but not in the middle of a single test case)
47#
48# TEST_START
49# MIN_CONFIG = /home/test/config-test1
50#
51# DEFAULTS
52# MIN_CONFIG = /home/test/config-default
53#
54# TEST_START ITERATE 10
55#
56# The above will run the first test with MIN_CONFIG set to
57# /home/test/config-test-1. Then 10 tests will be executed
58# with MIN_CONFIG with /home/test/config-default.
59#
60# You can also disable defaults with the SKIP option
61#
62# DEFAULTS SKIP
63# MIN_CONFIG = /home/test/config-use-sometimes
64#
65# DEFAULTS
66# MIN_CONFIG = /home/test/config-most-times
67#
68# The above will ignore the first MIN_CONFIG. If you want to
69# use the first MIN_CONFIG, remove the SKIP from the first
70# DEFAULTS tag and add it to the second. Be careful, options
71# may only be declared once per test or default. If you have
72# the same option name under the same test or as default
73# ktest will fail to execute, and no tests will run.
74#
Steven Rostedt3d1cc412011-09-30 22:14:21 -040075# DEFAULTS OVERRIDE
76#
77# Options defined in the DEFAULTS section can not be duplicated
78# even if they are defined in two different DEFAULT sections.
79# This is done to catch mistakes where an option is added but
80# the previous option was forgotten about and not commented.
81#
82# The OVERRIDE keyword can be added to a section to allow this
83# section to override other DEFAULT sections values that have
84# been defined previously. It will only override options that
85# have been defined before its use. Options defined later
86# in a non override section will still error. The same option
87# can not be defined in the same section even if that section
88# is marked OVERRIDE.
89#
Steven Rostedtab7a3f52011-09-30 20:24:07 -040090#
91#
Steven Rostedt45d73a52011-09-30 19:44:53 -040092# Both TEST_START and DEFAULTS sections can also have the IF keyword
93# The value after the IF must evaluate into a 0 or non 0 positive
94# integer, and can use the config variables (explained below).
95#
96# DEFAULTS IF ${IS_X86_32}
97#
98# The above will process the DEFAULTS section if the config
99# variable IS_X86_32 evaluates to a non zero positive integer
100# otherwise if it evaluates to zero, it will act the same
101# as if the SKIP keyword was used.
102#
103# The ELSE keyword can be used directly after a section with
104# a IF statement.
105#
106# TEST_START IF ${RUN_NET_TESTS}
107# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
108#
109# ELSE
110#
111# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-normal
112#
113#
114# The ELSE keyword can also contain an IF statement to allow multiple
115# if then else sections. But all the sections must be either
116# DEFAULT or TEST_START, they can not be a mixture.
117#
118# TEST_START IF ${RUN_NET_TESTS}
119# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
120#
121# ELSE IF ${RUN_DISK_TESTS}
122# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-tests
123#
124# ELSE IF ${RUN_CPU_TESTS}
125# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-cpu
126#
127# ELSE
128# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
129#
Steven Rostedtab7a3f52011-09-30 20:24:07 -0400130# The if statement may also have comparisons that will and for
131# == and !=, strings may be used for both sides.
132#
133# BOX_TYPE := x86_32
134#
135# DEFAULTS IF ${BOX_TYPE} == x86_32
136# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-32
137# ELSE
138# BUILD_TYPE = useconfig:${CONFIG_DIR}/config-64
139#
Steven Rostedt9900b5d2011-09-30 22:41:14 -0400140# The DEFINED keyword can be used by the IF statements too.
141# It returns true if the given config variable or option has been defined
142# or false otherwise.
143#
144#
145# DEFAULTS IF DEFINED USE_CC
146# CC := ${USE_CC}
147# ELSE
148# CC := gcc
149#
150#
151# As well as NOT DEFINED.
152#
153# DEFAULTS IF NOT DEFINED MAKE_CMD
154# MAKE_CMD := make ARCH=x86
155#
156#
Steven Rostedt8d735212011-10-17 11:36:44 -0400157# And/or ops (&&,||) may also be used to make complex conditionals.
158#
159# TEST_START IF (DEFINED ALL_TESTS || ${MYTEST} == boottest) && ${MACHINE} == gandalf
160#
Jesper Juhl11c38b72012-04-16 19:40:24 +0200161# Notice the use of parentheses. Without any parentheses the above would be
Steven Rostedt8d735212011-10-17 11:36:44 -0400162# processed the same as:
163#
164# TEST_START IF DEFINED ALL_TESTS || (${MYTEST} == boottest && ${MACHINE} == gandalf)
165#
166#
Steven Rostedt2ed3b162011-09-30 21:00:00 -0400167#
168# INCLUDE file
169#
170# The INCLUDE keyword may be used in DEFAULT sections. This will
171# read another config file and process that file as well. The included
172# file can include other files, add new test cases or default
173# statements. Config variables will be passed to these files and changes
174# to config variables will be seen by top level config files. Including
175# a file is processed just like the contents of the file was cut and pasted
176# into the top level file, except, that include files that end with
177# TEST_START sections will have that section ended at the end of
178# the include file. That is, an included file is included followed
179# by another DEFAULT keyword.
180#
181# Unlike other files referenced in this config, the file path does not need
182# to be absolute. If the file does not start with '/', then the directory
183# that the current config file was located in is used. If no config by the
184# given name is found there, then the current directory is searched.
185#
186# INCLUDE myfile
187# DEFAULT
188#
189# is the same as:
190#
191# INCLUDE myfile
192#
193# Note, if the include file does not contain a full path, the file is
194# searched first by the location of the original include file, and then
195# by the location that ktest.pl was executed in.
196#
Steven Rostedta75fece2010-11-02 14:58:27 -0400197
Steven Rostedt77d942c2011-05-20 13:36:58 -0400198#### Config variables ####
199#
200# This config file can also contain "config variables".
201# These are assigned with ":=" instead of the ktest option
202# assigment "=".
203#
204# The difference between ktest options and config variables
205# is that config variables can be used multiple times,
206# where each instance will override the previous instance.
207# And that they only live at time of processing this config.
208#
209# The advantage to config variables are that they can be used
210# by any option or any other config variables to define thing
211# that you may use over and over again in the options.
212#
213# For example:
214#
215# USER := root
216# TARGET := mybox
217# TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
218#
219# TEST_START
220# MIN_CONFIG = config1
221# TEST = ${TEST_CASE}
222#
223# TEST_START
224# MIN_CONFIG = config2
225# TEST = ${TEST_CASE}
226#
227# TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
228#
229# TEST_START
230# MIN_CONFIG = config1
231# TEST = ${TEST_CASE}
232#
233# TEST_START
234# MIN_CONFIG = config2
235# TEST = ${TEST_CASE}
236#
237# TEST_DIR := /home/me/test
238#
239# BUILD_DIR = ${TEST_DIR}/linux.git
240# OUTPUT_DIR = ${TEST_DIR}/test
241#
242# Note, the config variables are evaluated immediately, thus
243# updating TARGET after TEST_CASE has been assigned does nothing
244# to TEST_CASE.
245#
246# As shown in the example, to evaluate a config variable, you
247# use the ${X} convention. Simple $X will not work.
248#
249# If the config variable does not exist, the ${X} will not
250# be evaluated. Thus:
251#
252# MAKE_CMD = PATH=/mypath:${PATH} make
253#
254# If PATH is not a config variable, then the ${PATH} in
255# the MAKE_CMD option will be evaluated by the shell when
256# the MAKE_CMD option is passed into shell processing.
Steven Rostedta57419b2010-11-02 15:13:54 -0400257
Steven Rostedt2a625122011-05-20 15:48:59 -0400258#### Using options in other options ####
259#
260# Options that are defined in the config file may also be used
261# by other options. All options are evaulated at time of
262# use (except that config variables are evaluated at config
263# processing time).
264#
265# If an ktest option is used within another option, instead of
266# typing it again in that option you can simply use the option
267# just like you can config variables.
268#
269# MACHINE = mybox
270#
271# TEST = ssh root@${MACHINE} /path/to/test
272#
273# The option will be used per test case. Thus:
274#
275# TEST_TYPE = test
276# TEST = ssh root@{MACHINE}
277#
278# TEST_START
279# MACHINE = box1
280#
281# TEST_START
282# MACHINE = box2
283#
284# For both test cases, MACHINE will be evaluated at the time
285# of the test case. The first test will run ssh root@box1
286# and the second will run ssh root@box2.
287
Steven Rostedta57419b2010-11-02 15:13:54 -0400288#### Mandatory Default Options ####
289
290# These options must be in the default section, although most
291# may be overridden by test options.
Steven Rostedta75fece2010-11-02 14:58:27 -0400292
293# The machine hostname that you will test
294#MACHINE = target
295
296# The box is expected to have ssh on normal bootup, provide the user
297# (most likely root, since you need privileged operations)
298#SSH_USER = root
299
300# The directory that contains the Linux source code
301#BUILD_DIR = /home/test/linux.git
302
303# The directory that the objects will be built
304# (can not be same as BUILD_DIR)
305#OUTPUT_DIR = /home/test/build/target
306
307# The location of the compiled file to copy to the target
308# (relative to OUTPUT_DIR)
309#BUILD_TARGET = arch/x86/boot/bzImage
310
311# The place to put your image on the test machine
312#TARGET_IMAGE = /boot/vmlinuz-test
313
314# A script or command to reboot the box
Steven Rostedta57419b2010-11-02 15:13:54 -0400315#
Steven Rostedta75fece2010-11-02 14:58:27 -0400316# Here is a digital loggers power switch example
317#POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
Steven Rostedta57419b2010-11-02 15:13:54 -0400318#
Steven Rostedta75fece2010-11-02 14:58:27 -0400319# Here is an example to reboot a virtual box on the current host
320# with the name "Guest".
Steven Rostedta57419b2010-11-02 15:13:54 -0400321#POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
Steven Rostedta75fece2010-11-02 14:58:27 -0400322
323# The script or command that reads the console
Steven Rostedta57419b2010-11-02 15:13:54 -0400324#
Steven Rostedta75fece2010-11-02 14:58:27 -0400325# If you use ttywatch server, something like the following would work.
326#CONSOLE = nc -d localhost 3001
Steven Rostedta57419b2010-11-02 15:13:54 -0400327#
Steven Rostedta75fece2010-11-02 14:58:27 -0400328# For a virtual machine with guest name "Guest".
Steven Rostedta57419b2010-11-02 15:13:54 -0400329#CONSOLE = virsh console Guest
Steven Rostedta75fece2010-11-02 14:58:27 -0400330
331# Required version ending to differentiate the test
332# from other linux builds on the system.
333#LOCALVERSION = -test
334
Steven Rostedta15ba912012-11-13 14:30:37 -0500335# For REBOOT_TYPE = grub2, you must specify where the grub.cfg
336# file is. This is the file that is searched to find the menu
337# option to boot to with GRUB_REBOOT
338#GRUB_FILE = /boot/grub2/grub.cfg
339
340# The tool for REBOOT_TYPE = grub2 to set the next reboot kernel
341# to boot into (one shot mode).
342# (default grub2_reboot)
343#GRUB_REBOOT = grub2_reboot
344
Steven Rostedta75fece2010-11-02 14:58:27 -0400345# The grub title name for the test kernel to boot
Steven Rostedta15ba912012-11-13 14:30:37 -0500346# (Only mandatory if REBOOT_TYPE = grub or grub2)
Steven Rostedta75fece2010-11-02 14:58:27 -0400347#
Steven Rostedta57419b2010-11-02 15:13:54 -0400348# Note, ktest.pl will not update the grub menu.lst, you need to
349# manually add an option for the test. ktest.pl will search
350# the grub menu.lst for this option to find what kernel to
351# reboot into.
352#
Steven Rostedta75fece2010-11-02 14:58:27 -0400353# For example, if in the /boot/grub/menu.lst the test kernel title has:
354# title Test Kernel
Steven Rostedta57419b2010-11-02 15:13:54 -0400355# kernel vmlinuz-test
Steven Rostedta15ba912012-11-13 14:30:37 -0500356#
357# For grub2, a search of top level "menuentry"s are done. No
358# submenu is searched. The menu is found by searching for the
359# contents of GRUB_MENU in the line that starts with "menuentry".
360# You may want to include the quotes around the option. For example:
361# for: menuentry 'Test Kernel'
362# do a: GRUB_MENU = 'Test Kernel'
363# For customizing, add your entry in /etc/grub.d/40_custom.
364#
Steven Rostedta75fece2010-11-02 14:58:27 -0400365#GRUB_MENU = Test Kernel
366
Steven Rostedt77869542012-12-11 17:37:41 -0500367# For REBOOT_TYPE = syslinux, the name of the syslinux executable
368# (on the target) to use to set up the next reboot to boot the
369# test kernel.
370# (default extlinux)
371#SYSLINUX = syslinux
372
373# For REBOOT_TYPE = syslinux, the path that is passed to to the
374# syslinux command where syslinux is installed.
375# (default /boot/extlinux)
376#SYSLINUX_PATH = /boot/syslinux
377
378# For REBOOT_TYPE = syslinux, the syslinux label that references the
379# test kernel in the syslinux config file.
380# (default undefined)
381#SYSLINUX_LABEL = "test-kernel"
382
Steven Rostedta75fece2010-11-02 14:58:27 -0400383# A script to reboot the target into the test kernel
Steven Rostedt96f6a0d2011-12-23 00:24:51 -0500384# This and SWITCH_TO_TEST are about the same, except
385# SWITCH_TO_TEST is run even for REBOOT_TYPE = grub.
386# This may be left undefined.
387# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400388#REBOOT_SCRIPT =
389
390#### Optional Config Options (all have defaults) ####
391
Steven Rostedta57419b2010-11-02 15:13:54 -0400392# Start a test setup. If you leave this off, all options
393# will be default and the test will run once.
394# This is a label and not really an option (it takes no value).
395# You can append ITERATE and a number after it to iterate the
396# test a number of times, or SKIP to ignore this test.
397#
398#TEST_START
399#TEST_START ITERATE 5
400#TEST_START SKIP
Steven Rostedta75fece2010-11-02 14:58:27 -0400401
Steven Rostedtdc895682010-11-02 15:22:53 -0400402# Have the following options as default again. Used after tests
403# have already been defined by TEST_START. Optionally, you can
404# just define all default options before the first TEST_START
405# and you do not need this option.
406#
407# This is a label and not really an option (it takes no value).
408# You can append SKIP to this label and the options within this
409# section will be ignored.
410#
411# DEFAULTS
412# DEFAULTS SKIP
413
Steven Rostedt921ed4c2012-07-19 15:18:27 -0400414# If you want to execute some command before the first test runs
415# you can set this option. Note, it can be set as a default option
416# or an option in the first test case. All other test cases will
417# ignore it. If both the default and first test have this option
418# set, then the first test will take precedence.
419#
420# default (undefined)
421#PRE_KTEST = ${SSH} ~/set_up_test
422
423# If you want to execute some command after all the tests have
424# completed, you can set this option. Note, it can be set as a
425# default or any test case can override it. If multiple test cases
426# set this option, then the last test case that set it will take
427# precedence
428#
429# default (undefined)
430#POST_KTEST = ${SSH} ~/dismantle_test
431
Steven Rostedta75fece2010-11-02 14:58:27 -0400432# The default test type (default test)
433# The test types may be:
Steven Rostedtcd8e3682011-08-18 16:35:44 -0400434# build - only build the kernel, do nothing else
435# install - build and install, but do nothing else (does not reboot)
436# boot - build, install, and boot the kernel
437# test - build, boot and if TEST is set, run the test script
Steven Rostedta57419b2010-11-02 15:13:54 -0400438# (If TEST is not set, it defaults back to boot)
Steven Rostedta75fece2010-11-02 14:58:27 -0400439# bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
440# patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
441#TEST_TYPE = test
442
Steven Rostedta57419b2010-11-02 15:13:54 -0400443# Test to run if there is a successful boot and TEST_TYPE is test.
444# Must exit with 0 on success and non zero on error
445# default (undefined)
446#TEST = ssh user@machine /root/run_test
447
448# The build type is any make config type or special command
Steven Rostedta75fece2010-11-02 14:58:27 -0400449# (default randconfig)
450# nobuild - skip the clean and build step
Steven Rostedta57419b2010-11-02 15:13:54 -0400451# useconfig:/path/to/config - use the given config and run
452# oldconfig on it.
453# This option is ignored if TEST_TYPE is patchcheck or bisect
Steven Rostedta75fece2010-11-02 14:58:27 -0400454#BUILD_TYPE = randconfig
455
456# The make command (default make)
457# If you are building a 32bit x86 on a 64 bit host
458#MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
459
Steven Rostedtdc895682010-11-02 15:22:53 -0400460# Any build options for the make of the kernel (not for other makes, like configs)
461# (default "")
462#BUILD_OPTIONS = -j20
463
Steven Rostedte5c2ec12012-07-19 15:22:05 -0400464# If you need to do some special handling before installing
465# you can add a script with this option.
466# The environment variable KERNEL_VERSION will be set to the
467# kernel version that is used.
468#
469# default (undefined)
470#PRE_INSTALL = ssh user@target rm -rf '/lib/modules/*-test*'
471
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400472# If you need an initrd, you can add a script or code here to install
473# it. The environment variable KERNEL_VERSION will be set to the
Steven Rostedta57419b2010-11-02 15:13:54 -0400474# kernel version that is used. Remember to add the initrd line
475# to your grub menu.lst file.
476#
477# Here's a couple of examples to use:
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400478#POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
Steven Rostedta57419b2010-11-02 15:13:54 -0400479#
480# or on some systems:
481#POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400482
Steven Rostedte0a87422011-09-30 17:50:48 -0400483# If for some reason you just want to boot the kernel and you do not
484# want the test to install anything new. For example, you may just want
485# to boot test the same kernel over and over and do not want to go through
486# the hassle of installing anything, you can set this option to 1
487# (default 0)
488#NO_INSTALL = 1
489
Steven Rostedt921ed4c2012-07-19 15:18:27 -0400490# If there is a command that you want to run before the individual test
491# case executes, then you can set this option
492#
493# default (undefined)
494#PRE_TEST = ${SSH} reboot_to_special_kernel
495
496# If there is a command you want to run after the individual test case
497# completes, then you can set this option.
498#
499# default (undefined)
500#POST_TEST = cd ${BUILD_DIR}; git reset --hard
501
Steven Rostedt0bd6c1a2011-06-14 20:39:31 -0400502# If there is a script that you require to run before the build is done
503# you can specify it with PRE_BUILD.
504#
505# One example may be if you must add a temporary patch to the build to
506# fix a unrelated bug to perform a patchcheck test. This will apply the
507# patch before each build that is made. Use the POST_BUILD to do a git reset --hard
508# to remove the patch.
509#
510# (default undef)
511#PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
512
513# To specify if the test should fail if the PRE_BUILD fails,
514# PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
515# result is ignored.
516# (default 0)
517# PRE_BUILD_DIE = 1
518
519# If there is a script that should run after the build is done
520# you can specify it with POST_BUILD.
521#
522# As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
523# made by the PRE_BUILD.
524#
525# (default undef)
526#POST_BUILD = cd ${BUILD_DIR} && git reset --hard
527
528# To specify if the test should fail if the POST_BUILD fails,
529# POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
530# result is ignored.
531# (default 0)
532#POST_BUILD_DIE = 1
533
Steven Rostedta75fece2010-11-02 14:58:27 -0400534# Way to reboot the box to the test kernel.
Steven Rostedt77869542012-12-11 17:37:41 -0500535# Only valid options so far are "grub", "grub2", "syslinux" and "script"
Steven Rostedta75fece2010-11-02 14:58:27 -0400536# (default grub)
537# If you specify grub, it will assume grub version 1
538# and will search in /boot/grub/menu.lst for the title $GRUB_MENU
539# and select that target to reboot to the kernel. If this is not
540# your setup, then specify "script" and have a command or script
541# specified in REBOOT_SCRIPT to boot to the target.
Steven Rostedta57419b2010-11-02 15:13:54 -0400542#
Steven Rostedta15ba912012-11-13 14:30:37 -0500543# For REBOOT_TYPE = grub2, you must define both GRUB_MENU and
544# GRUB_FILE.
545#
Steven Rostedt77869542012-12-11 17:37:41 -0500546# For REBOOT_TYPE = syslinux, you must define SYSLINUX_LABEL, and
547# perhaps modify SYSLINUX (default extlinux) and SYSLINUX_PATH
548# (default /boot/extlinux)
549#
Steven Rostedta57419b2010-11-02 15:13:54 -0400550# The entry in /boot/grub/menu.lst must be entered in manually.
551# The test will not modify that file.
Steven Rostedta75fece2010-11-02 14:58:27 -0400552#REBOOT_TYPE = grub
553
Steven Rostedtbc7c5802011-12-22 16:29:10 -0500554# If you are using a machine that doesn't boot with grub, and
555# perhaps gets its kernel from a remote server (tftp), then
556# you can use this option to update the target image with the
557# test image.
558#
559# You could also do the same with POST_INSTALL, but the difference
560# between that option and this option is that POST_INSTALL runs
561# after the install, where this one runs just before a reboot.
562# (default undefined)
563#SWITCH_TO_TEST = cp ${OUTPUT_DIR}/${BUILD_TARGET} ${TARGET_IMAGE}
564
565# If you are using a machine that doesn't boot with grub, and
566# perhaps gets its kernel from a remote server (tftp), then
567# you can use this option to update the target image with the
568# the known good image to reboot safely back into.
569#
570# This option holds a command that will execute before needing
571# to reboot to a good known image.
572# (default undefined)
573#SWITCH_TO_GOOD = ssh ${SSH_USER}/${MACHINE} cp good_image ${TARGET_IMAGE}
574
Steven Rostedta75fece2010-11-02 14:58:27 -0400575# The min config that is needed to build for the machine
Steven Rostedta57419b2010-11-02 15:13:54 -0400576# A nice way to create this is with the following:
Steven Rostedta75fece2010-11-02 14:58:27 -0400577#
Steven Rostedta57419b2010-11-02 15:13:54 -0400578# $ ssh target
579# $ lsmod > mymods
580# $ scp mymods host:/tmp
581# $ exit
582# $ cd linux.git
583# $ rm .config
584# $ make LSMOD=mymods localyesconfig
585# $ grep '^CONFIG' .config > /home/test/config-min
586#
587# If you want even less configs:
588#
589# log in directly to target (do not ssh)
590#
591# $ su
592# # lsmod | cut -d' ' -f1 | xargs rmmod
593#
594# repeat the above several times
595#
596# # lsmod > mymods
597# # reboot
598#
599# May need to reboot to get your network back to copy the mymods
600# to the host, and then remove the previous .config and run the
601# localyesconfig again. The CONFIG_MIN generated like this will
602# not guarantee network activity to the box so the TEST_TYPE of
603# test may fail.
604#
605# You might also want to set:
Steven Rostedta75fece2010-11-02 14:58:27 -0400606# CONFIG_CMDLINE="<your options here>"
607# randconfig may set the above and override your real command
608# line options.
Steven Rostedta57419b2010-11-02 15:13:54 -0400609# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400610#MIN_CONFIG = /home/test/config-min
611
612# Sometimes there's options that just break the boot and
613# you do not care about. Here are a few:
614# # CONFIG_STAGING is not set
615# Staging drivers are horrible, and can break the build.
616# # CONFIG_SCSI_DEBUG is not set
617# SCSI_DEBUG may change your root partition
618# # CONFIG_KGDB_SERIAL_CONSOLE is not set
619# KGDB may cause oops waiting for a connection that's not there.
620# This option points to the file containing config options that will be prepended
621# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
Steven Rostedta57419b2010-11-02 15:13:54 -0400622#
623# Note, config options in MIN_CONFIG will override these options.
624#
625# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400626#ADD_CONFIG = /home/test/config-broken
627
Steven Rostedtdc895682010-11-02 15:22:53 -0400628# The location on the host where to write temp files
Steven Rostedt48920632011-06-14 20:42:19 -0400629# (default /tmp/ktest/${MACHINE})
630#TMP_DIR = /tmp/ktest/${MACHINE}
Steven Rostedtdc895682010-11-02 15:22:53 -0400631
632# Optional log file to write the status (recommended)
633# Note, this is a DEFAULT section only option.
634# (default undefined)
635#LOG_FILE = /home/test/logfiles/target.log
636
637# Remove old logfile if it exists before starting all tests.
638# Note, this is a DEFAULT section only option.
639# (default 0)
640#CLEAR_LOG = 0
641
642# Line to define a successful boot up in console output.
643# This is what the line contains, not the entire line. If you need
644# the entire line to match, then use regural expression syntax like:
645# (do not add any quotes around it)
646#
647# SUCCESS_LINE = ^MyBox Login:$
648#
649# (default "login:")
650#SUCCESS_LINE = login:
651
Steven Rostedt2b803362011-09-30 18:00:23 -0400652# To speed up between reboots, defining a line that the
653# default kernel produces that represents that the default
654# kernel has successfully booted and can be used to pass
655# a new test kernel to it. Otherwise ktest.pl will wait till
656# SLEEP_TIME to continue.
657# (default undefined)
658#REBOOT_SUCCESS_LINE = login:
659
Steven Rostedt1c8a6172010-11-09 12:55:40 -0500660# In case the console constantly fills the screen, having
661# a specified time to stop the test after success is recommended.
662# (in seconds)
663# (default 10)
664#STOP_AFTER_SUCCESS = 10
665
666# In case the console constantly fills the screen, having
667# a specified time to stop the test after failure is recommended.
668# (in seconds)
669# (default 60)
670#STOP_AFTER_FAILURE = 60
671
Steven Rostedt2d01b262011-03-08 09:47:54 -0500672# In case the console constantly fills the screen, having
673# a specified time to stop the test if it never succeeds nor fails
674# is recommended.
675# Note: this is ignored if a success or failure is detected.
676# (in seconds)
677# (default 600, -1 is to never stop)
678#STOP_TEST_AFTER = 600
679
Steven Rostedtdc895682010-11-02 15:22:53 -0400680# Stop testing if a build fails. If set, the script will end if
681# a failure is detected, otherwise it will save off the .config,
682# dmesg and bootlog in a directory called
683# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
684# if the STORE_FAILURES directory is set.
685# (default 1)
686# Note, even if this is set to zero, there are some errors that still
687# stop the tests.
688#DIE_ON_FAILURE = 1
689
690# Directory to store failure directories on failure. If this is not
691# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
692# bootlog. This option is ignored if DIE_ON_FAILURE is not set.
693# (default undefined)
694#STORE_FAILURES = /home/test/failures
695
Rabin Vincentde5b6e32011-11-18 17:05:31 +0530696# Directory to store success directories on success. If this is not
697# set, the .config, dmesg and bootlog will not be saved if a
698# test succeeds.
699# (default undefined)
700#STORE_SUCCESSES = /home/test/successes
701
Steven Rostedtdc895682010-11-02 15:22:53 -0400702# Build without doing a make mrproper, or removing .config
703# (default 0)
704#BUILD_NOCLEAN = 0
705
706# As the test reads the console, after it hits the SUCCESS_LINE
707# the time it waits for the monitor to settle down between reads
708# can usually be lowered.
709# (in seconds) (default 1)
710#BOOTED_TIMEOUT = 1
711
712# The timeout in seconds when we consider the box hung after
713# the console stop producing output. Be sure to leave enough
714# time here to get pass a reboot. Some machines may not produce
715# any console output for a long time during a reboot. You do
716# not want the test to fail just because the system was in
717# the process of rebooting to the test kernel.
718# (default 120)
719#TIMEOUT = 120
720
721# In between tests, a reboot of the box may occur, and this
722# is the time to wait for the console after it stops producing
723# output. Some machines may not produce a large lag on reboot
724# so this should accommodate it.
725# The difference between this and TIMEOUT, is that TIMEOUT happens
726# when rebooting to the test kernel. This sleep time happens
727# after a test has completed and we are about to start running
728# another test. If a reboot to the reliable kernel happens,
729# we wait SLEEP_TIME for the console to stop producing output
730# before starting the next test.
Steven Rostedt2b803362011-09-30 18:00:23 -0400731#
732# You can speed up reboot times even more by setting REBOOT_SUCCESS_LINE.
Steven Rostedtdc895682010-11-02 15:22:53 -0400733# (default 60)
734#SLEEP_TIME = 60
735
736# The time in between bisects to sleep (in seconds)
737# (default 60)
738#BISECT_SLEEP_TIME = 60
739
Steven Rostedt407b95b2012-07-19 16:05:42 -0400740# The max wait time (in seconds) for waiting for the console to finish.
741# If for some reason, the console is outputting content without
742# ever finishing, this will cause ktest to get stuck. This
743# option is the max time ktest will wait for the monitor (console)
744# to settle down before continuing.
745# (default 1800)
746#MAX_MONITOR_WAIT
747
Steven Rostedt27d934b2011-05-20 09:18:18 -0400748# The time in between patch checks to sleep (in seconds)
749# (default 60)
750#PATCHCHECK_SLEEP_TIME = 60
751
Steven Rostedtdc895682010-11-02 15:22:53 -0400752# Reboot the target box on error (default 0)
753#REBOOT_ON_ERROR = 0
754
755# Power off the target on error (ignored if REBOOT_ON_ERROR is set)
756# Note, this is a DEFAULT section only option.
757# (default 0)
758#POWEROFF_ON_ERROR = 0
759
760# Power off the target after all tests have completed successfully
761# Note, this is a DEFAULT section only option.
762# (default 0)
763#POWEROFF_ON_SUCCESS = 0
764
765# Reboot the target after all test completed successfully (default 1)
766# (ignored if POWEROFF_ON_SUCCESS is set)
767#REBOOT_ON_SUCCESS = 1
768
769# In case there are isses with rebooting, you can specify this
770# to always powercycle after this amount of time after calling
771# reboot.
772# Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
773# makes it powercycle immediately after rebooting. Do not define
774# it if you do not want it.
775# (default undefined)
776#POWERCYCLE_AFTER_REBOOT = 5
777
778# In case there's isses with halting, you can specify this
779# to always poweroff after this amount of time after calling
780# halt.
781# Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
782# makes it poweroff immediately after halting. Do not define
783# it if you do not want it.
784# (default undefined)
785#POWEROFF_AFTER_HALT = 20
786
787# A script or command to power off the box (default undefined)
788# Needed for POWEROFF_ON_ERROR and SUCCESS
789#
790# Example for digital loggers power switch:
791#POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
792#
793# Example for a virtual guest call "Guest".
794#POWER_OFF = virsh destroy Guest
795
Steven Rostedt (Red Hat)4283b162013-01-30 18:37:47 -0500796# To have the build fail on "new" warnings, create a file that
797# contains a list of all known warnings (they must match exactly
798# to the line with 'warning:', 'error:' or 'Error:'. If the option
799# WARNINGS_FILE is set, then that file will be read, and if the
800# build detects a warning, it will examine this file and if the
801# warning does not exist in it, it will fail the build.
802#
803# Note, if this option is defined to a file that does not exist
804# then any warning will fail the build.
805# (see make_warnings_file below)
806#
807# (optional, default undefined)
808#WARNINGS_FILE = ${OUTPUT_DIR}/warnings_file
809
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500810# The way to execute a command on the target
811# (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
812# The variables SSH_USER, MACHINE and SSH_COMMAND are defined
813#SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
814
Steven Rostedt02ad2612012-03-21 08:21:24 -0400815# The way to copy a file to the target (install and modules)
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500816# (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
Steven Rostedt02ad2612012-03-21 08:21:24 -0400817# The variables SSH_USER, MACHINE are defined by the config
818# SRC_FILE and DST_FILE are ktest internal variables and
819# should only have '$' and not the '${}' notation.
820# (default scp $SRC_FILE ${SSH_USER}@${MACHINE}:$DST_FILE)
821#SCP_TO_TARGET = echo skip scp for $SRC_FILE $DST_FILE
822
823# If install needs to be different than modules, then this
824# option will override the SCP_TO_TARGET for installation.
825# (default ${SCP_TO_TARGET} )
826#SCP_TO_TARGET_INSTALL = scp $SRC_FILE tftp@tftpserver:$DST_FILE
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500827
828# The nice way to reboot the target
829# (default ssh $SSH_USER@$MACHINE reboot)
830# The variables SSH_USER and MACHINE are defined.
831#REBOOT = ssh $SSH_USER@$MACHINE reboot
832
Steven Rostedtf1a5b962011-06-13 10:30:00 -0400833# The way triple faults are detected is by testing the kernel
834# banner. If the kernel banner for the kernel we are testing is
835# found, and then later a kernel banner for another kernel version
836# is found, it is considered that we encountered a triple fault,
837# and there is no panic or callback, but simply a reboot.
838# To disable this (because it did a false positive) set the following
839# to 0.
840# (default 1)
841#DETECT_TRIPLE_FAULT = 0
842
Steven Rostedt9cc9e092011-12-22 21:37:22 -0500843# All options in the config file should be either used by ktest
844# or could be used within a value of another option. If an option
845# in the config file is not used, ktest will warn about it and ask
846# if you want to continue.
847#
848# If you don't care if there are non-used options, enable this
849# option. Be careful though, a non-used option is usually a sign
850# of an option name being typed incorrectly.
851# (default 0)
852#IGNORE_UNUSED = 1
853
Steven Rostedtbe405f92012-01-04 21:51:59 -0500854# When testing a kernel that happens to have WARNINGs, and call
855# traces, ktest.pl will detect these and fail a boot or test run
856# due to warnings. By setting this option, ktest will ignore
857# call traces, and will not fail a test if the kernel produces
858# an oops. Use this option with care.
859# (default 0)
860#IGNORE_ERRORS = 1
861
Steven Rostedta75fece2010-11-02 14:58:27 -0400862#### Per test run options ####
Steven Rostedta57419b2010-11-02 15:13:54 -0400863# The following options are only allowed in TEST_START sections.
864# They are ignored in the DEFAULTS sections.
Steven Rostedta75fece2010-11-02 14:58:27 -0400865#
Steven Rostedta57419b2010-11-02 15:13:54 -0400866# All of these are optional and undefined by default, although
867# some of these options are required for TEST_TYPE of patchcheck
868# and bisect.
Steven Rostedta75fece2010-11-02 14:58:27 -0400869#
Steven Rostedta57419b2010-11-02 15:13:54 -0400870#
871# CHECKOUT = branch
Steven Rostedta75fece2010-11-02 14:58:27 -0400872#
873# If the BUILD_DIR is a git repository, then you can set this option
874# to checkout the given branch before running the TEST. If you
875# specify this for the first run, that branch will be used for
Steven Rostedta57419b2010-11-02 15:13:54 -0400876# all preceding tests until a new CHECKOUT is set.
Steven Rostedta75fece2010-11-02 14:58:27 -0400877#
Steven Rostedta57419b2010-11-02 15:13:54 -0400878#
Steven Rostedt9064af52011-06-13 10:38:48 -0400879# TEST_NAME = name
880#
881# If you want the test to have a name that is displayed in
882# the test result banner at the end of the test, then use this
883# option. This is useful to search for the RESULT keyword and
884# not have to translate a test number to a test in the config.
Steven Rostedta57419b2010-11-02 15:13:54 -0400885#
886# For TEST_TYPE = patchcheck
Steven Rostedta75fece2010-11-02 14:58:27 -0400887#
888# This expects the BUILD_DIR to be a git repository, and
Steven Rostedta57419b2010-11-02 15:13:54 -0400889# will checkout the PATCHCHECK_START commit.
Steven Rostedta75fece2010-11-02 14:58:27 -0400890#
Steven Rostedta57419b2010-11-02 15:13:54 -0400891# The option BUILD_TYPE will be ignored.
Steven Rostedta75fece2010-11-02 14:58:27 -0400892#
Steven Rostedta57419b2010-11-02 15:13:54 -0400893# The MIN_CONFIG will be used for all builds of the patchcheck. The build type
894# used for patchcheck is oldconfig.
Steven Rostedta75fece2010-11-02 14:58:27 -0400895#
Steven Rostedta57419b2010-11-02 15:13:54 -0400896# PATCHCHECK_START is required and is the first patch to
897# test (the SHA1 of the commit). You may also specify anything
898# that git checkout allows (branch name, tage, HEAD~3).
899#
900# PATCHCHECK_END is the last patch to check (default HEAD)
901#
902# PATCHCHECK_TYPE is required and is the type of test to run:
Steven Rostedta75fece2010-11-02 14:58:27 -0400903# build, boot, test.
904#
905# Note, the build test will look for warnings, if a warning occurred
Steven Rostedt19902072011-06-14 20:46:25 -0400906# in a file that a commit touches, the build will fail, unless
907# IGNORE_WARNINGS is set for the given commit's sha1
908#
909# IGNORE_WARNINGS can be used to disable the failure of patchcheck
910# on a particuler commit (SHA1). You can add more than one commit
911# by adding a list of SHA1s that are space delimited.
Steven Rostedta75fece2010-11-02 14:58:27 -0400912#
913# If BUILD_NOCLEAN is set, then make mrproper will not be run on
914# any of the builds, just like all other TEST_TYPE tests. But
915# what makes patchcheck different from the other tests, is if
916# BUILD_NOCLEAN is not set, only the first and last patch run
917# make mrproper. This helps speed up the test.
918#
919# Example:
Steven Rostedta57419b2010-11-02 15:13:54 -0400920# TEST_START
921# TEST_TYPE = patchcheck
922# CHECKOUT = mybranch
923# PATCHCHECK_TYPE = boot
924# PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500925# PATCHCHECK_END = HEAD~2
Steven Rostedt19902072011-06-14 20:46:25 -0400926# IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
Steven Rostedta75fece2010-11-02 14:58:27 -0400927#
928#
Steven Rostedta75fece2010-11-02 14:58:27 -0400929#
Steven Rostedta57419b2010-11-02 15:13:54 -0400930# For TEST_TYPE = bisect
Steven Rostedta75fece2010-11-02 14:58:27 -0400931#
Steven Rostedta57419b2010-11-02 15:13:54 -0400932# You can specify a git bisect if the BUILD_DIR is a git repository.
933# The MIN_CONFIG will be used for all builds of the bisect. The build type
934# used for bisecting is oldconfig.
935#
936# The option BUILD_TYPE will be ignored.
937#
938# BISECT_TYPE is the type of test to perform:
Steven Rostedta75fece2010-11-02 14:58:27 -0400939# build - bad fails to build
940# boot - bad builds but fails to boot
941# test - bad boots but fails a test
942#
Steven Rostedta57419b2010-11-02 15:13:54 -0400943# BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
944# BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
Steven Rostedta75fece2010-11-02 14:58:27 -0400945#
946# The above three options are required for a bisect operation.
947#
Steven Rostedta57419b2010-11-02 15:13:54 -0400948# BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400949#
950# If an operation failed in the bisect that was not expected to
951# fail. Then the test ends. The state of the BUILD_DIR will be
Steven Rostedta57419b2010-11-02 15:13:54 -0400952# left off at where the failure occurred. You can examine the
Steven Rostedta75fece2010-11-02 14:58:27 -0400953# reason for the failure, and perhaps even find a git commit
954# that would work to continue with. You can run:
955#
956# git bisect log > /path/to/replay/file
957#
Steven Rostedta57419b2010-11-02 15:13:54 -0400958# The adding:
Steven Rostedta75fece2010-11-02 14:58:27 -0400959#
Steven Rostedta57419b2010-11-02 15:13:54 -0400960# BISECT_REPLAY= /path/to/replay/file
Steven Rostedta75fece2010-11-02 14:58:27 -0400961#
Steven Rostedta57419b2010-11-02 15:13:54 -0400962# And running the test again. The test will perform the initial
963# git bisect start, git bisect good, and git bisect bad, and
964# then it will run git bisect replay on this file, before
965# continuing with the bisect.
966#
967# BISECT_START = commit (optional, default undefined)
968#
969# As with BISECT_REPLAY, if the test failed on a commit that
Steven Rostedta75fece2010-11-02 14:58:27 -0400970# just happen to have a bad commit in the middle of the bisect,
Steven Rostedta57419b2010-11-02 15:13:54 -0400971# and you need to skip it. If BISECT_START is defined, it
972# will checkout that commit after doing the initial git bisect start,
973# git bisect good, git bisect bad, and running the git bisect replay
974# if the BISECT_REPLAY is set.
Steven Rostedta75fece2010-11-02 14:58:27 -0400975#
Steven Rostedtc23dca72011-03-08 09:26:31 -0500976# BISECT_SKIP = 1 (optional, default 0)
977#
978# If BISECT_TYPE is set to test but the build fails, ktest will
979# simply fail the test and end their. You could use BISECT_REPLAY
980# and BISECT_START to resume after you found a new starting point,
981# or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
982# when something other than the BISECT_TYPE fails, ktest.pl will
983# run "git bisect skip" and try again.
984#
Steven Rostedt3410f6f2011-03-08 09:38:12 -0500985# BISECT_FILES = <path> (optional, default undefined)
986#
987# To just run the git bisect on a specific path, set BISECT_FILES.
988# For example:
989#
990# BISECT_FILES = arch/x86 kernel/time
991#
992# Will run the bisect with "git bisect start -- arch/x86 kernel/time"
993#
Steven Rostedta57419b2010-11-02 15:13:54 -0400994# BISECT_REVERSE = 1 (optional, default 0)
Steven Rostedta75fece2010-11-02 14:58:27 -0400995#
996# In those strange instances where it was broken forever
997# and you are trying to find where it started to work!
Steven Rostedta57419b2010-11-02 15:13:54 -0400998# Set BISECT_GOOD to the commit that was last known to fail
999# Set BISECT_BAD to the commit that is known to start working.
1000# With BISECT_REVERSE = 1, The test will consider failures as
1001# good, and success as bad.
Steven Rostedta75fece2010-11-02 14:58:27 -04001002#
Steven Rostedtc960bb92011-03-08 09:22:39 -05001003# BISECT_MANUAL = 1 (optional, default 0)
1004#
1005# In case there's a problem with automating the bisect for
1006# whatever reason. (Can't reboot, want to inspect each iteration)
1007# Doing a BISECT_MANUAL will have the test wait for you to
1008# tell it if the test passed or failed after each iteration.
1009# This is basicall the same as running git bisect yourself
1010# but ktest will rebuild and install the kernel for you.
1011#
Steven Rostedta57419b2010-11-02 15:13:54 -04001012# BISECT_CHECK = 1 (optional, default 0)
Steven Rostedta75fece2010-11-02 14:58:27 -04001013#
1014# Just to be sure the good is good and bad is bad, setting
Steven Rostedta57419b2010-11-02 15:13:54 -04001015# BISECT_CHECK to 1 will start the bisect by first checking
1016# out BISECT_BAD and makes sure it fails, then it will check
1017# out BISECT_GOOD and makes sure it succeeds before starting
1018# the bisect (it works for BISECT_REVERSE too).
Steven Rostedta75fece2010-11-02 14:58:27 -04001019#
Steven Rostedta57419b2010-11-02 15:13:54 -04001020# You can limit the test to just check BISECT_GOOD or
1021# BISECT_BAD with BISECT_CHECK = good or
1022# BISECT_CHECK = bad, respectively.
Steven Rostedta75fece2010-11-02 14:58:27 -04001023#
Steven Rostedtc5dacb82011-12-22 12:43:57 -05001024# BISECT_RET_GOOD = 0 (optional, default undefined)
1025#
1026# In case the specificed test returns something other than just
1027# 0 for good, and non-zero for bad, you can override 0 being
1028# good by defining BISECT_RET_GOOD.
1029#
1030# BISECT_RET_BAD = 1 (optional, default undefined)
1031#
1032# In case the specificed test returns something other than just
1033# 0 for good, and non-zero for bad, you can override non-zero being
1034# bad by defining BISECT_RET_BAD.
1035#
1036# BISECT_RET_ABORT = 255 (optional, default undefined)
1037#
1038# If you need to abort the bisect if the test discovers something
1039# that was wrong, you can define BISECT_RET_ABORT to be the error
1040# code returned by the test in order to abort the bisect.
1041#
1042# BISECT_RET_SKIP = 2 (optional, default undefined)
1043#
1044# If the test detects that the current commit is neither good
1045# nor bad, but something else happened (another bug detected)
1046# you can specify BISECT_RET_SKIP to an error code that the
1047# test returns when it should skip the current commit.
1048#
1049# BISECT_RET_DEFAULT = good (optional, default undefined)
1050#
1051# You can override the default of what to do when the above
1052# options are not hit. This may be one of, "good", "bad",
1053# "abort" or "skip" (without the quotes).
1054#
1055# Note, if you do not define any of the previous BISECT_RET_*
1056# and define BISECT_RET_DEFAULT, all bisects results will do
1057# what the BISECT_RET_DEFAULT has.
1058#
1059#
Steven Rostedta75fece2010-11-02 14:58:27 -04001060# Example:
Steven Rostedta57419b2010-11-02 15:13:54 -04001061# TEST_START
1062# TEST_TYPE = bisect
1063# BISECT_GOOD = v2.6.36
1064# BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
1065# BISECT_TYPE = build
1066# MIN_CONFIG = /home/test/config-bisect
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -05001067#
1068#
1069#
1070# For TEST_TYPE = config_bisect
1071#
1072# In those cases that you have two different configs. One of them
1073# work, the other does not, and you do not know what config causes
1074# the problem.
1075# The TEST_TYPE config_bisect will bisect the bad config looking for
1076# what config causes the failure.
1077#
1078# The way it works is this:
1079#
1080# First it finds a config to work with. Since a different version, or
1081# MIN_CONFIG may cause different dependecies, it must run through this
1082# preparation.
1083#
1084# Overwrites any config set in the bad config with a config set in
1085# either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
1086# are minimal and do not disable configs you want to test:
1087# (ie. # CONFIG_FOO is not set).
1088#
1089# An oldconfig is run on the bad config and any new config that
1090# appears will be added to the configs to test.
1091#
1092# Finally, it generates a config with the above result and runs it
1093# again through make oldconfig to produce a config that should be
1094# satisfied by kconfig.
1095#
1096# Then it starts the bisect.
1097#
1098# The configs to test are cut in half. If all the configs in this
1099# half depend on a config in the other half, then the other half
1100# is tested instead. If no configs are enabled by either half, then
1101# this means a circular dependency exists and the test fails.
1102#
1103# A config is created with the test half, and the bisect test is run.
1104#
1105# If the bisect succeeds, then all configs in the generated config
1106# are removed from the configs to test and added to the configs that
1107# will be enabled for all builds (they will be enabled, but not be part
1108# of the configs to examine).
1109#
1110# If the bisect fails, then all test configs that were not enabled by
1111# the config file are removed from the test. These configs will not
1112# be enabled in future tests. Since current config failed, we consider
1113# this to be a subset of the config that we started with.
1114#
1115# When we are down to one config, it is considered the bad config.
1116#
1117# Note, the config chosen may not be the true bad config. Due to
1118# dependencies and selections of the kbuild system, mulitple
1119# configs may be needed to cause a failure. If you disable the
1120# config that was found and restart the test, if the test fails
1121# again, it is recommended to rerun the config_bisect with a new
1122# bad config without the found config enabled.
1123#
1124# The option BUILD_TYPE will be ignored.
1125#
1126# CONFIG_BISECT_TYPE is the type of test to perform:
1127# build - bad fails to build
1128# boot - bad builds but fails to boot
1129# test - bad boots but fails a test
1130#
Steven Rostedt30f75da2011-06-13 10:35:35 -04001131# CONFIG_BISECT is the config that failed to boot
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -05001132#
Steven Rostedt30f75da2011-06-13 10:35:35 -04001133# If BISECT_MANUAL is set, it will pause between iterations.
1134# This is useful to use just ktest.pl just for the config bisect.
1135# If you set it to build, it will run the bisect and you can
1136# control what happens in between iterations. It will ask you if
1137# the test succeeded or not and continue the config bisect.
1138#
1139# CONFIG_BISECT_GOOD (optional)
1140# If you have a good config to start with, then you
1141# can specify it with CONFIG_BISECT_GOOD. Otherwise
1142# the MIN_CONFIG is the base.
Steven Rostedtc960bb92011-03-08 09:22:39 -05001143#
Steven Rostedtb0918612012-07-19 15:26:00 -04001144# CONFIG_BISECT_CHECK (optional)
1145# Set this to 1 if you want to confirm that the config ktest
1146# generates (the bad config with the min config) is still bad.
1147# It may be that the min config fixes what broke the bad config
1148# and the test will not return a result.
1149#
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -05001150# Example:
1151# TEST_START
1152# TEST_TYPE = config_bisect
1153# CONFIG_BISECT_TYPE = build
Al Virod36b6912011-12-29 17:09:01 -05001154# CONFIG_BISECT = /home/test/config-bad
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -05001155# MIN_CONFIG = /home/test/config-min
Steven Rostedtc960bb92011-03-08 09:22:39 -05001156# BISECT_MANUAL = 1
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -05001157#
Steven Rostedt4c4ab122011-07-15 21:16:17 -04001158#
1159#
1160# For TEST_TYPE = make_min_config
1161#
1162# After doing a make localyesconfig, your kernel configuration may
1163# not be the most useful minimum configuration. Having a true minimum
1164# config that you can use against other configs is very useful if
1165# someone else has a config that breaks on your code. By only forcing
1166# those configurations that are truly required to boot your machine
1167# will give you less of a chance that one of your set configurations
1168# will make the bug go away. This will give you a better chance to
1169# be able to reproduce the reported bug matching the broken config.
1170#
1171# Note, this does take some time, and may require you to run the
1172# test over night, or perhaps over the weekend. But it also allows
1173# you to interrupt it, and gives you the current minimum config
1174# that was found till that time.
1175#
1176# Note, this test automatically assumes a BUILD_TYPE of oldconfig
1177# and its test type acts like boot.
1178# TODO: add a test version that makes the config do more than just
1179# boot, like having network access.
1180#
Steven Rostedtb9066f62011-07-15 21:25:24 -04001181# To save time, the test does not just grab any option and test
1182# it. The Kconfig files are examined to determine the dependencies
1183# of the configs. If a config is chosen that depends on another
1184# config, that config will be checked first. By checking the
1185# parents first, we can eliminate whole groups of configs that
1186# may have been enabled.
1187#
1188# For example, if a USB device config is chosen and depends on CONFIG_USB,
1189# the CONFIG_USB will be tested before the device. If CONFIG_USB is
1190# found not to be needed, it, as well as all configs that depend on
1191# it, will be disabled and removed from the current min_config.
1192#
Steven Rostedt4c4ab122011-07-15 21:16:17 -04001193# OUTPUT_MIN_CONFIG is the path and filename of the file that will
1194# be created from the MIN_CONFIG. If you interrupt the test, set
1195# this file as your new min config, and use it to continue the test.
1196# This file does not need to exist on start of test.
1197# This file is not created until a config is found that can be removed.
Steven Rostedt35ce5952011-07-15 21:57:25 -04001198# If this file exists, you will be prompted if you want to use it
1199# as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG
1200# is not defined.
Steven Rostedt4c4ab122011-07-15 21:16:17 -04001201# (required field)
1202#
1203# START_MIN_CONFIG is the config to use to start the test with.
1204# you can set this as the same OUTPUT_MIN_CONFIG, but if you do
1205# the OUTPUT_MIN_CONFIG file must exist.
1206# (default MIN_CONFIG)
1207#
1208# IGNORE_CONFIG is used to specify a config file that has configs that
1209# you already know must be set. Configs are written here that have
1210# been tested and proved to be required. It is best to define this
1211# file if you intend on interrupting the test and running it where
1212# it left off. New configs that it finds will be written to this file
1213# and will not be tested again in later runs.
1214# (optional)
1215#
Steven Rostedtccc513b2012-05-21 17:13:40 -04001216# MIN_CONFIG_TYPE can be either 'boot' or 'test'. With 'boot' it will
1217# test if the created config can just boot the machine. If this is
1218# set to 'test', then the TEST option must be defined and the created
1219# config will not only boot the target, but also make sure that the
1220# config lets the test succeed. This is useful to make sure the final
1221# config that is generated allows network activity (ssh).
1222# (optional)
1223#
Steven Rostedt43de3312012-05-21 23:35:12 -04001224# USE_OUTPUT_MIN_CONFIG set this to 1 if you do not want to be prompted
1225# about using the OUTPUT_MIN_CONFIG as the MIN_CONFIG as the starting
1226# point. Set it to 0 if you want to always just use the given MIN_CONFIG.
1227# If it is not defined, it will prompt you to pick which config
1228# to start with (MIN_CONFIG or OUTPUT_MIN_CONFIG).
1229#
Steven Rostedt4c4ab122011-07-15 21:16:17 -04001230# Example:
1231#
1232# TEST_TYPE = make_min_config
1233# OUTPUT_MIN_CONFIG = /path/to/config-new-min
1234# START_MIN_CONFIG = /path/to/config-min
1235# IGNORE_CONFIG = /path/to/config-tested
Steven Rostedtccc513b2012-05-21 17:13:40 -04001236# MIN_CONFIG_TYPE = test
1237# TEST = ssh ${USER}@${MACHINE} echo hi
Steven Rostedt4c4ab122011-07-15 21:16:17 -04001238#
Steven Rostedt (Red Hat)4283b162013-01-30 18:37:47 -05001239#
1240#
1241#
1242# For TEST_TYPE = make_warnings_file
1243#
1244# If you want the build to fail when a new warning is discovered
1245# you set the WARNINGS_FILE to point to a file of known warnings.
1246#
1247# The test "make_warnings_file" will let you create a new warnings
1248# file before you run other tests, like patchcheck.
1249#
1250# What this test does is to run just a build, you still need to
1251# specify BUILD_TYPE to tell the test what type of config to use.
1252# A BUILD_TYPE of nobuild will fail this test.
1253#
1254# The test will do the build and scan for all warnings. Any warning
1255# it discovers will be saved in the WARNINGS_FILE (required) option.
1256#
1257# It is recommended (but not necessary) to make sure BUILD_NOCLEAN is
1258# off, so that a full build is done (make mrproper is performed).
1259# That way, all warnings will be captured.
1260#
1261# Example:
1262#
1263# TEST_TYPE = make_warnings_file
1264# WARNINGS_FILE = ${OUTPUT_DIR}
1265# BUILD_TYPE = useconfig:oldconfig
1266# CHECKOUT = v3.8
1267# BUILD_NOCLEAN = 0
1268#