diff --git a/tools/testing/ktest/sample.conf b/tools/testing/ktest/sample.conf index 9236fe977fa2..03d6e91245fe 100644 --- a/tools/testing/ktest/sample.conf +++ b/tools/testing/ktest/sample.conf @@ -150,6 +150,18 @@ #TEST_START ITERATE 5 #TEST_START SKIP +# Have the following options as default again. Used after tests +# have already been defined by TEST_START. Optionally, you can +# just define all default options before the first TEST_START +# and you do not need this option. +# +# This is a label and not really an option (it takes no value). +# You can append SKIP to this label and the options within this +# section will be ignored. +# +# DEFAULTS +# DEFAULTS SKIP + # The default test type (default test) # The test types may be: # build - only build the kernel, do nothing else @@ -177,6 +189,10 @@ # If you are building a 32bit x86 on a 64 bit host #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386 +# Any build options for the make of the kernel (not for other makes, like configs) +# (default "") +#BUILD_OPTIONS = -j20 + # If you need an initrd, you can add a script or code here to install # it. The environment variable KERNEL_VERSION will be set to the # kernel version that is used. Remember to add the initrd line @@ -201,130 +217,6 @@ # The test will not modify that file. #REBOOT_TYPE = grub -# Line to define a successful boot up in console output. -# This is what the line contains, not the entire line. If you need -# the entire line to match, then use regural expression syntax like: -# (do not add any quotes around it) -# -# SUCCESS_LINE = ^MyBox Login:$ -# -# (default "login:") -#SUCCESS_LINE = login: - -# As the test reads the console, after it hits the SUCCESS_LINE -# the time it waits for the monitor to settle down between reads -# can usually be lowered. -# (in seconds) (default 1) -#BOOTED_TIMEOUT = 1 - -# The timeout in seconds when we consider the box hung after -# the console stop producing output. Be sure to leave enough -# time here to get pass a reboot. Some machines may not produce -# any console output for a long time during a reboot. You do -# not want the test to fail just because the system was in -# the process of rebooting to the test kernel. -# (default 120) -#TIMEOUT = 120 - -# The location on the host where to write temp files -# (default /tmp/ktest) -#TMP_DIR = /tmp/ktest - -# In between tests, a reboot of the box may occur, and this -# is the time to wait for the console after it stops producing -# output. Some machines may not produce a large lag on reboot -# so this should accommodate it. -# The difference between this and TIMEOUT, is that TIMEOUT happens -# when rebooting to the test kernel. This sleep time happens -# after a test has completed and we are about to start running -# another test. If a reboot to the reliable kernel happens, -# we wait SLEEP_TIME for the console to stop producing output -# before starting the next test. -# (default 60) -#SLEEP_TIME = 60 - -# The time in between bisects to sleep (in seconds) -# (default 60) -#BISECT_SLEEP_TIME = 60 - -# Build without doing a make mrproper, or removing .config -# (default 0) -#BUILD_NOCLEAN = 0 - -# Reboot the target box on error (default 0) -#REBOOT_ON_ERROR = 0 - -# Power off the target on error (ignored if REBOOT_ON_ERROR is set) -# Note, this is a DEFAULT section only option. -# (default 0) -#POWEROFF_ON_ERROR = 0 - -# Power off the target after all tests have completed successfully -# Note, this is a DEFAULT section only option. -# (default 0) -#POWEROFF_ON_SUCCESS = 0 - -# Reboot the target after all test completed successfully (default 1) -# (ignored if POWEROFF_ON_SUCCESS is set) -#REBOOT_ON_SUCCESS = 1 - -# In case there are isses with rebooting, you can specify this -# to always powercycle after this amount of time after calling -# reboot. -# Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just -# makes it powercycle immediately after rebooting. Do not define -# it if you do not want it. -# (default undefined) -#POWERCYCLE_AFTER_REBOOT = 5 - -# In case there's isses with halting, you can specify this -# to always poweroff after this amount of time after calling -# halt. -# Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just -# makes it poweroff immediately after halting. Do not define -# it if you do not want it. -# (default undefined) -#POWEROFF_AFTER_HALT = 20 - -# Stop testing if a build fails. If set, the script will end if -# a failure is detected, otherwise it will save off the .config, -# dmesg and bootlog in a directory called -# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss -# if the STORE_FAILURES directory is set. -# (default 1) -# Note, even if this is set to zero, there are some errors that still -# stop the tests. -#DIE_ON_FAILURE = 1 - -# Directory to store failure directories on failure. If this is not -# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and -# bootlog. This option is ignored if DIE_ON_FAILURE is not set. -# (default undefined) -#STORE_FAILURES = /home/test/failures - -# A script or command to power off the box (default undefined) -# Needed for POWEROFF_ON_ERROR and SUCCESS -# -# Example for digital loggers power switch: -#POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF' -# -# Example for a virtual guest call "Guest". -#POWER_OFF = virsh destroy Guest - -# Any build options for the make of the kernel (not for other makes, like configs) -# (default "") -#BUILD_OPTIONS = -j20 - -# Optional log file to write the status (recommended) -# Note, this is a DEFAULT section only option. -# (default undefined) -#LOG_FILE = /home/test/logfiles/target.log - -# Remove old logfile if it exists before starting all tests. -# Note, this is a DEFAULT section only option. -# (default 0) -#CLEAR_LOG = 0 - # The min config that is needed to build for the machine # A nice way to create this is with the following: # @@ -378,6 +270,126 @@ # (default undefined) #ADD_CONFIG = /home/test/config-broken +# The location on the host where to write temp files +# (default /tmp/ktest) +#TMP_DIR = /tmp/ktest + +# Optional log file to write the status (recommended) +# Note, this is a DEFAULT section only option. +# (default undefined) +#LOG_FILE = /home/test/logfiles/target.log + +# Remove old logfile if it exists before starting all tests. +# Note, this is a DEFAULT section only option. +# (default 0) +#CLEAR_LOG = 0 + +# Line to define a successful boot up in console output. +# This is what the line contains, not the entire line. If you need +# the entire line to match, then use regural expression syntax like: +# (do not add any quotes around it) +# +# SUCCESS_LINE = ^MyBox Login:$ +# +# (default "login:") +#SUCCESS_LINE = login: + +# Stop testing if a build fails. If set, the script will end if +# a failure is detected, otherwise it will save off the .config, +# dmesg and bootlog in a directory called +# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss +# if the STORE_FAILURES directory is set. +# (default 1) +# Note, even if this is set to zero, there are some errors that still +# stop the tests. +#DIE_ON_FAILURE = 1 + +# Directory to store failure directories on failure. If this is not +# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and +# bootlog. This option is ignored if DIE_ON_FAILURE is not set. +# (default undefined) +#STORE_FAILURES = /home/test/failures + +# Build without doing a make mrproper, or removing .config +# (default 0) +#BUILD_NOCLEAN = 0 + +# As the test reads the console, after it hits the SUCCESS_LINE +# the time it waits for the monitor to settle down between reads +# can usually be lowered. +# (in seconds) (default 1) +#BOOTED_TIMEOUT = 1 + +# The timeout in seconds when we consider the box hung after +# the console stop producing output. Be sure to leave enough +# time here to get pass a reboot. Some machines may not produce +# any console output for a long time during a reboot. You do +# not want the test to fail just because the system was in +# the process of rebooting to the test kernel. +# (default 120) +#TIMEOUT = 120 + +# In between tests, a reboot of the box may occur, and this +# is the time to wait for the console after it stops producing +# output. Some machines may not produce a large lag on reboot +# so this should accommodate it. +# The difference between this and TIMEOUT, is that TIMEOUT happens +# when rebooting to the test kernel. This sleep time happens +# after a test has completed and we are about to start running +# another test. If a reboot to the reliable kernel happens, +# we wait SLEEP_TIME for the console to stop producing output +# before starting the next test. +# (default 60) +#SLEEP_TIME = 60 + +# The time in between bisects to sleep (in seconds) +# (default 60) +#BISECT_SLEEP_TIME = 60 + +# Reboot the target box on error (default 0) +#REBOOT_ON_ERROR = 0 + +# Power off the target on error (ignored if REBOOT_ON_ERROR is set) +# Note, this is a DEFAULT section only option. +# (default 0) +#POWEROFF_ON_ERROR = 0 + +# Power off the target after all tests have completed successfully +# Note, this is a DEFAULT section only option. +# (default 0) +#POWEROFF_ON_SUCCESS = 0 + +# Reboot the target after all test completed successfully (default 1) +# (ignored if POWEROFF_ON_SUCCESS is set) +#REBOOT_ON_SUCCESS = 1 + +# In case there are isses with rebooting, you can specify this +# to always powercycle after this amount of time after calling +# reboot. +# Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just +# makes it powercycle immediately after rebooting. Do not define +# it if you do not want it. +# (default undefined) +#POWERCYCLE_AFTER_REBOOT = 5 + +# In case there's isses with halting, you can specify this +# to always poweroff after this amount of time after calling +# halt. +# Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just +# makes it poweroff immediately after halting. Do not define +# it if you do not want it. +# (default undefined) +#POWEROFF_AFTER_HALT = 20 + +# A script or command to power off the box (default undefined) +# Needed for POWEROFF_ON_ERROR and SUCCESS +# +# Example for digital loggers power switch: +#POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF' +# +# Example for a virtual guest call "Guest". +#POWER_OFF = virsh destroy Guest + #### Per test run options #### # The following options are only allowed in TEST_START sections. # They are ignored in the DEFAULTS sections.