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