ktest: Update the sample config file with more documentation

Signed-off-by: Steven Rostedt <rostedt@goodmis.org>

1 files changed, 103 insertions, 91 deletions

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,6 +217,73 @@
 # The test will not modify that file.
 #REBOOT_TYPE = grub
 
+# The min config that is needed to build for the machine
+# A nice way to create this is with the following:
+#
+#   $ ssh target
+#   $ lsmod > mymods
+#   $ scp mymods host:/tmp
+#   $ exit
+#   $ cd linux.git
+#   $ rm .config
+#   $ make LSMOD=mymods localyesconfig
+#   $ grep '^CONFIG' .config > /home/test/config-min
+#
+# If you want even less configs:
+#
+#   log in directly to target (do not ssh)
+#
+#   $ su
+#   # lsmod | cut -d' ' -f1 | xargs rmmod
+#
+#   repeat the above several times
+#
+#   # lsmod > mymods
+#   # reboot
+#
+# May need to reboot to get your network back to copy the mymods
+# to the host, and then remove the previous .config and run the
+# localyesconfig again. The CONFIG_MIN generated like this will
+# not guarantee network activity to the box so the TEST_TYPE of
+# test may fail.
+#
+# You might also want to set:
+#   CONFIG_CMDLINE="<your options here>"
+#  randconfig may set the above and override your real command
+#  line options.
+# (default undefined)
+#MIN_CONFIG = /home/test/config-min
+
+# Sometimes there's options that just break the boot and
+# you do not care about. Here are a few:
+#   # CONFIG_STAGING is not set
+#  Staging drivers are horrible, and can break the build.
+#   # CONFIG_SCSI_DEBUG is not set
+#  SCSI_DEBUG may change your root partition
+#   # CONFIG_KGDB_SERIAL_CONSOLE is not set
+#  KGDB may cause oops waiting for a connection that's not there.
+# This option points to the file containing config options that will be prepended
+# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
+#
+# Note, config options in MIN_CONFIG will override these options.
+#
+# (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:
@@ -211,6 +294,26 @@
 # (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.
@@ -226,10 +329,6 @@
 # (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
@@ -247,10 +346,6 @@
 # (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
 
@@ -286,22 +381,6 @@
 # (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
 #
@@ -311,73 +390,6 @@
 # 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:
-#
-#   $ ssh target
-#   $ lsmod > mymods
-#   $ scp mymods host:/tmp
-#   $ exit
-#   $ cd linux.git
-#   $ rm .config
-#   $ make LSMOD=mymods localyesconfig
-#   $ grep '^CONFIG' .config > /home/test/config-min
-#
-# If you want even less configs:
-#
-#   log in directly to target (do not ssh)
-#
-#   $ su
-#   # lsmod | cut -d' ' -f1 | xargs rmmod
-#
-#   repeat the above several times
-#
-#   # lsmod > mymods
-#   # reboot
-#
-# May need to reboot to get your network back to copy the mymods
-# to the host, and then remove the previous .config and run the
-# localyesconfig again. The CONFIG_MIN generated like this will
-# not guarantee network activity to the box so the TEST_TYPE of
-# test may fail.
-#
-# You might also want to set:
-#   CONFIG_CMDLINE="<your options here>"
-#  randconfig may set the above and override your real command
-#  line options.
-# (default undefined)
-#MIN_CONFIG = /home/test/config-min
-
-# Sometimes there's options that just break the boot and
-# you do not care about. Here are a few:
-#   # CONFIG_STAGING is not set
-#  Staging drivers are horrible, and can break the build.
-#   # CONFIG_SCSI_DEBUG is not set
-#  SCSI_DEBUG may change your root partition
-#   # CONFIG_KGDB_SERIAL_CONSOLE is not set
-#  KGDB may cause oops waiting for a connection that's not there.
-# This option points to the file containing config options that will be prepended
-# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
-#
-# Note, config options in MIN_CONFIG will override these options.
-#
-# (default undefined)
-#ADD_CONFIG = /home/test/config-broken
-
 #### Per test run options ####
 # The following options are only allowed in TEST_START sections.
 # They are ignored in the DEFAULTS sections.