blob: 87bf92a2eb99fe7b608d0b71f45c7863252d9505 [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 Rostedta75fece2010-11-02 14:58:27 -040075
Steven Rostedta57419b2010-11-02 15:13:54 -040076
77#### Mandatory Default Options ####
78
79# These options must be in the default section, although most
80# may be overridden by test options.
Steven Rostedta75fece2010-11-02 14:58:27 -040081
82# The machine hostname that you will test
83#MACHINE = target
84
85# The box is expected to have ssh on normal bootup, provide the user
86# (most likely root, since you need privileged operations)
87#SSH_USER = root
88
89# The directory that contains the Linux source code
90#BUILD_DIR = /home/test/linux.git
91
92# The directory that the objects will be built
93# (can not be same as BUILD_DIR)
94#OUTPUT_DIR = /home/test/build/target
95
96# The location of the compiled file to copy to the target
97# (relative to OUTPUT_DIR)
98#BUILD_TARGET = arch/x86/boot/bzImage
99
100# The place to put your image on the test machine
101#TARGET_IMAGE = /boot/vmlinuz-test
102
103# A script or command to reboot the box
Steven Rostedta57419b2010-11-02 15:13:54 -0400104#
Steven Rostedta75fece2010-11-02 14:58:27 -0400105# Here is a digital loggers power switch example
106#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 -0400107#
Steven Rostedta75fece2010-11-02 14:58:27 -0400108# Here is an example to reboot a virtual box on the current host
109# with the name "Guest".
Steven Rostedta57419b2010-11-02 15:13:54 -0400110#POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
Steven Rostedta75fece2010-11-02 14:58:27 -0400111
112# The script or command that reads the console
Steven Rostedta57419b2010-11-02 15:13:54 -0400113#
Steven Rostedta75fece2010-11-02 14:58:27 -0400114# If you use ttywatch server, something like the following would work.
115#CONSOLE = nc -d localhost 3001
Steven Rostedta57419b2010-11-02 15:13:54 -0400116#
Steven Rostedta75fece2010-11-02 14:58:27 -0400117# For a virtual machine with guest name "Guest".
Steven Rostedta57419b2010-11-02 15:13:54 -0400118#CONSOLE = virsh console Guest
Steven Rostedta75fece2010-11-02 14:58:27 -0400119
120# Required version ending to differentiate the test
121# from other linux builds on the system.
122#LOCALVERSION = -test
123
124# The grub title name for the test kernel to boot
125# (Only mandatory if REBOOT_TYPE = grub)
126#
Steven Rostedta57419b2010-11-02 15:13:54 -0400127# Note, ktest.pl will not update the grub menu.lst, you need to
128# manually add an option for the test. ktest.pl will search
129# the grub menu.lst for this option to find what kernel to
130# reboot into.
131#
Steven Rostedta75fece2010-11-02 14:58:27 -0400132# For example, if in the /boot/grub/menu.lst the test kernel title has:
133# title Test Kernel
Steven Rostedta57419b2010-11-02 15:13:54 -0400134# kernel vmlinuz-test
Steven Rostedta75fece2010-11-02 14:58:27 -0400135#GRUB_MENU = Test Kernel
136
137# A script to reboot the target into the test kernel
138# (Only mandatory if REBOOT_TYPE = script)
139#REBOOT_SCRIPT =
140
141#### Optional Config Options (all have defaults) ####
142
Steven Rostedta57419b2010-11-02 15:13:54 -0400143# Start a test setup. If you leave this off, all options
144# will be default and the test will run once.
145# This is a label and not really an option (it takes no value).
146# You can append ITERATE and a number after it to iterate the
147# test a number of times, or SKIP to ignore this test.
148#
149#TEST_START
150#TEST_START ITERATE 5
151#TEST_START SKIP
Steven Rostedta75fece2010-11-02 14:58:27 -0400152
Steven Rostedtdc895682010-11-02 15:22:53 -0400153# Have the following options as default again. Used after tests
154# have already been defined by TEST_START. Optionally, you can
155# just define all default options before the first TEST_START
156# and you do not need this option.
157#
158# This is a label and not really an option (it takes no value).
159# You can append SKIP to this label and the options within this
160# section will be ignored.
161#
162# DEFAULTS
163# DEFAULTS SKIP
164
Steven Rostedta75fece2010-11-02 14:58:27 -0400165# The default test type (default test)
166# The test types may be:
167# build - only build the kernel, do nothing else
168# boot - build and boot the kernel
169# test - build, boot and if TEST is set, run the test script
Steven Rostedta57419b2010-11-02 15:13:54 -0400170# (If TEST is not set, it defaults back to boot)
Steven Rostedta75fece2010-11-02 14:58:27 -0400171# bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
172# patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
173#TEST_TYPE = test
174
Steven Rostedta57419b2010-11-02 15:13:54 -0400175# Test to run if there is a successful boot and TEST_TYPE is test.
176# Must exit with 0 on success and non zero on error
177# default (undefined)
178#TEST = ssh user@machine /root/run_test
179
180# The build type is any make config type or special command
Steven Rostedta75fece2010-11-02 14:58:27 -0400181# (default randconfig)
182# nobuild - skip the clean and build step
Steven Rostedta57419b2010-11-02 15:13:54 -0400183# useconfig:/path/to/config - use the given config and run
184# oldconfig on it.
185# This option is ignored if TEST_TYPE is patchcheck or bisect
Steven Rostedta75fece2010-11-02 14:58:27 -0400186#BUILD_TYPE = randconfig
187
188# The make command (default make)
189# If you are building a 32bit x86 on a 64 bit host
190#MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
191
Steven Rostedtdc895682010-11-02 15:22:53 -0400192# Any build options for the make of the kernel (not for other makes, like configs)
193# (default "")
194#BUILD_OPTIONS = -j20
195
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400196# If you need an initrd, you can add a script or code here to install
197# it. The environment variable KERNEL_VERSION will be set to the
Steven Rostedta57419b2010-11-02 15:13:54 -0400198# kernel version that is used. Remember to add the initrd line
199# to your grub menu.lst file.
200#
201# Here's a couple of examples to use:
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400202#POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
Steven Rostedta57419b2010-11-02 15:13:54 -0400203#
204# or on some systems:
205#POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400206
Steven Rostedta75fece2010-11-02 14:58:27 -0400207# Way to reboot the box to the test kernel.
208# Only valid options so far are "grub" and "script"
209# (default grub)
210# If you specify grub, it will assume grub version 1
211# and will search in /boot/grub/menu.lst for the title $GRUB_MENU
212# and select that target to reboot to the kernel. If this is not
213# your setup, then specify "script" and have a command or script
214# specified in REBOOT_SCRIPT to boot to the target.
Steven Rostedta57419b2010-11-02 15:13:54 -0400215#
216# The entry in /boot/grub/menu.lst must be entered in manually.
217# The test will not modify that file.
Steven Rostedta75fece2010-11-02 14:58:27 -0400218#REBOOT_TYPE = grub
219
Steven Rostedta75fece2010-11-02 14:58:27 -0400220# The min config that is needed to build for the machine
Steven Rostedta57419b2010-11-02 15:13:54 -0400221# A nice way to create this is with the following:
Steven Rostedta75fece2010-11-02 14:58:27 -0400222#
Steven Rostedta57419b2010-11-02 15:13:54 -0400223# $ ssh target
224# $ lsmod > mymods
225# $ scp mymods host:/tmp
226# $ exit
227# $ cd linux.git
228# $ rm .config
229# $ make LSMOD=mymods localyesconfig
230# $ grep '^CONFIG' .config > /home/test/config-min
231#
232# If you want even less configs:
233#
234# log in directly to target (do not ssh)
235#
236# $ su
237# # lsmod | cut -d' ' -f1 | xargs rmmod
238#
239# repeat the above several times
240#
241# # lsmod > mymods
242# # reboot
243#
244# May need to reboot to get your network back to copy the mymods
245# to the host, and then remove the previous .config and run the
246# localyesconfig again. The CONFIG_MIN generated like this will
247# not guarantee network activity to the box so the TEST_TYPE of
248# test may fail.
249#
250# You might also want to set:
Steven Rostedta75fece2010-11-02 14:58:27 -0400251# CONFIG_CMDLINE="<your options here>"
252# randconfig may set the above and override your real command
253# line options.
Steven Rostedta57419b2010-11-02 15:13:54 -0400254# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400255#MIN_CONFIG = /home/test/config-min
256
257# Sometimes there's options that just break the boot and
258# you do not care about. Here are a few:
259# # CONFIG_STAGING is not set
260# Staging drivers are horrible, and can break the build.
261# # CONFIG_SCSI_DEBUG is not set
262# SCSI_DEBUG may change your root partition
263# # CONFIG_KGDB_SERIAL_CONSOLE is not set
264# KGDB may cause oops waiting for a connection that's not there.
265# This option points to the file containing config options that will be prepended
266# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
Steven Rostedta57419b2010-11-02 15:13:54 -0400267#
268# Note, config options in MIN_CONFIG will override these options.
269#
270# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400271#ADD_CONFIG = /home/test/config-broken
272
Steven Rostedtdc895682010-11-02 15:22:53 -0400273# The location on the host where to write temp files
274# (default /tmp/ktest)
275#TMP_DIR = /tmp/ktest
276
277# Optional log file to write the status (recommended)
278# Note, this is a DEFAULT section only option.
279# (default undefined)
280#LOG_FILE = /home/test/logfiles/target.log
281
282# Remove old logfile if it exists before starting all tests.
283# Note, this is a DEFAULT section only option.
284# (default 0)
285#CLEAR_LOG = 0
286
287# Line to define a successful boot up in console output.
288# This is what the line contains, not the entire line. If you need
289# the entire line to match, then use regural expression syntax like:
290# (do not add any quotes around it)
291#
292# SUCCESS_LINE = ^MyBox Login:$
293#
294# (default "login:")
295#SUCCESS_LINE = login:
296
Steven Rostedt1c8a6172010-11-09 12:55:40 -0500297# In case the console constantly fills the screen, having
298# a specified time to stop the test after success is recommended.
299# (in seconds)
300# (default 10)
301#STOP_AFTER_SUCCESS = 10
302
303# In case the console constantly fills the screen, having
304# a specified time to stop the test after failure is recommended.
305# (in seconds)
306# (default 60)
307#STOP_AFTER_FAILURE = 60
308
Steven Rostedt2d01b262011-03-08 09:47:54 -0500309# In case the console constantly fills the screen, having
310# a specified time to stop the test if it never succeeds nor fails
311# is recommended.
312# Note: this is ignored if a success or failure is detected.
313# (in seconds)
314# (default 600, -1 is to never stop)
315#STOP_TEST_AFTER = 600
316
Steven Rostedtdc895682010-11-02 15:22:53 -0400317# Stop testing if a build fails. If set, the script will end if
318# a failure is detected, otherwise it will save off the .config,
319# dmesg and bootlog in a directory called
320# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
321# if the STORE_FAILURES directory is set.
322# (default 1)
323# Note, even if this is set to zero, there are some errors that still
324# stop the tests.
325#DIE_ON_FAILURE = 1
326
327# Directory to store failure directories on failure. If this is not
328# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
329# bootlog. This option is ignored if DIE_ON_FAILURE is not set.
330# (default undefined)
331#STORE_FAILURES = /home/test/failures
332
333# Build without doing a make mrproper, or removing .config
334# (default 0)
335#BUILD_NOCLEAN = 0
336
337# As the test reads the console, after it hits the SUCCESS_LINE
338# the time it waits for the monitor to settle down between reads
339# can usually be lowered.
340# (in seconds) (default 1)
341#BOOTED_TIMEOUT = 1
342
343# The timeout in seconds when we consider the box hung after
344# the console stop producing output. Be sure to leave enough
345# time here to get pass a reboot. Some machines may not produce
346# any console output for a long time during a reboot. You do
347# not want the test to fail just because the system was in
348# the process of rebooting to the test kernel.
349# (default 120)
350#TIMEOUT = 120
351
352# In between tests, a reboot of the box may occur, and this
353# is the time to wait for the console after it stops producing
354# output. Some machines may not produce a large lag on reboot
355# so this should accommodate it.
356# The difference between this and TIMEOUT, is that TIMEOUT happens
357# when rebooting to the test kernel. This sleep time happens
358# after a test has completed and we are about to start running
359# another test. If a reboot to the reliable kernel happens,
360# we wait SLEEP_TIME for the console to stop producing output
361# before starting the next test.
362# (default 60)
363#SLEEP_TIME = 60
364
365# The time in between bisects to sleep (in seconds)
366# (default 60)
367#BISECT_SLEEP_TIME = 60
368
Steven Rostedt27d934b2011-05-20 09:18:18 -0400369# The time in between patch checks to sleep (in seconds)
370# (default 60)
371#PATCHCHECK_SLEEP_TIME = 60
372
Steven Rostedtdc895682010-11-02 15:22:53 -0400373# Reboot the target box on error (default 0)
374#REBOOT_ON_ERROR = 0
375
376# Power off the target on error (ignored if REBOOT_ON_ERROR is set)
377# Note, this is a DEFAULT section only option.
378# (default 0)
379#POWEROFF_ON_ERROR = 0
380
381# Power off the target after all tests have completed successfully
382# Note, this is a DEFAULT section only option.
383# (default 0)
384#POWEROFF_ON_SUCCESS = 0
385
386# Reboot the target after all test completed successfully (default 1)
387# (ignored if POWEROFF_ON_SUCCESS is set)
388#REBOOT_ON_SUCCESS = 1
389
390# In case there are isses with rebooting, you can specify this
391# to always powercycle after this amount of time after calling
392# reboot.
393# Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
394# makes it powercycle immediately after rebooting. Do not define
395# it if you do not want it.
396# (default undefined)
397#POWERCYCLE_AFTER_REBOOT = 5
398
399# In case there's isses with halting, you can specify this
400# to always poweroff after this amount of time after calling
401# halt.
402# Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
403# makes it poweroff immediately after halting. Do not define
404# it if you do not want it.
405# (default undefined)
406#POWEROFF_AFTER_HALT = 20
407
408# A script or command to power off the box (default undefined)
409# Needed for POWEROFF_ON_ERROR and SUCCESS
410#
411# Example for digital loggers power switch:
412#POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
413#
414# Example for a virtual guest call "Guest".
415#POWER_OFF = virsh destroy Guest
416
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500417# The way to execute a command on the target
418# (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
419# The variables SSH_USER, MACHINE and SSH_COMMAND are defined
420#SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
421
422# The way to copy a file to the target
423# (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
424# The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
425#SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
426
427# The nice way to reboot the target
428# (default ssh $SSH_USER@$MACHINE reboot)
429# The variables SSH_USER and MACHINE are defined.
430#REBOOT = ssh $SSH_USER@$MACHINE reboot
431
Steven Rostedta75fece2010-11-02 14:58:27 -0400432#### Per test run options ####
Steven Rostedta57419b2010-11-02 15:13:54 -0400433# The following options are only allowed in TEST_START sections.
434# They are ignored in the DEFAULTS sections.
Steven Rostedta75fece2010-11-02 14:58:27 -0400435#
Steven Rostedta57419b2010-11-02 15:13:54 -0400436# All of these are optional and undefined by default, although
437# some of these options are required for TEST_TYPE of patchcheck
438# and bisect.
Steven Rostedta75fece2010-11-02 14:58:27 -0400439#
Steven Rostedta57419b2010-11-02 15:13:54 -0400440#
441# CHECKOUT = branch
Steven Rostedta75fece2010-11-02 14:58:27 -0400442#
443# If the BUILD_DIR is a git repository, then you can set this option
444# to checkout the given branch before running the TEST. If you
445# specify this for the first run, that branch will be used for
Steven Rostedta57419b2010-11-02 15:13:54 -0400446# all preceding tests until a new CHECKOUT is set.
Steven Rostedta75fece2010-11-02 14:58:27 -0400447#
Steven Rostedta57419b2010-11-02 15:13:54 -0400448#
449#
450# For TEST_TYPE = patchcheck
Steven Rostedta75fece2010-11-02 14:58:27 -0400451#
452# This expects the BUILD_DIR to be a git repository, and
Steven Rostedta57419b2010-11-02 15:13:54 -0400453# will checkout the PATCHCHECK_START commit.
Steven Rostedta75fece2010-11-02 14:58:27 -0400454#
Steven Rostedta57419b2010-11-02 15:13:54 -0400455# The option BUILD_TYPE will be ignored.
Steven Rostedta75fece2010-11-02 14:58:27 -0400456#
Steven Rostedta57419b2010-11-02 15:13:54 -0400457# The MIN_CONFIG will be used for all builds of the patchcheck. The build type
458# used for patchcheck is oldconfig.
Steven Rostedta75fece2010-11-02 14:58:27 -0400459#
Steven Rostedta57419b2010-11-02 15:13:54 -0400460# PATCHCHECK_START is required and is the first patch to
461# test (the SHA1 of the commit). You may also specify anything
462# that git checkout allows (branch name, tage, HEAD~3).
463#
464# PATCHCHECK_END is the last patch to check (default HEAD)
465#
466# PATCHCHECK_TYPE is required and is the type of test to run:
Steven Rostedta75fece2010-11-02 14:58:27 -0400467# build, boot, test.
468#
469# Note, the build test will look for warnings, if a warning occurred
470# in a file that a commit touches, the build will fail.
471#
472# If BUILD_NOCLEAN is set, then make mrproper will not be run on
473# any of the builds, just like all other TEST_TYPE tests. But
474# what makes patchcheck different from the other tests, is if
475# BUILD_NOCLEAN is not set, only the first and last patch run
476# make mrproper. This helps speed up the test.
477#
478# Example:
Steven Rostedta57419b2010-11-02 15:13:54 -0400479# TEST_START
480# TEST_TYPE = patchcheck
481# CHECKOUT = mybranch
482# PATCHCHECK_TYPE = boot
483# PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500484# PATCHCHECK_END = HEAD~2
Steven Rostedta75fece2010-11-02 14:58:27 -0400485#
486#
Steven Rostedta75fece2010-11-02 14:58:27 -0400487#
Steven Rostedta57419b2010-11-02 15:13:54 -0400488# For TEST_TYPE = bisect
Steven Rostedta75fece2010-11-02 14:58:27 -0400489#
Steven Rostedta57419b2010-11-02 15:13:54 -0400490# You can specify a git bisect if the BUILD_DIR is a git repository.
491# The MIN_CONFIG will be used for all builds of the bisect. The build type
492# used for bisecting is oldconfig.
493#
494# The option BUILD_TYPE will be ignored.
495#
496# BISECT_TYPE is the type of test to perform:
Steven Rostedta75fece2010-11-02 14:58:27 -0400497# build - bad fails to build
498# boot - bad builds but fails to boot
499# test - bad boots but fails a test
500#
Steven Rostedta57419b2010-11-02 15:13:54 -0400501# BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
502# BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
Steven Rostedta75fece2010-11-02 14:58:27 -0400503#
504# The above three options are required for a bisect operation.
505#
Steven Rostedta57419b2010-11-02 15:13:54 -0400506# BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400507#
508# If an operation failed in the bisect that was not expected to
509# fail. Then the test ends. The state of the BUILD_DIR will be
Steven Rostedta57419b2010-11-02 15:13:54 -0400510# left off at where the failure occurred. You can examine the
Steven Rostedta75fece2010-11-02 14:58:27 -0400511# reason for the failure, and perhaps even find a git commit
512# that would work to continue with. You can run:
513#
514# git bisect log > /path/to/replay/file
515#
Steven Rostedta57419b2010-11-02 15:13:54 -0400516# The adding:
Steven Rostedta75fece2010-11-02 14:58:27 -0400517#
Steven Rostedta57419b2010-11-02 15:13:54 -0400518# BISECT_REPLAY= /path/to/replay/file
Steven Rostedta75fece2010-11-02 14:58:27 -0400519#
Steven Rostedta57419b2010-11-02 15:13:54 -0400520# And running the test again. The test will perform the initial
521# git bisect start, git bisect good, and git bisect bad, and
522# then it will run git bisect replay on this file, before
523# continuing with the bisect.
524#
525# BISECT_START = commit (optional, default undefined)
526#
527# As with BISECT_REPLAY, if the test failed on a commit that
Steven Rostedta75fece2010-11-02 14:58:27 -0400528# just happen to have a bad commit in the middle of the bisect,
Steven Rostedta57419b2010-11-02 15:13:54 -0400529# and you need to skip it. If BISECT_START is defined, it
530# will checkout that commit after doing the initial git bisect start,
531# git bisect good, git bisect bad, and running the git bisect replay
532# if the BISECT_REPLAY is set.
Steven Rostedta75fece2010-11-02 14:58:27 -0400533#
Steven Rostedtc23dca72011-03-08 09:26:31 -0500534# BISECT_SKIP = 1 (optional, default 0)
535#
536# If BISECT_TYPE is set to test but the build fails, ktest will
537# simply fail the test and end their. You could use BISECT_REPLAY
538# and BISECT_START to resume after you found a new starting point,
539# or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
540# when something other than the BISECT_TYPE fails, ktest.pl will
541# run "git bisect skip" and try again.
542#
Steven Rostedt3410f6f2011-03-08 09:38:12 -0500543# BISECT_FILES = <path> (optional, default undefined)
544#
545# To just run the git bisect on a specific path, set BISECT_FILES.
546# For example:
547#
548# BISECT_FILES = arch/x86 kernel/time
549#
550# Will run the bisect with "git bisect start -- arch/x86 kernel/time"
551#
Steven Rostedta57419b2010-11-02 15:13:54 -0400552# BISECT_REVERSE = 1 (optional, default 0)
Steven Rostedta75fece2010-11-02 14:58:27 -0400553#
554# In those strange instances where it was broken forever
555# and you are trying to find where it started to work!
Steven Rostedta57419b2010-11-02 15:13:54 -0400556# Set BISECT_GOOD to the commit that was last known to fail
557# Set BISECT_BAD to the commit that is known to start working.
558# With BISECT_REVERSE = 1, The test will consider failures as
559# good, and success as bad.
Steven Rostedta75fece2010-11-02 14:58:27 -0400560#
Steven Rostedtc960bb92011-03-08 09:22:39 -0500561# BISECT_MANUAL = 1 (optional, default 0)
562#
563# In case there's a problem with automating the bisect for
564# whatever reason. (Can't reboot, want to inspect each iteration)
565# Doing a BISECT_MANUAL will have the test wait for you to
566# tell it if the test passed or failed after each iteration.
567# This is basicall the same as running git bisect yourself
568# but ktest will rebuild and install the kernel for you.
569#
Steven Rostedta57419b2010-11-02 15:13:54 -0400570# BISECT_CHECK = 1 (optional, default 0)
Steven Rostedta75fece2010-11-02 14:58:27 -0400571#
572# Just to be sure the good is good and bad is bad, setting
Steven Rostedta57419b2010-11-02 15:13:54 -0400573# BISECT_CHECK to 1 will start the bisect by first checking
574# out BISECT_BAD and makes sure it fails, then it will check
575# out BISECT_GOOD and makes sure it succeeds before starting
576# the bisect (it works for BISECT_REVERSE too).
Steven Rostedta75fece2010-11-02 14:58:27 -0400577#
Steven Rostedta57419b2010-11-02 15:13:54 -0400578# You can limit the test to just check BISECT_GOOD or
579# BISECT_BAD with BISECT_CHECK = good or
580# BISECT_CHECK = bad, respectively.
Steven Rostedta75fece2010-11-02 14:58:27 -0400581#
582# Example:
Steven Rostedta57419b2010-11-02 15:13:54 -0400583# TEST_START
584# TEST_TYPE = bisect
585# BISECT_GOOD = v2.6.36
586# BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
587# BISECT_TYPE = build
588# MIN_CONFIG = /home/test/config-bisect
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500589#
590#
591#
592# For TEST_TYPE = config_bisect
593#
594# In those cases that you have two different configs. One of them
595# work, the other does not, and you do not know what config causes
596# the problem.
597# The TEST_TYPE config_bisect will bisect the bad config looking for
598# what config causes the failure.
599#
600# The way it works is this:
601#
602# First it finds a config to work with. Since a different version, or
603# MIN_CONFIG may cause different dependecies, it must run through this
604# preparation.
605#
606# Overwrites any config set in the bad config with a config set in
607# either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
608# are minimal and do not disable configs you want to test:
609# (ie. # CONFIG_FOO is not set).
610#
611# An oldconfig is run on the bad config and any new config that
612# appears will be added to the configs to test.
613#
614# Finally, it generates a config with the above result and runs it
615# again through make oldconfig to produce a config that should be
616# satisfied by kconfig.
617#
618# Then it starts the bisect.
619#
620# The configs to test are cut in half. If all the configs in this
621# half depend on a config in the other half, then the other half
622# is tested instead. If no configs are enabled by either half, then
623# this means a circular dependency exists and the test fails.
624#
625# A config is created with the test half, and the bisect test is run.
626#
627# If the bisect succeeds, then all configs in the generated config
628# are removed from the configs to test and added to the configs that
629# will be enabled for all builds (they will be enabled, but not be part
630# of the configs to examine).
631#
632# If the bisect fails, then all test configs that were not enabled by
633# the config file are removed from the test. These configs will not
634# be enabled in future tests. Since current config failed, we consider
635# this to be a subset of the config that we started with.
636#
637# When we are down to one config, it is considered the bad config.
638#
639# Note, the config chosen may not be the true bad config. Due to
640# dependencies and selections of the kbuild system, mulitple
641# configs may be needed to cause a failure. If you disable the
642# config that was found and restart the test, if the test fails
643# again, it is recommended to rerun the config_bisect with a new
644# bad config without the found config enabled.
645#
646# The option BUILD_TYPE will be ignored.
647#
648# CONFIG_BISECT_TYPE is the type of test to perform:
649# build - bad fails to build
650# boot - bad builds but fails to boot
651# test - bad boots but fails a test
652#
653# CONFIG_BISECT is the config that failed to boot
654#
Steven Rostedtc960bb92011-03-08 09:22:39 -0500655# If BISECT_MANUAL is set, it will pause between iterations.
656# This is useful to use just ktest.pl just for the config bisect.
657# If you set it to build, it will run the bisect and you can
658# control what happens in between iterations. It will ask you if
659# the test succeeded or not and continue the config bisect.
660#
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500661# Example:
662# TEST_START
663# TEST_TYPE = config_bisect
664# CONFIG_BISECT_TYPE = build
665# CONFIG_BISECT = /home/test/Ā¢onfig-bad
666# MIN_CONFIG = /home/test/config-min
Steven Rostedtc960bb92011-03-08 09:22:39 -0500667# BISECT_MANUAL = 1
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500668#