sample.conf 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399
  1. #
  2. # Config file for ktest.pl
  3. #
  4. # Place your customized version of this, in the working directory that
  5. # ktest.pl is run from. By default, ktest.pl will look for a file
  6. # called "ktest.conf", but you can name it anything you like and specify
  7. # the name of your config file as the first argument of ktest.pl.
  8. #
  9. # Note, all paths must be absolute
  10. #
  11. # Options set in the beginning of the file are considered to be
  12. # default options. These options can be overridden by test specific
  13. # options, with the following exceptions:
  14. #
  15. # LOG_FILE
  16. # CLEAR_LOG
  17. # POWEROFF_ON_SUCCESS
  18. # REBOOT_ON_SUCCESS
  19. #
  20. # Test specific options are set after the label:
  21. #
  22. # TEST_START
  23. #
  24. # The options after a TEST_START label are specific to that test.
  25. # Each TEST_START label will set up a new test. If you want to
  26. # perform a test more than once, you can add the ITERATE label
  27. # to it followed by the number of times you want that test
  28. # to iterate. If the ITERATE is left off, the test will only
  29. # be performed once.
  30. #
  31. # TEST_START ITERATE 10
  32. #
  33. # You can skip a test by adding SKIP (before or after the ITERATE
  34. # and number)
  35. #
  36. # TEST_START SKIP
  37. #
  38. # TEST_START SKIP ITERATE 10
  39. #
  40. # TEST_START ITERATE 10 SKIP
  41. #
  42. # The SKIP label causes the options and the test itself to be ignored.
  43. # This is useful to set up several different tests in one config file, and
  44. # only enabling the ones you want to use for a current test run.
  45. #
  46. # You can add default options anywhere in the file as well
  47. # with the DEFAULTS tag. This allows you to have default options
  48. # after the test options to keep the test options at the top
  49. # of the file. You can even place the DEFAULTS tag between
  50. # test cases (but not in the middle of a single test case)
  51. #
  52. # TEST_START
  53. # MIN_CONFIG = /home/test/config-test1
  54. #
  55. # DEFAULTS
  56. # MIN_CONFIG = /home/test/config-default
  57. #
  58. # TEST_START ITERATE 10
  59. #
  60. # The above will run the first test with MIN_CONFIG set to
  61. # /home/test/config-test-1. Then 10 tests will be executed
  62. # with MIN_CONFIG with /home/test/config-default.
  63. #
  64. # You can also disable defaults with the SKIP option
  65. #
  66. # DEFAULTS SKIP
  67. # MIN_CONFIG = /home/test/config-use-sometimes
  68. #
  69. # DEFAULTS
  70. # MIN_CONFIG = /home/test/config-most-times
  71. #
  72. # The above will ignore the first MIN_CONFIG. If you want to
  73. # use the first MIN_CONFIG, remove the SKIP from the first
  74. # DEFAULTS tag and add it to the second. Be careful, options
  75. # may only be declared once per test or default. If you have
  76. # the same option name under the same test or as default
  77. # ktest will fail to execute, and no tests will run.
  78. #
  79. # DEFAULTS OVERRIDE
  80. #
  81. # Options defined in the DEFAULTS section can not be duplicated
  82. # even if they are defined in two different DEFAULT sections.
  83. # This is done to catch mistakes where an option is added but
  84. # the previous option was forgotten about and not commented.
  85. #
  86. # The OVERRIDE keyword can be added to a section to allow this
  87. # section to override other DEFAULT sections values that have
  88. # been defined previously. It will only override options that
  89. # have been defined before its use. Options defined later
  90. # in a non override section will still error. The same option
  91. # can not be defined in the same section even if that section
  92. # is marked OVERRIDE.
  93. #
  94. #
  95. #
  96. # Both TEST_START and DEFAULTS sections can also have the IF keyword
  97. # The value after the IF must evaluate into a 0 or non 0 positive
  98. # integer, and can use the config variables (explained below).
  99. #
  100. # DEFAULTS IF ${IS_X86_32}
  101. #
  102. # The above will process the DEFAULTS section if the config
  103. # variable IS_X86_32 evaluates to a non zero positive integer
  104. # otherwise if it evaluates to zero, it will act the same
  105. # as if the SKIP keyword was used.
  106. #
  107. # The ELSE keyword can be used directly after a section with
  108. # a IF statement.
  109. #
  110. # TEST_START IF ${RUN_NET_TESTS}
  111. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
  112. #
  113. # ELSE
  114. #
  115. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-normal
  116. #
  117. #
  118. # The ELSE keyword can also contain an IF statement to allow multiple
  119. # if then else sections. But all the sections must be either
  120. # DEFAULT or TEST_START, they can not be a mixture.
  121. #
  122. # TEST_START IF ${RUN_NET_TESTS}
  123. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
  124. #
  125. # ELSE IF ${RUN_DISK_TESTS}
  126. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-tests
  127. #
  128. # ELSE IF ${RUN_CPU_TESTS}
  129. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-cpu
  130. #
  131. # ELSE
  132. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
  133. #
  134. # The if statement may also have comparisons that will and for
  135. # == and !=, strings may be used for both sides.
  136. #
  137. # BOX_TYPE := x86_32
  138. #
  139. # DEFAULTS IF ${BOX_TYPE} == x86_32
  140. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-32
  141. # ELSE
  142. # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-64
  143. #
  144. # The DEFINED keyword can be used by the IF statements too.
  145. # It returns true if the given config variable or option has been defined
  146. # or false otherwise.
  147. #
  148. #
  149. # DEFAULTS IF DEFINED USE_CC
  150. # CC := ${USE_CC}
  151. # ELSE
  152. # CC := gcc
  153. #
  154. #
  155. # As well as NOT DEFINED.
  156. #
  157. # DEFAULTS IF NOT DEFINED MAKE_CMD
  158. # MAKE_CMD := make ARCH=x86
  159. #
  160. #
  161. # And/or ops (&&,||) may also be used to make complex conditionals.
  162. #
  163. # TEST_START IF (DEFINED ALL_TESTS || ${MYTEST} == boottest) && ${MACHINE} == gandalf
  164. #
  165. # Notice the use of parentheses. Without any parentheses the above would be
  166. # processed the same as:
  167. #
  168. # TEST_START IF DEFINED ALL_TESTS || (${MYTEST} == boottest && ${MACHINE} == gandalf)
  169. #
  170. #
  171. #
  172. # INCLUDE file
  173. #
  174. # The INCLUDE keyword may be used in DEFAULT sections. This will
  175. # read another config file and process that file as well. The included
  176. # file can include other files, add new test cases or default
  177. # statements. Config variables will be passed to these files and changes
  178. # to config variables will be seen by top level config files. Including
  179. # a file is processed just like the contents of the file was cut and pasted
  180. # into the top level file, except, that include files that end with
  181. # TEST_START sections will have that section ended at the end of
  182. # the include file. That is, an included file is included followed
  183. # by another DEFAULT keyword.
  184. #
  185. # Unlike other files referenced in this config, the file path does not need
  186. # to be absolute. If the file does not start with '/', then the directory
  187. # that the current config file was located in is used. If no config by the
  188. # given name is found there, then the current directory is searched.
  189. #
  190. # INCLUDE myfile
  191. # DEFAULT
  192. #
  193. # is the same as:
  194. #
  195. # INCLUDE myfile
  196. #
  197. # Note, if the include file does not contain a full path, the file is
  198. # searched first by the location of the original include file, and then
  199. # by the location that ktest.pl was executed in.
  200. #
  201. #### Config variables ####
  202. #
  203. # This config file can also contain "config variables".
  204. # These are assigned with ":=" instead of the ktest option
  205. # assignment "=".
  206. #
  207. # The difference between ktest options and config variables
  208. # is that config variables can be used multiple times,
  209. # where each instance will override the previous instance.
  210. # And that they only live at time of processing this config.
  211. #
  212. # The advantage to config variables are that they can be used
  213. # by any option or any other config variables to define thing
  214. # that you may use over and over again in the options.
  215. #
  216. # For example:
  217. #
  218. # USER := root
  219. # TARGET := mybox
  220. # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
  221. #
  222. # TEST_START
  223. # MIN_CONFIG = config1
  224. # TEST = ${TEST_CASE}
  225. #
  226. # TEST_START
  227. # MIN_CONFIG = config2
  228. # TEST = ${TEST_CASE}
  229. #
  230. # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
  231. #
  232. # TEST_START
  233. # MIN_CONFIG = config1
  234. # TEST = ${TEST_CASE}
  235. #
  236. # TEST_START
  237. # MIN_CONFIG = config2
  238. # TEST = ${TEST_CASE}
  239. #
  240. # TEST_DIR := /home/me/test
  241. #
  242. # BUILD_DIR = ${TEST_DIR}/linux.git
  243. # OUTPUT_DIR = ${TEST_DIR}/test
  244. #
  245. # Note, the config variables are evaluated immediately, thus
  246. # updating TARGET after TEST_CASE has been assigned does nothing
  247. # to TEST_CASE.
  248. #
  249. # As shown in the example, to evaluate a config variable, you
  250. # use the ${X} convention. Simple $X will not work.
  251. #
  252. # If the config variable does not exist, the ${X} will not
  253. # be evaluated. Thus:
  254. #
  255. # MAKE_CMD = PATH=/mypath:${PATH} make
  256. #
  257. # If PATH is not a config variable, then the ${PATH} in
  258. # the MAKE_CMD option will be evaluated by the shell when
  259. # the MAKE_CMD option is passed into shell processing.
  260. #
  261. # Shell commands can also be inserted with the ${shell <command>}
  262. # expression. Note, this is case sensitive, thus ${SHELL <command>}
  263. # will not work.
  264. #
  265. # HOSTNAME := ${shell hostname}
  266. # DEFAULTS IF "${HOSTNAME}" == "frodo"
  267. #
  268. #### Using options in other options ####
  269. #
  270. # Options that are defined in the config file may also be used
  271. # by other options. All options are evaluated at time of
  272. # use (except that config variables are evaluated at config
  273. # processing time).
  274. #
  275. # If an ktest option is used within another option, instead of
  276. # typing it again in that option you can simply use the option
  277. # just like you can config variables.
  278. #
  279. # MACHINE = mybox
  280. #
  281. # TEST = ssh root@${MACHINE} /path/to/test
  282. #
  283. # The option will be used per test case. Thus:
  284. #
  285. # TEST_TYPE = test
  286. # TEST = ssh root@{MACHINE}
  287. #
  288. # TEST_START
  289. # MACHINE = box1
  290. #
  291. # TEST_START
  292. # MACHINE = box2
  293. #
  294. # For both test cases, MACHINE will be evaluated at the time
  295. # of the test case. The first test will run ssh root@box1
  296. # and the second will run ssh root@box2.
  297. #### Mandatory Default Options ####
  298. # These options must be in the default section, although most
  299. # may be overridden by test options.
  300. # The machine hostname that you will test
  301. #MACHINE = target
  302. # The box is expected to have ssh on normal bootup, provide the user
  303. # (most likely root, since you need privileged operations)
  304. #SSH_USER = root
  305. # The directory that contains the Linux source code
  306. #BUILD_DIR = /home/test/linux.git
  307. # The directory that the objects will be built
  308. # (can not be same as BUILD_DIR)
  309. #OUTPUT_DIR = /home/test/build/target
  310. # The location of the compiled file to copy to the target
  311. # (relative to OUTPUT_DIR)
  312. #BUILD_TARGET = arch/x86/boot/bzImage
  313. # The place to put your image on the test machine
  314. #TARGET_IMAGE = /boot/vmlinuz-test
  315. # A script or command to reboot the box
  316. #
  317. # Here is a digital loggers power switch example
  318. #POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
  319. #
  320. # Here is an example to reboot a virtual box on the current host
  321. # with the name "Guest".
  322. #POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
  323. # The script or command that reads the console
  324. #
  325. # If you use ttywatch server, something like the following would work.
  326. #CONSOLE = nc -d localhost 3001
  327. #
  328. # For a virtual machine with guest name "Guest".
  329. #CONSOLE = virsh console Guest
  330. # Signal to send to kill console.
  331. # ktest.pl will create a child process to monitor the console.
  332. # When the console is finished, ktest will kill the child process
  333. # with this signal.
  334. # (default INT)
  335. #CLOSE_CONSOLE_SIGNAL = HUP
  336. # Required version ending to differentiate the test
  337. # from other linux builds on the system.
  338. #LOCALVERSION = -test
  339. # For REBOOT_TYPE = grub2, you must specify where the grub.cfg
  340. # file is. This is the file that is searched to find the menu
  341. # option to boot to with GRUB_REBOOT
  342. #GRUB_FILE = /boot/grub2/grub.cfg
  343. # The tool for REBOOT_TYPE = grub2 or grub2bls to set the next reboot kernel
  344. # to boot into (one shot mode).
  345. # (default grub2_reboot)
  346. #GRUB_REBOOT = grub2_reboot
  347. # The grub title name for the test kernel to boot
  348. # (Only mandatory if REBOOT_TYPE = grub or grub2 or grub2bls)
  349. #
  350. # Note, ktest.pl will not update the grub menu.lst, you need to
  351. # manually add an option for the test. ktest.pl will search
  352. # the grub menu.lst for this option to find what kernel to
  353. # reboot into.
  354. #
  355. # For example, if in the /boot/grub/menu.lst the test kernel title has:
  356. # title Test Kernel
  357. # kernel vmlinuz-test
  358. #
  359. # For grub2, a search of top level "menuentry"s are done. No
  360. # submenu is searched. The menu is found by searching for the
  361. # contents of GRUB_MENU in the line that starts with "menuentry".
  362. # You may want to include the quotes around the option. For example:
  363. # for: menuentry 'Test Kernel'
  364. # do a: GRUB_MENU = 'Test Kernel'
  365. # For customizing, add your entry in /etc/grub.d/40_custom.
  366. #
  367. # For grub2bls, a search of "title"s are done. The menu is found
  368. # by searching for the contents of GRUB_MENU in the line that starts
  369. # with "title".
  370. #
  371. #GRUB_MENU = Test Kernel
  372. # For REBOOT_TYPE = syslinux, the name of the syslinux executable
  373. # (on the target) to use to set up the next reboot to boot the
  374. # test kernel.
  375. # (default extlinux)
  376. #SYSLINUX = syslinux
  377. # For REBOOT_TYPE = syslinux, the path that is passed to to the
  378. # syslinux command where syslinux is installed.
  379. # (default /boot/extlinux)
  380. #SYSLINUX_PATH = /boot/syslinux
  381. # For REBOOT_TYPE = syslinux, the syslinux label that references the
  382. # test kernel in the syslinux config file.
  383. # (default undefined)
  384. #SYSLINUX_LABEL = "test-kernel"
  385. # A script to reboot the target into the test kernel
  386. # This and SWITCH_TO_TEST are about the same, except
  387. # SWITCH_TO_TEST is run even for REBOOT_TYPE = grub.
  388. # This may be left undefined.
  389. # (default undefined)
  390. #REBOOT_SCRIPT =
  391. #### Optional Config Options (all have defaults) ####
  392. # Email options for receiving notifications. Users must setup
  393. # the specified mailer prior to using this feature.
  394. #
  395. # (default undefined)
  396. #MAILTO =
  397. #
  398. # Supported mailers: sendmail, mail, mailx
  399. # (default sendmail)
  400. #MAILER = sendmail
  401. #
  402. # The executable to run
  403. # (default: for sendmail "/usr/sbin/sendmail", otherwise equals ${MAILER})
  404. #MAIL_EXEC = /usr/sbin/sendmail
  405. #
  406. # The command used to send mail, which uses the above options
  407. # can be modified. By default if the mailer is "sendmail" then
  408. # MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | $MAIL_PATH/$MAILER -t $MAILTO
  409. # For mail or mailx:
  410. # MAIL_COMMAND = "$MAIL_PATH/$MAILER -s \'$SUBJECT\' $MAILTO <<< \'$MESSAGE\'
  411. # ktest.pl will do the substitution for MAIL_PATH, MAILER, MAILTO at the time
  412. # it sends the mail if "$FOO" format is used. If "${FOO}" format is used,
  413. # then the substitutions will occur at the time the config file is read.
  414. # But note, MAIL_PATH and MAILER require being set by the config file if
  415. # ${MAIL_PATH} or ${MAILER} are used, but not if $MAIL_PATH or $MAILER are.
  416. #MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | $MAIL_PATH/$MAILER -t $MAILTO
  417. #
  418. # Errors are defined as those would terminate the script
  419. # (default 1)
  420. #EMAIL_ON_ERROR = 1
  421. # (default 1)
  422. #EMAIL_WHEN_FINISHED = 1
  423. # (default 0)
  424. #EMAIL_WHEN_STARTED = 1
  425. #
  426. # Users can cancel the test by Ctrl^C
  427. # (default 0)
  428. #EMAIL_WHEN_CANCELED = 1
  429. #
  430. # If a test ends with an error and EMAIL_ON_ERROR is set as well
  431. # as a LOG_FILE is defined, then the log of the failing test will
  432. # be included in the email that is sent.
  433. # It is possible that the log may be very large, in which case,
  434. # only the last amount of the log should be sent. To limit how
  435. # much of the log is sent, set MAIL_MAX_SIZE. This will be the
  436. # size in bytes of the last portion of the log of the failed
  437. # test file. That is, if this is set to 100000, then only the
  438. # last 100 thousand bytes of the log file will be included in
  439. # the email.
  440. # (default undef)
  441. #MAIL_MAX_SIZE = 1000000
  442. # Start a test setup. If you leave this off, all options
  443. # will be default and the test will run once.
  444. # This is a label and not really an option (it takes no value).
  445. # You can append ITERATE and a number after it to iterate the
  446. # test a number of times, or SKIP to ignore this test.
  447. #
  448. #TEST_START
  449. #TEST_START ITERATE 5
  450. #TEST_START SKIP
  451. # Have the following options as default again. Used after tests
  452. # have already been defined by TEST_START. Optionally, you can
  453. # just define all default options before the first TEST_START
  454. # and you do not need this option.
  455. #
  456. # This is a label and not really an option (it takes no value).
  457. # You can append SKIP to this label and the options within this
  458. # section will be ignored.
  459. #
  460. # DEFAULTS
  461. # DEFAULTS SKIP
  462. # If you want to execute some command before the first test runs
  463. # you can set this option. Note, it can be set as a default option
  464. # or an option in the first test case. All other test cases will
  465. # ignore it. If both the default and first test have this option
  466. # set, then the first test will take precedence.
  467. #
  468. # default (undefined)
  469. #PRE_KTEST = ${SSH} ~/set_up_test
  470. # If you want to execute some command after all the tests have
  471. # completed, you can set this option. Note, it can be set as a
  472. # default or any test case can override it. If multiple test cases
  473. # set this option, then the last test case that set it will take
  474. # precedence
  475. #
  476. # default (undefined)
  477. #POST_KTEST = ${SSH} ~/dismantle_test
  478. # If you want to remove the kernel entry in Boot Loader Specification (BLS)
  479. # environment, use kernel-install command.
  480. # Here's the example:
  481. #POST_KTEST = ssh root@Test "/usr/bin/kernel-install remove $KERNEL_VERSION"
  482. # The default test type (default test)
  483. # The test types may be:
  484. # build - only build the kernel, do nothing else
  485. # install - build and install, but do nothing else (does not reboot)
  486. # boot - build, install, and boot the kernel
  487. # test - build, boot and if TEST is set, run the test script
  488. # (If TEST is not set, it defaults back to boot)
  489. # bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
  490. # patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
  491. #TEST_TYPE = test
  492. # Test to run if there is a successful boot and TEST_TYPE is test.
  493. # Must exit with 0 on success and non zero on error
  494. # default (undefined)
  495. #TEST = ssh user@machine /root/run_test
  496. # The build type is any make config type or special command
  497. # (default oldconfig)
  498. # nobuild - skip the clean and build step
  499. # useconfig:/path/to/config - use the given config and run
  500. # oldconfig on it.
  501. # This option is ignored if TEST_TYPE is patchcheck or bisect
  502. #BUILD_TYPE = randconfig
  503. # The make command (default make)
  504. # If you are building a 32bit x86 on a 64 bit host
  505. #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
  506. # Any build options for the make of the kernel (not for other makes, like configs)
  507. # (default "")
  508. #BUILD_OPTIONS = -j20
  509. # If you need to do some special handling before installing
  510. # you can add a script with this option.
  511. # The environment variable KERNEL_VERSION will be set to the
  512. # kernel version that is used.
  513. #
  514. # default (undefined)
  515. #PRE_INSTALL = ssh user@target rm -rf '/lib/modules/*-test*'
  516. # If you need an initrd, you can add a script or code here to install
  517. # it. The environment variable KERNEL_VERSION will be set to the
  518. # kernel version that is used. Remember to add the initrd line
  519. # to your grub menu.lst file.
  520. #
  521. # Here's a couple of examples to use:
  522. #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
  523. #
  524. # or on some systems:
  525. #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
  526. # If you want to add the kernel entry in Boot Loader Specification (BLS)
  527. # environment, use kernel-install command.
  528. # Here's the example:
  529. #POST_INSTALL = ssh root@Test "/usr/bin/kernel-install add $KERNEL_VERSION /boot/vmlinuz-$KERNEL_VERSION"
  530. # If for some reason you just want to boot the kernel and you do not
  531. # want the test to install anything new. For example, you may just want
  532. # to boot test the same kernel over and over and do not want to go through
  533. # the hassle of installing anything, you can set this option to 1
  534. # (default 0)
  535. #NO_INSTALL = 1
  536. # If there is a command that you want to run before the individual test
  537. # case executes, then you can set this option
  538. #
  539. # default (undefined)
  540. #PRE_TEST = ${SSH} reboot_to_special_kernel
  541. # To kill the entire test if PRE_TEST is defined but fails set this
  542. # to 1.
  543. # (default 0)
  544. #PRE_TEST_DIE = 1
  545. # If there is a command you want to run after the individual test case
  546. # completes, then you can set this option.
  547. #
  548. # default (undefined)
  549. #POST_TEST = cd ${BUILD_DIR}; git reset --hard
  550. # If there is a script that you require to run before the build is done
  551. # you can specify it with PRE_BUILD.
  552. #
  553. # One example may be if you must add a temporary patch to the build to
  554. # fix a unrelated bug to perform a patchcheck test. This will apply the
  555. # patch before each build that is made. Use the POST_BUILD to do a git reset --hard
  556. # to remove the patch.
  557. #
  558. # (default undef)
  559. #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
  560. # To specify if the test should fail if the PRE_BUILD fails,
  561. # PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
  562. # result is ignored.
  563. # (default 0)
  564. # PRE_BUILD_DIE = 1
  565. # If there is a script that should run after the build is done
  566. # you can specify it with POST_BUILD.
  567. #
  568. # As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
  569. # made by the PRE_BUILD.
  570. #
  571. # (default undef)
  572. #POST_BUILD = cd ${BUILD_DIR} && git reset --hard
  573. # To specify if the test should fail if the POST_BUILD fails,
  574. # POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
  575. # result is ignored.
  576. # (default 0)
  577. #POST_BUILD_DIE = 1
  578. # Way to reboot the box to the test kernel.
  579. # Only valid options so far are "grub", "grub2", "syslinux" and "script"
  580. # (default grub)
  581. # If you specify grub, it will assume grub version 1
  582. # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
  583. # and select that target to reboot to the kernel. If this is not
  584. # your setup, then specify "script" and have a command or script
  585. # specified in REBOOT_SCRIPT to boot to the target.
  586. #
  587. # For REBOOT_TYPE = grub2, you must define both GRUB_MENU and
  588. # GRUB_FILE.
  589. #
  590. # For REBOOT_TYPE = grub2bls, you must define GRUB_MENU.
  591. #
  592. # For REBOOT_TYPE = syslinux, you must define SYSLINUX_LABEL, and
  593. # perhaps modify SYSLINUX (default extlinux) and SYSLINUX_PATH
  594. # (default /boot/extlinux)
  595. #
  596. # The entry in /boot/grub/menu.lst must be entered in manually.
  597. # The test will not modify that file.
  598. #REBOOT_TYPE = grub
  599. # If you are using a machine that doesn't boot with grub, and
  600. # perhaps gets its kernel from a remote server (tftp), then
  601. # you can use this option to update the target image with the
  602. # test image.
  603. #
  604. # You could also do the same with POST_INSTALL, but the difference
  605. # between that option and this option is that POST_INSTALL runs
  606. # after the install, where this one runs just before a reboot.
  607. # (default undefined)
  608. #SWITCH_TO_TEST = cp ${OUTPUT_DIR}/${BUILD_TARGET} ${TARGET_IMAGE}
  609. # If you are using a machine that doesn't boot with grub, and
  610. # perhaps gets its kernel from a remote server (tftp), then
  611. # you can use this option to update the target image with the
  612. # the known good image to reboot safely back into.
  613. #
  614. # This option holds a command that will execute before needing
  615. # to reboot to a good known image.
  616. # (default undefined)
  617. #SWITCH_TO_GOOD = ssh ${SSH_USER}/${MACHINE} cp good_image ${TARGET_IMAGE}
  618. # The min config that is needed to build for the machine
  619. # A nice way to create this is with the following:
  620. #
  621. # $ ssh target
  622. # $ lsmod > mymods
  623. # $ scp mymods host:/tmp
  624. # $ exit
  625. # $ cd linux.git
  626. # $ rm .config
  627. # $ make LSMOD=mymods localyesconfig
  628. # $ grep '^CONFIG' .config > /home/test/config-min
  629. #
  630. # If you want even less configs:
  631. #
  632. # log in directly to target (do not ssh)
  633. #
  634. # $ su
  635. # # lsmod | cut -d' ' -f1 | xargs rmmod
  636. #
  637. # repeat the above several times
  638. #
  639. # # lsmod > mymods
  640. # # reboot
  641. #
  642. # May need to reboot to get your network back to copy the mymods
  643. # to the host, and then remove the previous .config and run the
  644. # localyesconfig again. The CONFIG_MIN generated like this will
  645. # not guarantee network activity to the box so the TEST_TYPE of
  646. # test may fail.
  647. #
  648. # You might also want to set:
  649. # CONFIG_CMDLINE="<your options here>"
  650. # randconfig may set the above and override your real command
  651. # line options.
  652. # (default undefined)
  653. #MIN_CONFIG = /home/test/config-min
  654. # Sometimes there's options that just break the boot and
  655. # you do not care about. Here are a few:
  656. # # CONFIG_STAGING is not set
  657. # Staging drivers are horrible, and can break the build.
  658. # # CONFIG_SCSI_DEBUG is not set
  659. # SCSI_DEBUG may change your root partition
  660. # # CONFIG_KGDB_SERIAL_CONSOLE is not set
  661. # KGDB may cause oops waiting for a connection that's not there.
  662. # This option points to the file containing config options that will be prepended
  663. # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
  664. #
  665. # Note, config options in MIN_CONFIG will override these options.
  666. #
  667. # (default undefined)
  668. #ADD_CONFIG = /home/test/config-broken
  669. # The location on the host where to write temp files
  670. # (default /tmp/ktest/${MACHINE})
  671. #TMP_DIR = /tmp/ktest/${MACHINE}
  672. # Optional log file to write the status (recommended)
  673. # Note, this is a DEFAULT section only option.
  674. # (default undefined)
  675. #LOG_FILE = /home/test/logfiles/target.log
  676. # Remove old logfile if it exists before starting all tests.
  677. # Note, this is a DEFAULT section only option.
  678. # (default 0)
  679. #CLEAR_LOG = 0
  680. # Line to define a successful boot up in console output.
  681. # This is what the line contains, not the entire line. If you need
  682. # the entire line to match, then use regular expression syntax like:
  683. # (do not add any quotes around it)
  684. #
  685. # SUCCESS_LINE = ^MyBox Login:$
  686. #
  687. # (default "login:")
  688. #SUCCESS_LINE = login:
  689. # To speed up between reboots, defining a line that the
  690. # default kernel produces that represents that the default
  691. # kernel has successfully booted and can be used to pass
  692. # a new test kernel to it. Otherwise ktest.pl will wait till
  693. # SLEEP_TIME to continue.
  694. # (default undefined)
  695. #REBOOT_SUCCESS_LINE = login:
  696. # In case the console constantly fills the screen, having
  697. # a specified time to stop the test after success is recommended.
  698. # (in seconds)
  699. # (default 10)
  700. #STOP_AFTER_SUCCESS = 10
  701. # In case the console constantly fills the screen, having
  702. # a specified time to stop the test after failure is recommended.
  703. # (in seconds)
  704. # (default 60)
  705. #STOP_AFTER_FAILURE = 60
  706. # In case the console constantly fills the screen, having
  707. # a specified time to stop the test if it never succeeds nor fails
  708. # is recommended.
  709. # Note: this is ignored if a success or failure is detected.
  710. # (in seconds)
  711. # (default 600, -1 is to never stop)
  712. #STOP_TEST_AFTER = 600
  713. # Stop testing if a build fails. If set, the script will end if
  714. # a failure is detected, otherwise it will save off the .config,
  715. # dmesg and bootlog in a directory called
  716. # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
  717. # if the STORE_FAILURES directory is set.
  718. # (default 1)
  719. # Note, even if this is set to zero, there are some errors that still
  720. # stop the tests.
  721. #DIE_ON_FAILURE = 1
  722. # Directory to store failure directories on failure. If this is not
  723. # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
  724. # bootlog. This option is ignored if DIE_ON_FAILURE is not set.
  725. # (default undefined)
  726. #STORE_FAILURES = /home/test/failures
  727. # Directory to store success directories on success. If this is not
  728. # set, the .config, dmesg and bootlog will not be saved if a
  729. # test succeeds.
  730. # (default undefined)
  731. #STORE_SUCCESSES = /home/test/successes
  732. # Build without doing a make mrproper, or removing .config
  733. # (default 0)
  734. #BUILD_NOCLEAN = 0
  735. # As the test reads the console, after it hits the SUCCESS_LINE
  736. # the time it waits for the monitor to settle down between reads
  737. # can usually be lowered.
  738. # (in seconds) (default 1)
  739. #BOOTED_TIMEOUT = 1
  740. # The timeout in seconds when we consider the box hung after
  741. # the console stop producing output. Be sure to leave enough
  742. # time here to get pass a reboot. Some machines may not produce
  743. # any console output for a long time during a reboot. You do
  744. # not want the test to fail just because the system was in
  745. # the process of rebooting to the test kernel.
  746. # (default 120)
  747. #TIMEOUT = 120
  748. # The timeout in seconds when to test if the box can be rebooted
  749. # or not. Before issuing the reboot command, a ssh connection
  750. # is attempted to see if the target machine is still active.
  751. # If the target does not connect within this timeout, a power cycle
  752. # is issued instead of a reboot.
  753. # CONNECT_TIMEOUT = 25
  754. # The timeout in seconds for how long to wait for any running command
  755. # to timeout. If not defined, it will let it go indefinitely.
  756. # (default undefined)
  757. #RUN_TIMEOUT = 600
  758. # In between tests, a reboot of the box may occur, and this
  759. # is the time to wait for the console after it stops producing
  760. # output. Some machines may not produce a large lag on reboot
  761. # so this should accommodate it.
  762. # The difference between this and TIMEOUT, is that TIMEOUT happens
  763. # when rebooting to the test kernel. This sleep time happens
  764. # after a test has completed and we are about to start running
  765. # another test. If a reboot to the reliable kernel happens,
  766. # we wait SLEEP_TIME for the console to stop producing output
  767. # before starting the next test.
  768. #
  769. # You can speed up reboot times even more by setting REBOOT_SUCCESS_LINE.
  770. # (default 60)
  771. #SLEEP_TIME = 60
  772. # The time in between bisects to sleep (in seconds)
  773. # (default 60)
  774. #BISECT_SLEEP_TIME = 60
  775. # The max wait time (in seconds) for waiting for the console to finish.
  776. # If for some reason, the console is outputting content without
  777. # ever finishing, this will cause ktest to get stuck. This
  778. # option is the max time ktest will wait for the monitor (console)
  779. # to settle down before continuing.
  780. # (default 1800)
  781. #MAX_MONITOR_WAIT
  782. # The time in between patch checks to sleep (in seconds)
  783. # (default 60)
  784. #PATCHCHECK_SLEEP_TIME = 60
  785. # Reboot the target box on error (default 0)
  786. #REBOOT_ON_ERROR = 0
  787. # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
  788. # Note, this is a DEFAULT section only option.
  789. # (default 0)
  790. #POWEROFF_ON_ERROR = 0
  791. # Power off the target after all tests have completed successfully
  792. # Note, this is a DEFAULT section only option.
  793. # (default 0)
  794. #POWEROFF_ON_SUCCESS = 0
  795. # Reboot the target after all test completed successfully (default 1)
  796. # (ignored if POWEROFF_ON_SUCCESS is set)
  797. #REBOOT_ON_SUCCESS = 1
  798. # In case there are issues with rebooting, you can specify this
  799. # to always powercycle after this amount of time after calling
  800. # reboot.
  801. # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
  802. # makes it powercycle immediately after rebooting. Do not define
  803. # it if you do not want it.
  804. # (default undefined)
  805. #POWERCYCLE_AFTER_REBOOT = 5
  806. # In case there's issues with halting, you can specify this
  807. # to always poweroff after this amount of time after calling
  808. # halt.
  809. # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
  810. # makes it poweroff immediately after halting. Do not define
  811. # it if you do not want it.
  812. # (default undefined)
  813. #POWEROFF_AFTER_HALT = 20
  814. # A script or command to power off the box (default undefined)
  815. # Needed for POWEROFF_ON_ERROR and SUCCESS
  816. #
  817. # Example for digital loggers power switch:
  818. #POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
  819. #
  820. # Example for a virtual guest call "Guest".
  821. #POWER_OFF = virsh destroy Guest
  822. # To have the build fail on "new" warnings, create a file that
  823. # contains a list of all known warnings (they must match exactly
  824. # to the line with 'warning:', 'error:' or 'Error:'. If the option
  825. # WARNINGS_FILE is set, then that file will be read, and if the
  826. # build detects a warning, it will examine this file and if the
  827. # warning does not exist in it, it will fail the build.
  828. #
  829. # Note, if this option is defined to a file that does not exist
  830. # then any warning will fail the build.
  831. # (see make_warnings_file below)
  832. #
  833. # (optional, default undefined)
  834. #WARNINGS_FILE = ${OUTPUT_DIR}/warnings_file
  835. # The way to execute a command on the target
  836. # (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
  837. # The variables SSH_USER, MACHINE and SSH_COMMAND are defined
  838. #SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
  839. # The way to copy a file to the target (install and modules)
  840. # (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
  841. # The variables SSH_USER, MACHINE are defined by the config
  842. # SRC_FILE and DST_FILE are ktest internal variables and
  843. # should only have '$' and not the '${}' notation.
  844. # (default scp $SRC_FILE ${SSH_USER}@${MACHINE}:$DST_FILE)
  845. #SCP_TO_TARGET = echo skip scp for $SRC_FILE $DST_FILE
  846. # If install needs to be different than modules, then this
  847. # option will override the SCP_TO_TARGET for installation.
  848. # (default ${SCP_TO_TARGET} )
  849. #SCP_TO_TARGET_INSTALL = scp $SRC_FILE tftp@tftpserver:$DST_FILE
  850. # The nice way to reboot the target
  851. # (default ssh $SSH_USER@$MACHINE reboot)
  852. # The variables SSH_USER and MACHINE are defined.
  853. #REBOOT = ssh $SSH_USER@$MACHINE reboot
  854. # The return code of REBOOT
  855. # (default 255)
  856. #REBOOT_RETURN_CODE = 255
  857. # The way triple faults are detected is by testing the kernel
  858. # banner. If the kernel banner for the kernel we are testing is
  859. # found, and then later a kernel banner for another kernel version
  860. # is found, it is considered that we encountered a triple fault,
  861. # and there is no panic or callback, but simply a reboot.
  862. # To disable this (because it did a false positive) set the following
  863. # to 0.
  864. # (default 1)
  865. #DETECT_TRIPLE_FAULT = 0
  866. # All options in the config file should be either used by ktest
  867. # or could be used within a value of another option. If an option
  868. # in the config file is not used, ktest will warn about it and ask
  869. # if you want to continue.
  870. #
  871. # If you don't care if there are non-used options, enable this
  872. # option. Be careful though, a non-used option is usually a sign
  873. # of an option name being typed incorrectly.
  874. # (default 0)
  875. #IGNORE_UNUSED = 1
  876. # When testing a kernel that happens to have WARNINGs, and call
  877. # traces, ktest.pl will detect these and fail a boot or test run
  878. # due to warnings. By setting this option, ktest will ignore
  879. # call traces, and will not fail a test if the kernel produces
  880. # an oops. Use this option with care.
  881. # (default 0)
  882. #IGNORE_ERRORS = 1
  883. #### Per test run options ####
  884. # The following options are only allowed in TEST_START sections.
  885. # They are ignored in the DEFAULTS sections.
  886. #
  887. # All of these are optional and undefined by default, although
  888. # some of these options are required for TEST_TYPE of patchcheck
  889. # and bisect.
  890. #
  891. #
  892. # CHECKOUT = branch
  893. #
  894. # If the BUILD_DIR is a git repository, then you can set this option
  895. # to checkout the given branch before running the TEST. If you
  896. # specify this for the first run, that branch will be used for
  897. # all preceding tests until a new CHECKOUT is set.
  898. #
  899. #
  900. # TEST_NAME = name
  901. #
  902. # If you want the test to have a name that is displayed in
  903. # the test result banner at the end of the test, then use this
  904. # option. This is useful to search for the RESULT keyword and
  905. # not have to translate a test number to a test in the config.
  906. #
  907. # For TEST_TYPE = patchcheck
  908. #
  909. # This expects the BUILD_DIR to be a git repository, and
  910. # will checkout the PATCHCHECK_START commit.
  911. #
  912. # The option BUILD_TYPE will be ignored.
  913. #
  914. # The MIN_CONFIG will be used for all builds of the patchcheck. The build type
  915. # used for patchcheck is oldconfig.
  916. #
  917. # PATCHCHECK_START is required and is the first patch to
  918. # test (the SHA1 of the commit). You may also specify anything
  919. # that git checkout allows (branch name, tag, HEAD~3).
  920. #
  921. # PATCHCHECK_END is the last patch to check (default HEAD)
  922. #
  923. # PATCHCHECK_CHERRY if set to non zero, then git cherry will be
  924. # performed against PATCHCHECK_START and PATCHCHECK_END. That is
  925. #
  926. # git cherry ${PATCHCHECK_START} ${PATCHCHECK_END}
  927. #
  928. # Then the changes found will be tested.
  929. #
  930. # Note, PATCHCHECK_CHERRY requires PATCHCHECK_END to be defined.
  931. # (default 0)
  932. #
  933. # PATCHCHECK_TYPE is required and is the type of test to run:
  934. # build, boot, test.
  935. #
  936. # Note, the build test will look for warnings, if a warning occurred
  937. # in a file that a commit touches, the build will fail, unless
  938. # IGNORE_WARNINGS is set for the given commit's sha1
  939. #
  940. # IGNORE_WARNINGS can be used to disable the failure of patchcheck
  941. # on a particular commit (SHA1). You can add more than one commit
  942. # by adding a list of SHA1s that are space delimited.
  943. #
  944. # If BUILD_NOCLEAN is set, then make mrproper will not be run on
  945. # any of the builds, just like all other TEST_TYPE tests. But
  946. # what makes patchcheck different from the other tests, is if
  947. # BUILD_NOCLEAN is not set, only the first and last patch run
  948. # make mrproper. This helps speed up the test.
  949. #
  950. # Example:
  951. # TEST_START
  952. # TEST_TYPE = patchcheck
  953. # CHECKOUT = mybranch
  954. # PATCHCHECK_TYPE = boot
  955. # PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
  956. # PATCHCHECK_END = HEAD~2
  957. # IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
  958. #
  959. #
  960. #
  961. # For TEST_TYPE = bisect
  962. #
  963. # You can specify a git bisect if the BUILD_DIR is a git repository.
  964. # The MIN_CONFIG will be used for all builds of the bisect. The build type
  965. # used for bisecting is oldconfig.
  966. #
  967. # The option BUILD_TYPE will be ignored.
  968. #
  969. # BISECT_TYPE is the type of test to perform:
  970. # build - bad fails to build
  971. # boot - bad builds but fails to boot
  972. # test - bad boots but fails a test
  973. #
  974. # BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
  975. # BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
  976. #
  977. # The above three options are required for a bisect operation.
  978. #
  979. # BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
  980. #
  981. # If an operation failed in the bisect that was not expected to
  982. # fail. Then the test ends. The state of the BUILD_DIR will be
  983. # left off at where the failure occurred. You can examine the
  984. # reason for the failure, and perhaps even find a git commit
  985. # that would work to continue with. You can run:
  986. #
  987. # git bisect log > /path/to/replay/file
  988. #
  989. # The adding:
  990. #
  991. # BISECT_REPLAY= /path/to/replay/file
  992. #
  993. # And running the test again. The test will perform the initial
  994. # git bisect start, git bisect good, and git bisect bad, and
  995. # then it will run git bisect replay on this file, before
  996. # continuing with the bisect.
  997. #
  998. # BISECT_START = commit (optional, default undefined)
  999. #
  1000. # As with BISECT_REPLAY, if the test failed on a commit that
  1001. # just happen to have a bad commit in the middle of the bisect,
  1002. # and you need to skip it. If BISECT_START is defined, it
  1003. # will checkout that commit after doing the initial git bisect start,
  1004. # git bisect good, git bisect bad, and running the git bisect replay
  1005. # if the BISECT_REPLAY is set.
  1006. #
  1007. # BISECT_SKIP = 1 (optional, default 0)
  1008. #
  1009. # If BISECT_TYPE is set to test but the build fails, ktest will
  1010. # simply fail the test and end their. You could use BISECT_REPLAY
  1011. # and BISECT_START to resume after you found a new starting point,
  1012. # or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
  1013. # when something other than the BISECT_TYPE fails, ktest.pl will
  1014. # run "git bisect skip" and try again.
  1015. #
  1016. # BISECT_FILES = <path> (optional, default undefined)
  1017. #
  1018. # To just run the git bisect on a specific path, set BISECT_FILES.
  1019. # For example:
  1020. #
  1021. # BISECT_FILES = arch/x86 kernel/time
  1022. #
  1023. # Will run the bisect with "git bisect start -- arch/x86 kernel/time"
  1024. #
  1025. # BISECT_REVERSE = 1 (optional, default 0)
  1026. #
  1027. # In those strange instances where it was broken forever
  1028. # and you are trying to find where it started to work!
  1029. # Set BISECT_GOOD to the commit that was last known to fail
  1030. # Set BISECT_BAD to the commit that is known to start working.
  1031. # With BISECT_REVERSE = 1, The test will consider failures as
  1032. # good, and success as bad.
  1033. #
  1034. # BISECT_MANUAL = 1 (optional, default 0)
  1035. #
  1036. # In case there's a problem with automating the bisect for
  1037. # whatever reason. (Can't reboot, want to inspect each iteration)
  1038. # Doing a BISECT_MANUAL will have the test wait for you to
  1039. # tell it if the test passed or failed after each iteration.
  1040. # This is basically the same as running git bisect yourself
  1041. # but ktest will rebuild and install the kernel for you.
  1042. #
  1043. # BISECT_CHECK = 1 (optional, default 0)
  1044. #
  1045. # Just to be sure the good is good and bad is bad, setting
  1046. # BISECT_CHECK to 1 will start the bisect by first checking
  1047. # out BISECT_BAD and makes sure it fails, then it will check
  1048. # out BISECT_GOOD and makes sure it succeeds before starting
  1049. # the bisect (it works for BISECT_REVERSE too).
  1050. #
  1051. # You can limit the test to just check BISECT_GOOD or
  1052. # BISECT_BAD with BISECT_CHECK = good or
  1053. # BISECT_CHECK = bad, respectively.
  1054. #
  1055. # BISECT_TRIES = 5 (optional, default 1)
  1056. #
  1057. # For those cases that it takes several tries to hit a bug,
  1058. # the BISECT_TRIES is useful. It is the number of times the
  1059. # test is ran before it says the kernel is good. The first failure
  1060. # will stop trying and mark the current SHA1 as bad.
  1061. #
  1062. # Note, as with all race bugs, there's no guarantee that if
  1063. # it succeeds, it is really a good bisect. But it helps in case
  1064. # the bug is some what reliable.
  1065. #
  1066. # You can set BISECT_TRIES to zero, and all tests will be considered
  1067. # good, unless you also set BISECT_MANUAL.
  1068. #
  1069. # BISECT_RET_GOOD = 0 (optional, default undefined)
  1070. #
  1071. # In case the specificed test returns something other than just
  1072. # 0 for good, and non-zero for bad, you can override 0 being
  1073. # good by defining BISECT_RET_GOOD.
  1074. #
  1075. # BISECT_RET_BAD = 1 (optional, default undefined)
  1076. #
  1077. # In case the specificed test returns something other than just
  1078. # 0 for good, and non-zero for bad, you can override non-zero being
  1079. # bad by defining BISECT_RET_BAD.
  1080. #
  1081. # BISECT_RET_ABORT = 255 (optional, default undefined)
  1082. #
  1083. # If you need to abort the bisect if the test discovers something
  1084. # that was wrong, you can define BISECT_RET_ABORT to be the error
  1085. # code returned by the test in order to abort the bisect.
  1086. #
  1087. # BISECT_RET_SKIP = 2 (optional, default undefined)
  1088. #
  1089. # If the test detects that the current commit is neither good
  1090. # nor bad, but something else happened (another bug detected)
  1091. # you can specify BISECT_RET_SKIP to an error code that the
  1092. # test returns when it should skip the current commit.
  1093. #
  1094. # BISECT_RET_DEFAULT = good (optional, default undefined)
  1095. #
  1096. # You can override the default of what to do when the above
  1097. # options are not hit. This may be one of, "good", "bad",
  1098. # "abort" or "skip" (without the quotes).
  1099. #
  1100. # Note, if you do not define any of the previous BISECT_RET_*
  1101. # and define BISECT_RET_DEFAULT, all bisects results will do
  1102. # what the BISECT_RET_DEFAULT has.
  1103. #
  1104. #
  1105. # Example:
  1106. # TEST_START
  1107. # TEST_TYPE = bisect
  1108. # BISECT_GOOD = v2.6.36
  1109. # BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
  1110. # BISECT_TYPE = build
  1111. # MIN_CONFIG = /home/test/config-bisect
  1112. #
  1113. #
  1114. #
  1115. # For TEST_TYPE = config_bisect
  1116. #
  1117. # In those cases that you have two different configs. One of them
  1118. # work, the other does not, and you do not know what config causes
  1119. # the problem.
  1120. # The TEST_TYPE config_bisect will bisect the bad config looking for
  1121. # what config causes the failure.
  1122. #
  1123. # The way it works is this:
  1124. #
  1125. # You can specify a good config with CONFIG_BISECT_GOOD, otherwise it
  1126. # will use the MIN_CONFIG, and if that's not specified, it will use
  1127. # the config that comes with "make defconfig".
  1128. #
  1129. # It runs both the good and bad configs through a make oldconfig to
  1130. # make sure that they are set up for the kernel that is checked out.
  1131. #
  1132. # It then reads the configs that are set, as well as the ones that are
  1133. # not set for both the good and bad configs, and then compares them.
  1134. # It will set half of the good configs within the bad config (note,
  1135. # "set" means to make the bad config match the good config, a config
  1136. # in the good config that is off, will be turned off in the bad
  1137. # config. That is considered a "set").
  1138. #
  1139. # It tests this new config and if it works, it becomes the new good
  1140. # config, otherwise it becomes the new bad config. It continues this
  1141. # process until there's only one config left and it will report that
  1142. # config.
  1143. #
  1144. # The "bad config" can also be a config that is needed to boot but was
  1145. # disabled because it depended on something that wasn't set.
  1146. #
  1147. # During this process, it saves the current good and bad configs in
  1148. # ${TMP_DIR}/good_config and ${TMP_DIR}/bad_config respectively.
  1149. # If you stop the test, you can copy them to a new location to
  1150. # reuse them again.
  1151. #
  1152. # Although the MIN_CONFIG may be the config it starts with, the
  1153. # MIN_CONFIG is ignored.
  1154. #
  1155. # The option BUILD_TYPE will be ignored.
  1156. #
  1157. # CONFIG_BISECT_TYPE is the type of test to perform:
  1158. # build - bad fails to build
  1159. # boot - bad builds but fails to boot
  1160. # test - bad boots but fails a test
  1161. #
  1162. # CONFIG_BISECT is the config that failed to boot
  1163. #
  1164. # If BISECT_MANUAL is set, it will pause between iterations.
  1165. # This is useful to use just ktest.pl just for the config bisect.
  1166. # If you set it to build, it will run the bisect and you can
  1167. # control what happens in between iterations. It will ask you if
  1168. # the test succeeded or not and continue the config bisect.
  1169. #
  1170. # CONFIG_BISECT_GOOD (optional)
  1171. # If you have a good config to start with, then you
  1172. # can specify it with CONFIG_BISECT_GOOD. Otherwise
  1173. # the MIN_CONFIG is the base, if MIN_CONFIG is not set
  1174. # It will build a config with "make defconfig"
  1175. #
  1176. # CONFIG_BISECT_CHECK (optional)
  1177. # Set this to 1 if you want to confirm that the config ktest
  1178. # generates (the bad config with the min config) is still bad.
  1179. # It may be that the min config fixes what broke the bad config
  1180. # and the test will not return a result.
  1181. # Set it to "good" to test only the good config and set it
  1182. # to "bad" to only test the bad config.
  1183. #
  1184. # CONFIG_BISECT_EXEC (optional)
  1185. # The config bisect is a separate program that comes with ktest.pl.
  1186. # By default, it will look for:
  1187. # `pwd`/config-bisect.pl # the location ktest.pl was executed from.
  1188. # If it does not find it there, it will look for:
  1189. # `dirname <ktest.pl>`/config-bisect.pl # The directory that holds ktest.pl
  1190. # If it does not find it there, it will look for:
  1191. # ${BUILD_DIR}/tools/testing/ktest/config-bisect.pl
  1192. # Setting CONFIG_BISECT_EXEC will override where it looks.
  1193. #
  1194. # Example:
  1195. # TEST_START
  1196. # TEST_TYPE = config_bisect
  1197. # CONFIG_BISECT_TYPE = build
  1198. # CONFIG_BISECT = /home/test/config-bad
  1199. # MIN_CONFIG = /home/test/config-min
  1200. # BISECT_MANUAL = 1
  1201. #
  1202. #
  1203. #
  1204. # For TEST_TYPE = make_min_config
  1205. #
  1206. # After doing a make localyesconfig, your kernel configuration may
  1207. # not be the most useful minimum configuration. Having a true minimum
  1208. # config that you can use against other configs is very useful if
  1209. # someone else has a config that breaks on your code. By only forcing
  1210. # those configurations that are truly required to boot your machine
  1211. # will give you less of a chance that one of your set configurations
  1212. # will make the bug go away. This will give you a better chance to
  1213. # be able to reproduce the reported bug matching the broken config.
  1214. #
  1215. # Note, this does take some time, and may require you to run the
  1216. # test over night, or perhaps over the weekend. But it also allows
  1217. # you to interrupt it, and gives you the current minimum config
  1218. # that was found till that time.
  1219. #
  1220. # Note, this test automatically assumes a BUILD_TYPE of oldconfig
  1221. # and its test type acts like boot.
  1222. # TODO: add a test version that makes the config do more than just
  1223. # boot, like having network access.
  1224. #
  1225. # To save time, the test does not just grab any option and test
  1226. # it. The Kconfig files are examined to determine the dependencies
  1227. # of the configs. If a config is chosen that depends on another
  1228. # config, that config will be checked first. By checking the
  1229. # parents first, we can eliminate whole groups of configs that
  1230. # may have been enabled.
  1231. #
  1232. # For example, if a USB device config is chosen and depends on CONFIG_USB,
  1233. # the CONFIG_USB will be tested before the device. If CONFIG_USB is
  1234. # found not to be needed, it, as well as all configs that depend on
  1235. # it, will be disabled and removed from the current min_config.
  1236. #
  1237. # OUTPUT_MIN_CONFIG is the path and filename of the file that will
  1238. # be created from the MIN_CONFIG. If you interrupt the test, set
  1239. # this file as your new min config, and use it to continue the test.
  1240. # This file does not need to exist on start of test.
  1241. # This file is not created until a config is found that can be removed.
  1242. # If this file exists, you will be prompted if you want to use it
  1243. # as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG
  1244. # is not defined.
  1245. # (required field)
  1246. #
  1247. # START_MIN_CONFIG is the config to use to start the test with.
  1248. # you can set this as the same OUTPUT_MIN_CONFIG, but if you do
  1249. # the OUTPUT_MIN_CONFIG file must exist.
  1250. # (default MIN_CONFIG)
  1251. #
  1252. # IGNORE_CONFIG is used to specify a config file that has configs that
  1253. # you already know must be set. Configs are written here that have
  1254. # been tested and proved to be required. It is best to define this
  1255. # file if you intend on interrupting the test and running it where
  1256. # it left off. New configs that it finds will be written to this file
  1257. # and will not be tested again in later runs.
  1258. # (optional)
  1259. #
  1260. # MIN_CONFIG_TYPE can be either 'boot' or 'test'. With 'boot' it will
  1261. # test if the created config can just boot the machine. If this is
  1262. # set to 'test', then the TEST option must be defined and the created
  1263. # config will not only boot the target, but also make sure that the
  1264. # config lets the test succeed. This is useful to make sure the final
  1265. # config that is generated allows network activity (ssh).
  1266. # (optional)
  1267. #
  1268. # USE_OUTPUT_MIN_CONFIG set this to 1 if you do not want to be prompted
  1269. # about using the OUTPUT_MIN_CONFIG as the MIN_CONFIG as the starting
  1270. # point. Set it to 0 if you want to always just use the given MIN_CONFIG.
  1271. # If it is not defined, it will prompt you to pick which config
  1272. # to start with (MIN_CONFIG or OUTPUT_MIN_CONFIG).
  1273. #
  1274. # Example:
  1275. #
  1276. # TEST_TYPE = make_min_config
  1277. # OUTPUT_MIN_CONFIG = /path/to/config-new-min
  1278. # START_MIN_CONFIG = /path/to/config-min
  1279. # IGNORE_CONFIG = /path/to/config-tested
  1280. # MIN_CONFIG_TYPE = test
  1281. # TEST = ssh ${USER}@${MACHINE} echo hi
  1282. #
  1283. #
  1284. #
  1285. #
  1286. # For TEST_TYPE = make_warnings_file
  1287. #
  1288. # If you want the build to fail when a new warning is discovered
  1289. # you set the WARNINGS_FILE to point to a file of known warnings.
  1290. #
  1291. # The test "make_warnings_file" will let you create a new warnings
  1292. # file before you run other tests, like patchcheck.
  1293. #
  1294. # What this test does is to run just a build, you still need to
  1295. # specify BUILD_TYPE to tell the test what type of config to use.
  1296. # A BUILD_TYPE of nobuild will fail this test.
  1297. #
  1298. # The test will do the build and scan for all warnings. Any warning
  1299. # it discovers will be saved in the WARNINGS_FILE (required) option.
  1300. #
  1301. # It is recommended (but not necessary) to make sure BUILD_NOCLEAN is
  1302. # off, so that a full build is done (make mrproper is performed).
  1303. # That way, all warnings will be captured.
  1304. #
  1305. # Example:
  1306. #
  1307. # TEST_TYPE = make_warnings_file
  1308. # WARNINGS_FILE = ${OUTPUT_DIR}
  1309. # BUILD_TYPE = useconfig:oldconfig
  1310. # CHECKOUT = v3.8
  1311. # BUILD_NOCLEAN = 0
  1312. #