Merge branch 'next/cross-platform' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / tools / testing / ktest / sample.conf
CommitLineData
a75fecec 1#
a57419b3 2# Config file for ktest.pl
a75fecec
SR
3#
4# Note, all paths must be absolute
5#
6
a57419b3
SR
7# 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:
a75fecec 10#
a75fecec
SR
11# LOG_FILE
12# CLEAR_LOG
13# POWEROFF_ON_SUCCESS
14# REBOOT_ON_SUCCESS
15#
a57419b3
SR
16# 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#
75
77d942ce
SR
76#### Config variables ####
77#
78# This config file can also contain "config variables".
79# These are assigned with ":=" instead of the ktest option
80# assigment "=".
81#
82# The difference between ktest options and config variables
83# is that config variables can be used multiple times,
84# where each instance will override the previous instance.
85# And that they only live at time of processing this config.
86#
87# The advantage to config variables are that they can be used
88# by any option or any other config variables to define thing
89# that you may use over and over again in the options.
90#
91# For example:
92#
93# USER := root
94# TARGET := mybox
95# TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
96#
97# TEST_START
98# MIN_CONFIG = config1
99# TEST = ${TEST_CASE}
100#
101# TEST_START
102# MIN_CONFIG = config2
103# TEST = ${TEST_CASE}
104#
105# TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
106#
107# TEST_START
108# MIN_CONFIG = config1
109# TEST = ${TEST_CASE}
110#
111# TEST_START
112# MIN_CONFIG = config2
113# TEST = ${TEST_CASE}
114#
115# TEST_DIR := /home/me/test
116#
117# BUILD_DIR = ${TEST_DIR}/linux.git
118# OUTPUT_DIR = ${TEST_DIR}/test
119#
120# Note, the config variables are evaluated immediately, thus
121# updating TARGET after TEST_CASE has been assigned does nothing
122# to TEST_CASE.
123#
124# As shown in the example, to evaluate a config variable, you
125# use the ${X} convention. Simple $X will not work.
126#
127# If the config variable does not exist, the ${X} will not
128# be evaluated. Thus:
129#
130# MAKE_CMD = PATH=/mypath:${PATH} make
131#
132# If PATH is not a config variable, then the ${PATH} in
133# the MAKE_CMD option will be evaluated by the shell when
134# the MAKE_CMD option is passed into shell processing.
a57419b3 135
2a62512b
SR
136#### Using options in other options ####
137#
138# Options that are defined in the config file may also be used
139# by other options. All options are evaulated at time of
140# use (except that config variables are evaluated at config
141# processing time).
142#
143# If an ktest option is used within another option, instead of
144# typing it again in that option you can simply use the option
145# just like you can config variables.
146#
147# MACHINE = mybox
148#
149# TEST = ssh root@${MACHINE} /path/to/test
150#
151# The option will be used per test case. Thus:
152#
153# TEST_TYPE = test
154# TEST = ssh root@{MACHINE}
155#
156# TEST_START
157# MACHINE = box1
158#
159# TEST_START
160# MACHINE = box2
161#
162# For both test cases, MACHINE will be evaluated at the time
163# of the test case. The first test will run ssh root@box1
164# and the second will run ssh root@box2.
165
a57419b3 166#### Mandatory Default Options ####
a75fecec 167
a57419b3
SR
168# These options must be in the default section, although most
169# may be overridden by test options.
a75fecec
SR
170
171# The machine hostname that you will test
172#MACHINE = target
173
174# The box is expected to have ssh on normal bootup, provide the user
175# (most likely root, since you need privileged operations)
176#SSH_USER = root
177
178# The directory that contains the Linux source code
179#BUILD_DIR = /home/test/linux.git
180
181# The directory that the objects will be built
182# (can not be same as BUILD_DIR)
183#OUTPUT_DIR = /home/test/build/target
184
185# The location of the compiled file to copy to the target
186# (relative to OUTPUT_DIR)
187#BUILD_TARGET = arch/x86/boot/bzImage
188
189# The place to put your image on the test machine
190#TARGET_IMAGE = /boot/vmlinuz-test
191
192# A script or command to reboot the box
a57419b3 193#
a75fecec
SR
194# Here is a digital loggers power switch example
195#POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
a57419b3 196#
a75fecec
SR
197# Here is an example to reboot a virtual box on the current host
198# with the name "Guest".
a57419b3 199#POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
a75fecec
SR
200
201# The script or command that reads the console
a57419b3 202#
a75fecec
SR
203# If you use ttywatch server, something like the following would work.
204#CONSOLE = nc -d localhost 3001
a57419b3 205#
a75fecec 206# For a virtual machine with guest name "Guest".
a57419b3 207#CONSOLE = virsh console Guest
a75fecec
SR
208
209# Required version ending to differentiate the test
210# from other linux builds on the system.
211#LOCALVERSION = -test
212
213# The grub title name for the test kernel to boot
214# (Only mandatory if REBOOT_TYPE = grub)
215#
a57419b3
SR
216# Note, ktest.pl will not update the grub menu.lst, you need to
217# manually add an option for the test. ktest.pl will search
218# the grub menu.lst for this option to find what kernel to
219# reboot into.
220#
a75fecec
SR
221# For example, if in the /boot/grub/menu.lst the test kernel title has:
222# title Test Kernel
a57419b3 223# kernel vmlinuz-test
a75fecec
SR
224#GRUB_MENU = Test Kernel
225
226# A script to reboot the target into the test kernel
227# (Only mandatory if REBOOT_TYPE = script)
228#REBOOT_SCRIPT =
229
230#### Optional Config Options (all have defaults) ####
231
a57419b3
SR
232# Start a test setup. If you leave this off, all options
233# will be default and the test will run once.
234# This is a label and not really an option (it takes no value).
235# You can append ITERATE and a number after it to iterate the
236# test a number of times, or SKIP to ignore this test.
237#
238#TEST_START
239#TEST_START ITERATE 5
240#TEST_START SKIP
a75fecec 241
dc895688
SR
242# Have the following options as default again. Used after tests
243# have already been defined by TEST_START. Optionally, you can
244# just define all default options before the first TEST_START
245# and you do not need this option.
246#
247# This is a label and not really an option (it takes no value).
248# You can append SKIP to this label and the options within this
249# section will be ignored.
250#
251# DEFAULTS
252# DEFAULTS SKIP
253
a75fecec
SR
254# The default test type (default test)
255# The test types may be:
256# build - only build the kernel, do nothing else
257# boot - build and boot the kernel
258# test - build, boot and if TEST is set, run the test script
a57419b3 259# (If TEST is not set, it defaults back to boot)
a75fecec
SR
260# bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
261# patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
262#TEST_TYPE = test
263
a57419b3
SR
264# Test to run if there is a successful boot and TEST_TYPE is test.
265# Must exit with 0 on success and non zero on error
266# default (undefined)
267#TEST = ssh user@machine /root/run_test
268
269# The build type is any make config type or special command
a75fecec
SR
270# (default randconfig)
271# nobuild - skip the clean and build step
a57419b3
SR
272# useconfig:/path/to/config - use the given config and run
273# oldconfig on it.
274# This option is ignored if TEST_TYPE is patchcheck or bisect
a75fecec
SR
275#BUILD_TYPE = randconfig
276
277# The make command (default make)
278# If you are building a 32bit x86 on a 64 bit host
279#MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
280
dc895688
SR
281# Any build options for the make of the kernel (not for other makes, like configs)
282# (default "")
283#BUILD_OPTIONS = -j20
284
8b37ca8c
SR
285# If you need an initrd, you can add a script or code here to install
286# it. The environment variable KERNEL_VERSION will be set to the
a57419b3
SR
287# kernel version that is used. Remember to add the initrd line
288# to your grub menu.lst file.
289#
290# Here's a couple of examples to use:
8b37ca8c 291#POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
a57419b3
SR
292#
293# or on some systems:
294#POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
8b37ca8c 295
0bd6c1a3
SR
296# If there is a script that you require to run before the build is done
297# you can specify it with PRE_BUILD.
298#
299# One example may be if you must add a temporary patch to the build to
300# fix a unrelated bug to perform a patchcheck test. This will apply the
301# patch before each build that is made. Use the POST_BUILD to do a git reset --hard
302# to remove the patch.
303#
304# (default undef)
305#PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
306
307# To specify if the test should fail if the PRE_BUILD fails,
308# PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
309# result is ignored.
310# (default 0)
311# PRE_BUILD_DIE = 1
312
313# If there is a script that should run after the build is done
314# you can specify it with POST_BUILD.
315#
316# As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
317# made by the PRE_BUILD.
318#
319# (default undef)
320#POST_BUILD = cd ${BUILD_DIR} && git reset --hard
321
322# To specify if the test should fail if the POST_BUILD fails,
323# POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
324# result is ignored.
325# (default 0)
326#POST_BUILD_DIE = 1
327
a75fecec
SR
328# Way to reboot the box to the test kernel.
329# Only valid options so far are "grub" and "script"
330# (default grub)
331# If you specify grub, it will assume grub version 1
332# and will search in /boot/grub/menu.lst for the title $GRUB_MENU
333# and select that target to reboot to the kernel. If this is not
334# your setup, then specify "script" and have a command or script
335# specified in REBOOT_SCRIPT to boot to the target.
a57419b3
SR
336#
337# The entry in /boot/grub/menu.lst must be entered in manually.
338# The test will not modify that file.
a75fecec
SR
339#REBOOT_TYPE = grub
340
dc895688
SR
341# The min config that is needed to build for the machine
342# A nice way to create this is with the following:
343#
344# $ ssh target
345# $ lsmod > mymods
346# $ scp mymods host:/tmp
347# $ exit
348# $ cd linux.git
349# $ rm .config
350# $ make LSMOD=mymods localyesconfig
351# $ grep '^CONFIG' .config > /home/test/config-min
352#
353# If you want even less configs:
354#
355# log in directly to target (do not ssh)
356#
357# $ su
358# # lsmod | cut -d' ' -f1 | xargs rmmod
359#
360# repeat the above several times
361#
362# # lsmod > mymods
363# # reboot
364#
365# May need to reboot to get your network back to copy the mymods
366# to the host, and then remove the previous .config and run the
367# localyesconfig again. The CONFIG_MIN generated like this will
368# not guarantee network activity to the box so the TEST_TYPE of
369# test may fail.
370#
371# You might also want to set:
372# CONFIG_CMDLINE="<your options here>"
373# randconfig may set the above and override your real command
374# line options.
375# (default undefined)
376#MIN_CONFIG = /home/test/config-min
377
378# Sometimes there's options that just break the boot and
379# you do not care about. Here are a few:
380# # CONFIG_STAGING is not set
381# Staging drivers are horrible, and can break the build.
382# # CONFIG_SCSI_DEBUG is not set
383# SCSI_DEBUG may change your root partition
384# # CONFIG_KGDB_SERIAL_CONSOLE is not set
385# KGDB may cause oops waiting for a connection that's not there.
386# This option points to the file containing config options that will be prepended
387# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
388#
389# Note, config options in MIN_CONFIG will override these options.
390#
391# (default undefined)
392#ADD_CONFIG = /home/test/config-broken
393
394# The location on the host where to write temp files
48920630
SR
395# (default /tmp/ktest/${MACHINE})
396#TMP_DIR = /tmp/ktest/${MACHINE}
dc895688
SR
397
398# Optional log file to write the status (recommended)
399# Note, this is a DEFAULT section only option.
400# (default undefined)
401#LOG_FILE = /home/test/logfiles/target.log
402
403# Remove old logfile if it exists before starting all tests.
404# Note, this is a DEFAULT section only option.
405# (default 0)
406#CLEAR_LOG = 0
407
a57419b3 408# Line to define a successful boot up in console output.
a75fecec 409# This is what the line contains, not the entire line. If you need
a57419b3
SR
410# the entire line to match, then use regural expression syntax like:
411# (do not add any quotes around it)
412#
413# SUCCESS_LINE = ^MyBox Login:$
414#
415# (default "login:")
a75fecec
SR
416#SUCCESS_LINE = login:
417
1c8a617a
SR
418# In case the console constantly fills the screen, having
419# a specified time to stop the test after success is recommended.
420# (in seconds)
421# (default 10)
422#STOP_AFTER_SUCCESS = 10
423
424# In case the console constantly fills the screen, having
425# a specified time to stop the test after failure is recommended.
426# (in seconds)
427# (default 60)
428#STOP_AFTER_FAILURE = 60
429
2d01b26a
SR
430# In case the console constantly fills the screen, having
431# a specified time to stop the test if it never succeeds nor fails
432# is recommended.
433# Note: this is ignored if a success or failure is detected.
434# (in seconds)
435# (default 600, -1 is to never stop)
436#STOP_TEST_AFTER = 600
437
dc895688
SR
438# Stop testing if a build fails. If set, the script will end if
439# a failure is detected, otherwise it will save off the .config,
440# dmesg and bootlog in a directory called
441# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
442# if the STORE_FAILURES directory is set.
443# (default 1)
444# Note, even if this is set to zero, there are some errors that still
445# stop the tests.
446#DIE_ON_FAILURE = 1
447
448# Directory to store failure directories on failure. If this is not
449# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
450# bootlog. This option is ignored if DIE_ON_FAILURE is not set.
451# (default undefined)
452#STORE_FAILURES = /home/test/failures
453
454# Build without doing a make mrproper, or removing .config
455# (default 0)
456#BUILD_NOCLEAN = 0
457
a75fecec
SR
458# As the test reads the console, after it hits the SUCCESS_LINE
459# the time it waits for the monitor to settle down between reads
460# can usually be lowered.
461# (in seconds) (default 1)
462#BOOTED_TIMEOUT = 1
463
464# The timeout in seconds when we consider the box hung after
a57419b3
SR
465# the console stop producing output. Be sure to leave enough
466# time here to get pass a reboot. Some machines may not produce
467# any console output for a long time during a reboot. You do
468# not want the test to fail just because the system was in
469# the process of rebooting to the test kernel.
a75fecec
SR
470# (default 120)
471#TIMEOUT = 120
472
a75fecec
SR
473# In between tests, a reboot of the box may occur, and this
474# is the time to wait for the console after it stops producing
475# output. Some machines may not produce a large lag on reboot
476# so this should accommodate it.
a57419b3
SR
477# The difference between this and TIMEOUT, is that TIMEOUT happens
478# when rebooting to the test kernel. This sleep time happens
479# after a test has completed and we are about to start running
480# another test. If a reboot to the reliable kernel happens,
481# we wait SLEEP_TIME for the console to stop producing output
482# before starting the next test.
a75fecec
SR
483# (default 60)
484#SLEEP_TIME = 60
485
486# The time in between bisects to sleep (in seconds)
a57419b3 487# (default 60)
a75fecec
SR
488#BISECT_SLEEP_TIME = 60
489
27d934b2
SR
490# The time in between patch checks to sleep (in seconds)
491# (default 60)
492#PATCHCHECK_SLEEP_TIME = 60
493
a75fecec
SR
494# Reboot the target box on error (default 0)
495#REBOOT_ON_ERROR = 0
496
497# Power off the target on error (ignored if REBOOT_ON_ERROR is set)
a57419b3 498# Note, this is a DEFAULT section only option.
a75fecec
SR
499# (default 0)
500#POWEROFF_ON_ERROR = 0
501
502# Power off the target after all tests have completed successfully
a57419b3 503# Note, this is a DEFAULT section only option.
a75fecec
SR
504# (default 0)
505#POWEROFF_ON_SUCCESS = 0
506
507# Reboot the target after all test completed successfully (default 1)
508# (ignored if POWEROFF_ON_SUCCESS is set)
509#REBOOT_ON_SUCCESS = 1
510
a57419b3 511# In case there are isses with rebooting, you can specify this
576f627c
SR
512# to always powercycle after this amount of time after calling
513# reboot.
514# Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
515# makes it powercycle immediately after rebooting. Do not define
516# it if you do not want it.
517# (default undefined)
518#POWERCYCLE_AFTER_REBOOT = 5
519
520# In case there's isses with halting, you can specify this
521# to always poweroff after this amount of time after calling
522# halt.
523# Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
524# makes it poweroff immediately after halting. Do not define
525# it if you do not want it.
526# (default undefined)
527#POWEROFF_AFTER_HALT = 20
528
a57419b3 529# A script or command to power off the box (default undefined)
a75fecec 530# Needed for POWEROFF_ON_ERROR and SUCCESS
a57419b3 531#
a75fecec
SR
532# Example for digital loggers power switch:
533#POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
a57419b3 534#
a75fecec 535# Example for a virtual guest call "Guest".
a57419b3 536#POWER_OFF = virsh destroy Guest
a75fecec 537
d1fbd7e6
SR
538# The way to execute a command on the target
539# (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
540# The variables SSH_USER, MACHINE and SSH_COMMAND are defined
541#SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
542
543# The way to copy a file to the target
544# (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
545# The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
546#SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
547
548# The nice way to reboot the target
549# (default ssh $SSH_USER@$MACHINE reboot)
550# The variables SSH_USER and MACHINE are defined.
551#REBOOT = ssh $SSH_USER@$MACHINE reboot
552
f1a5b962
SR
553# The way triple faults are detected is by testing the kernel
554# banner. If the kernel banner for the kernel we are testing is
555# found, and then later a kernel banner for another kernel version
556# is found, it is considered that we encountered a triple fault,
557# and there is no panic or callback, but simply a reboot.
558# To disable this (because it did a false positive) set the following
559# to 0.
560# (default 1)
561#DETECT_TRIPLE_FAULT = 0
562
a75fecec 563#### Per test run options ####
a57419b3
SR
564# The following options are only allowed in TEST_START sections.
565# They are ignored in the DEFAULTS sections.
a75fecec 566#
a57419b3
SR
567# All of these are optional and undefined by default, although
568# some of these options are required for TEST_TYPE of patchcheck
569# and bisect.
a75fecec 570#
a57419b3
SR
571#
572# CHECKOUT = branch
a75fecec
SR
573#
574# If the BUILD_DIR is a git repository, then you can set this option
575# to checkout the given branch before running the TEST. If you
576# specify this for the first run, that branch will be used for
a57419b3
SR
577# all preceding tests until a new CHECKOUT is set.
578#
a75fecec 579#
9064af52
SR
580# TEST_NAME = name
581#
582# If you want the test to have a name that is displayed in
583# the test result banner at the end of the test, then use this
584# option. This is useful to search for the RESULT keyword and
585# not have to translate a test number to a test in the config.
a57419b3
SR
586#
587# For TEST_TYPE = patchcheck
a75fecec
SR
588#
589# This expects the BUILD_DIR to be a git repository, and
a57419b3
SR
590# will checkout the PATCHCHECK_START commit.
591#
592# The option BUILD_TYPE will be ignored.
a75fecec 593#
a57419b3
SR
594# The MIN_CONFIG will be used for all builds of the patchcheck. The build type
595# used for patchcheck is oldconfig.
a75fecec 596#
a57419b3
SR
597# PATCHCHECK_START is required and is the first patch to
598# test (the SHA1 of the commit). You may also specify anything
599# that git checkout allows (branch name, tage, HEAD~3).
a75fecec 600#
a57419b3
SR
601# PATCHCHECK_END is the last patch to check (default HEAD)
602#
603# PATCHCHECK_TYPE is required and is the type of test to run:
a75fecec
SR
604# build, boot, test.
605#
606# Note, the build test will look for warnings, if a warning occurred
1990207d
SR
607# in a file that a commit touches, the build will fail, unless
608# IGNORE_WARNINGS is set for the given commit's sha1
609#
610# IGNORE_WARNINGS can be used to disable the failure of patchcheck
611# on a particuler commit (SHA1). You can add more than one commit
612# by adding a list of SHA1s that are space delimited.
a75fecec
SR
613#
614# If BUILD_NOCLEAN is set, then make mrproper will not be run on
615# any of the builds, just like all other TEST_TYPE tests. But
616# what makes patchcheck different from the other tests, is if
617# BUILD_NOCLEAN is not set, only the first and last patch run
618# make mrproper. This helps speed up the test.
619#
620# Example:
a57419b3
SR
621# TEST_START
622# TEST_TYPE = patchcheck
623# CHECKOUT = mybranch
624# PATCHCHECK_TYPE = boot
625# PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
d1fbd7e6 626# PATCHCHECK_END = HEAD~2
1990207d 627# IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
a57419b3 628#
a75fecec
SR
629#
630#
a57419b3 631# For TEST_TYPE = bisect
a75fecec 632#
a57419b3
SR
633# You can specify a git bisect if the BUILD_DIR is a git repository.
634# The MIN_CONFIG will be used for all builds of the bisect. The build type
635# used for bisecting is oldconfig.
a75fecec 636#
a57419b3
SR
637# The option BUILD_TYPE will be ignored.
638#
639# BISECT_TYPE is the type of test to perform:
a75fecec
SR
640# build - bad fails to build
641# boot - bad builds but fails to boot
642# test - bad boots but fails a test
643#
a57419b3
SR
644# BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
645# BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
a75fecec
SR
646#
647# The above three options are required for a bisect operation.
648#
a57419b3 649# BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
a75fecec
SR
650#
651# If an operation failed in the bisect that was not expected to
652# fail. Then the test ends. The state of the BUILD_DIR will be
a57419b3 653# left off at where the failure occurred. You can examine the
a75fecec
SR
654# reason for the failure, and perhaps even find a git commit
655# that would work to continue with. You can run:
656#
657# git bisect log > /path/to/replay/file
658#
a57419b3 659# The adding:
a75fecec 660#
a57419b3 661# BISECT_REPLAY= /path/to/replay/file
a75fecec 662#
a57419b3
SR
663# And running the test again. The test will perform the initial
664# git bisect start, git bisect good, and git bisect bad, and
665# then it will run git bisect replay on this file, before
666# continuing with the bisect.
a75fecec 667#
a57419b3
SR
668# BISECT_START = commit (optional, default undefined)
669#
670# As with BISECT_REPLAY, if the test failed on a commit that
671# just happen to have a bad commit in the middle of the bisect,
672# and you need to skip it. If BISECT_START is defined, it
673# will checkout that commit after doing the initial git bisect start,
674# git bisect good, git bisect bad, and running the git bisect replay
675# if the BISECT_REPLAY is set.
a75fecec 676#
c23dca7c
SR
677# BISECT_SKIP = 1 (optional, default 0)
678#
679# If BISECT_TYPE is set to test but the build fails, ktest will
680# simply fail the test and end their. You could use BISECT_REPLAY
681# and BISECT_START to resume after you found a new starting point,
682# or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
683# when something other than the BISECT_TYPE fails, ktest.pl will
684# run "git bisect skip" and try again.
685#
3410f6fd
SR
686# BISECT_FILES = <path> (optional, default undefined)
687#
688# To just run the git bisect on a specific path, set BISECT_FILES.
689# For example:
690#
691# BISECT_FILES = arch/x86 kernel/time
692#
693# Will run the bisect with "git bisect start -- arch/x86 kernel/time"
694#
a57419b3 695# BISECT_REVERSE = 1 (optional, default 0)
a75fecec
SR
696#
697# In those strange instances where it was broken forever
698# and you are trying to find where it started to work!
a57419b3
SR
699# Set BISECT_GOOD to the commit that was last known to fail
700# Set BISECT_BAD to the commit that is known to start working.
701# With BISECT_REVERSE = 1, The test will consider failures as
702# good, and success as bad.
a75fecec 703#
c960bb9f
SR
704# BISECT_MANUAL = 1 (optional, default 0)
705#
706# In case there's a problem with automating the bisect for
707# whatever reason. (Can't reboot, want to inspect each iteration)
708# Doing a BISECT_MANUAL will have the test wait for you to
709# tell it if the test passed or failed after each iteration.
710# This is basicall the same as running git bisect yourself
711# but ktest will rebuild and install the kernel for you.
712#
a57419b3 713# BISECT_CHECK = 1 (optional, default 0)
a75fecec
SR
714#
715# Just to be sure the good is good and bad is bad, setting
a57419b3
SR
716# BISECT_CHECK to 1 will start the bisect by first checking
717# out BISECT_BAD and makes sure it fails, then it will check
718# out BISECT_GOOD and makes sure it succeeds before starting
719# the bisect (it works for BISECT_REVERSE too).
a75fecec 720#
a57419b3
SR
721# You can limit the test to just check BISECT_GOOD or
722# BISECT_BAD with BISECT_CHECK = good or
723# BISECT_CHECK = bad, respectively.
a75fecec
SR
724#
725# Example:
a57419b3
SR
726# TEST_START
727# TEST_TYPE = bisect
728# BISECT_GOOD = v2.6.36
729# BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
730# BISECT_TYPE = build
731# MIN_CONFIG = /home/test/config-bisect
d1fbd7e6
SR
732#
733#
734#
735# For TEST_TYPE = config_bisect
736#
737# In those cases that you have two different configs. One of them
738# work, the other does not, and you do not know what config causes
739# the problem.
740# The TEST_TYPE config_bisect will bisect the bad config looking for
741# what config causes the failure.
742#
743# The way it works is this:
744#
745# First it finds a config to work with. Since a different version, or
746# MIN_CONFIG may cause different dependecies, it must run through this
747# preparation.
748#
749# Overwrites any config set in the bad config with a config set in
750# either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
751# are minimal and do not disable configs you want to test:
752# (ie. # CONFIG_FOO is not set).
753#
754# An oldconfig is run on the bad config and any new config that
755# appears will be added to the configs to test.
756#
757# Finally, it generates a config with the above result and runs it
758# again through make oldconfig to produce a config that should be
759# satisfied by kconfig.
760#
761# Then it starts the bisect.
762#
763# The configs to test are cut in half. If all the configs in this
764# half depend on a config in the other half, then the other half
765# is tested instead. If no configs are enabled by either half, then
766# this means a circular dependency exists and the test fails.
767#
768# A config is created with the test half, and the bisect test is run.
769#
770# If the bisect succeeds, then all configs in the generated config
771# are removed from the configs to test and added to the configs that
772# will be enabled for all builds (they will be enabled, but not be part
773# of the configs to examine).
774#
775# If the bisect fails, then all test configs that were not enabled by
776# the config file are removed from the test. These configs will not
777# be enabled in future tests. Since current config failed, we consider
778# this to be a subset of the config that we started with.
779#
780# When we are down to one config, it is considered the bad config.
781#
782# Note, the config chosen may not be the true bad config. Due to
783# dependencies and selections of the kbuild system, mulitple
784# configs may be needed to cause a failure. If you disable the
785# config that was found and restart the test, if the test fails
786# again, it is recommended to rerun the config_bisect with a new
787# bad config without the found config enabled.
788#
789# The option BUILD_TYPE will be ignored.
790#
791# CONFIG_BISECT_TYPE is the type of test to perform:
792# build - bad fails to build
793# boot - bad builds but fails to boot
794# test - bad boots but fails a test
795#
30f75da5
SR
796# CONFIG_BISECT is the config that failed to boot
797#
798# If BISECT_MANUAL is set, it will pause between iterations.
799# This is useful to use just ktest.pl just for the config bisect.
800# If you set it to build, it will run the bisect and you can
801# control what happens in between iterations. It will ask you if
802# the test succeeded or not and continue the config bisect.
803#
804# CONFIG_BISECT_GOOD (optional)
805# If you have a good config to start with, then you
806# can specify it with CONFIG_BISECT_GOOD. Otherwise
807# the MIN_CONFIG is the base.
c960bb9f 808#
d1fbd7e6
SR
809# Example:
810# TEST_START
811# TEST_TYPE = config_bisect
812# CONFIG_BISECT_TYPE = build
813