sample.conf 25 KB

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