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