sample.conf 49 KB

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