forked from ~ljy/RK356X_SDK_RELEASE
blame | history | patch | commit | commitdiff
hc
2024-02-20 e636c8d336489bf3eed5878299e6cc045bbad077 
 kernel/tools/testing/ktest/sample.conf
....@@ -10,7 +10,7 @@
1010 #
1111 
1212 # Options set in the beginning of the file are considered to be
13
-# default options. These options can be overriden by test specific
13
+# default options. These options can be overridden by test specific
1414 # options, with the following exceptions:
1515 #
1616 #  LOG_FILE
....@@ -204,7 +204,7 @@
204204 #
205205 # This config file can also contain "config variables".
206206 # These are assigned with ":=" instead of the ktest option
207
-# assigment "=".
207
+# assignment "=".
208208 #
209209 # The difference between ktest options and config variables
210210 # is that config variables can be used multiple times,
....@@ -263,7 +263,7 @@
263263 #### Using options in other options ####
264264 #
265265 # Options that are defined in the config file may also be used
266
-# by other options. All options are evaulated at time of
266
+# by other options. All options are evaluated at time of
267267 # use (except that config variables are evaluated at config
268268 # processing time).
269269 #
....@@ -349,13 +349,13 @@
349349 # option to boot to with GRUB_REBOOT
350350 #GRUB_FILE = /boot/grub2/grub.cfg
351351 
352
-# The tool for REBOOT_TYPE = grub2 to set the next reboot kernel
352
+# The tool for REBOOT_TYPE = grub2 or grub2bls to set the next reboot kernel
353353 # to boot into (one shot mode).
354354 # (default grub2_reboot)
355355 #GRUB_REBOOT = grub2_reboot
356356 
357357 # The grub title name for the test kernel to boot
358
-# (Only mandatory if REBOOT_TYPE = grub or grub2)
358
+# (Only mandatory if REBOOT_TYPE = grub or grub2 or grub2bls)
359359 #
360360 # Note, ktest.pl will not update the grub menu.lst, you need to
361361 # manually add an option for the test. ktest.pl will search
....@@ -373,6 +373,10 @@
373373 # for: menuentry 'Test Kernel'
374374 # do a: GRUB_MENU = 'Test Kernel'
375375 # For customizing, add your entry in /etc/grub.d/40_custom.
376
+#
377
+# For grub2bls, a search of "title"s are done. The menu is found
378
+# by searching for the contents of GRUB_MENU in the line that starts
379
+# with "title".
376380 #
377381 #GRUB_MENU = Test Kernel
378382 
....@@ -438,6 +442,19 @@
438442 # Users can cancel the test by Ctrl^C
439443 # (default 0)
440444 #EMAIL_WHEN_CANCELED = 1
445
+#
446
+# If a test ends with an error and EMAIL_ON_ERROR is set as well
447
+# as a LOG_FILE is defined, then the log of the failing test will
448
+# be included in the email that is sent.
449
+# It is possible that the log may be very large, in which case,
450
+# only the last amount of the log should be sent. To limit how
451
+# much of the log is sent, set MAIL_MAX_SIZE. This will be the
452
+# size in bytes of the last portion of the log of the failed
453
+# test file. That is, if this is set to 100000, then only the
454
+# last 100 thousand bytes of the log file will be included in
455
+# the email.
456
+# (default undef)
457
+#MAIL_MAX_SIZE = 1000000
441458 
442459 # Start a test setup. If you leave this off, all options
443460 # will be default and the test will run once.
....@@ -479,6 +496,11 @@
479496 # default (undefined)
480497 #POST_KTEST = ${SSH} ~/dismantle_test
481498 
499
+# If you want to remove the kernel entry in Boot Loader Specification (BLS)
500
+# environment, use kernel-install command.
501
+# Here's the example:
502
+#POST_KTEST = ssh root@Test "/usr/bin/kernel-install remove $KERNEL_VERSION"
503
+
482504 # The default test type (default test)
483505 # The test types may be:
484506 #   build   - only build the kernel, do nothing else
....@@ -496,7 +518,7 @@
496518 #TEST = ssh user@machine /root/run_test
497519 
498520 # The build type is any make config type or special command
499
-#  (default randconfig)
521
+#  (default oldconfig)
500522 #   nobuild - skip the clean and build step
501523 #   useconfig:/path/to/config - use the given config and run
502524 #              oldconfig on it.
....@@ -530,6 +552,11 @@
530552 # or on some systems:
531553 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
532554 
555
+# If you want to add the kernel entry in Boot Loader Specification (BLS)
556
+# environment, use kernel-install command.
557
+# Here's the example:
558
+#POST_INSTALL = ssh root@Test "/usr/bin/kernel-install add $KERNEL_VERSION /boot/vmlinuz-$KERNEL_VERSION"
559
+
533560 # If for some reason you just want to boot the kernel and you do not
534561 # want the test to install anything new. For example, you may just want
535562 # to boot test the same kernel over and over and do not want to go through
....@@ -542,6 +569,11 @@
542569 #
543570 # default (undefined)
544571 #PRE_TEST = ${SSH} reboot_to_special_kernel
572
+
573
+# To kill the entire test if PRE_TEST is defined but fails set this
574
+# to 1.
575
+# (default 0)
576
+#PRE_TEST_DIE = 1
545577 
546578 # If there is a command you want to run after the individual test case
547579 # completes, then you can set this option.
....@@ -592,6 +624,8 @@
592624 #
593625 # For REBOOT_TYPE = grub2, you must define both GRUB_MENU and
594626 # GRUB_FILE.
627
+#
628
+# For REBOOT_TYPE = grub2bls, you must define GRUB_MENU.
595629 #
596630 # For REBOOT_TYPE = syslinux, you must define SYSLINUX_LABEL, and
597631 # perhaps modify SYSLINUX (default extlinux) and SYSLINUX_PATH
....@@ -691,7 +725,7 @@
691725 
692726 # Line to define a successful boot up in console output.
693727 # This is what the line contains, not the entire line. If you need
694
-# the entire line to match, then use regural expression syntax like:
728
+# the entire line to match, then use regular expression syntax like:
695729 #  (do not add any quotes around it)
696730 #
697731 #  SUCCESS_LINE = ^MyBox Login:$
....@@ -775,6 +809,11 @@
775809 # is issued instead of a reboot.
776810 # CONNECT_TIMEOUT = 25
777811 
812
+# The timeout in seconds for how long to wait for any running command
813
+# to timeout. If not defined, it will let it go indefinitely.
814
+# (default undefined)
815
+#RUN_TIMEOUT = 600
816
+
778817 # In between tests, a reboot of the box may occur, and this
779818 # is the time to wait for the console after it stops producing
780819 # output. Some machines may not produce a large lag on reboot
....@@ -823,7 +862,7 @@
823862 # (ignored if POWEROFF_ON_SUCCESS is set)
824863 #REBOOT_ON_SUCCESS = 1
825864 
826
-# In case there are isses with rebooting, you can specify this
865
+# In case there are issues with rebooting, you can specify this
827866 # to always powercycle after this amount of time after calling
828867 # reboot.
829868 # Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
....@@ -832,7 +871,7 @@
832871 # (default undefined)
833872 #POWERCYCLE_AFTER_REBOOT = 5
834873 
835
-# In case there's isses with halting, you can specify this
874
+# In case there's issues with halting, you can specify this
836875 # to always poweroff after this amount of time after calling
837876 # halt.
838877 # Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
....@@ -886,6 +925,10 @@
886925 # (default ssh $SSH_USER@$MACHINE reboot)
887926 # The variables SSH_USER and MACHINE are defined.
888927 #REBOOT = ssh $SSH_USER@$MACHINE reboot
928
+
929
+# The return code of REBOOT
930
+# (default 255)
931
+#REBOOT_RETURN_CODE = 255
889932 
890933 # The way triple faults are detected is by testing the kernel
891934 # banner. If the kernel banner for the kernel we are testing is
....@@ -952,7 +995,7 @@
952995 #
953996 #  PATCHCHECK_START is required and is the first patch to
954997 #   test (the SHA1 of the commit). You may also specify anything
955
-#   that git checkout allows (branch name, tage, HEAD~3).
998
+#   that git checkout allows (branch name, tag, HEAD~3).
956999 #
9571000 #  PATCHCHECK_END is the last patch to check (default HEAD)
9581001 #
....@@ -974,7 +1017,7 @@
9741017 #     IGNORE_WARNINGS is set for the given commit's sha1
9751018 #
9761019 #   IGNORE_WARNINGS can be used to disable the failure of patchcheck
977
-#     on a particuler commit (SHA1). You can add more than one commit
1020
+#     on a particular commit (SHA1). You can add more than one commit
9781021 #     by adding a list of SHA1s that are space delimited.
9791022 #
9801023 #   If BUILD_NOCLEAN is set, then make mrproper will not be run on
....@@ -1073,7 +1116,7 @@
10731116 #   whatever reason. (Can't reboot, want to inspect each iteration)
10741117 #   Doing a BISECT_MANUAL will have the test wait for you to
10751118 #   tell it if the test passed or failed after each iteration.
1076
-#   This is basicall the same as running git bisect yourself
1119
+#   This is basically the same as running git bisect yourself
10771120 #   but ktest will rebuild and install the kernel for you.
10781121 #
10791122 # BISECT_CHECK = 1 (optional, default 0)
....@@ -1219,7 +1262,7 @@
12191262 #
12201263 # CONFIG_BISECT_EXEC (optional)
12211264 #  The config bisect is a separate program that comes with ktest.pl.
1222
-#  By befault, it will look for:
1265
+#  By default, it will look for:
12231266 #    `pwd`/config-bisect.pl # the location ktest.pl was executed from.
12241267 #  If it does not find it there, it will look for:
12251268 #    `dirname <ktest.pl>`/config-bisect.pl # The directory that holds ktest.pl