aboutsummaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorSteven Rostedt <srostedt@redhat.com>2010-11-02 15:22:53 -0400
committerSteven Rostedt <rostedt@goodmis.org>2010-11-18 11:23:09 -0500
commitdc89568884ae1b8b96ca6fffe83b404ae472750e (patch)
tree74fbb08d0924a922a9f1e1ec91501a522ade5471 /tools
parenta57419b366a20009c9363c3cdad2449dc2fa8b9c (diff)
ktest: Update the sample config file with more documentation
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Diffstat (limited to 'tools')
-rw-r--r--tools/testing/ktest/sample.conf194
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 @@
150#TEST_START ITERATE 5 150#TEST_START ITERATE 5
151#TEST_START SKIP 151#TEST_START SKIP
152 152
153# Have the following options as default again. Used after tests
154# have already been defined by TEST_START. Optionally, you can
155# just define all default options before the first TEST_START
156# and you do not need this option.
157#
158# This is a label and not really an option (it takes no value).
159# You can append SKIP to this label and the options within this
160# section will be ignored.
161#
162# DEFAULTS
163# DEFAULTS SKIP
164
153# The default test type (default test) 165# The default test type (default test)
154# The test types may be: 166# The test types may be:
155# build - only build the kernel, do nothing else 167# build - only build the kernel, do nothing else
@@ -177,6 +189,10 @@
177# If you are building a 32bit x86 on a 64 bit host 189# If you are building a 32bit x86 on a 64 bit host
178#MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386 190#MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
179 191
192# Any build options for the make of the kernel (not for other makes, like configs)
193# (default "")
194#BUILD_OPTIONS = -j20
195
180# If you need an initrd, you can add a script or code here to install 196# If you need an initrd, you can add a script or code here to install
181# it. The environment variable KERNEL_VERSION will be set to the 197# it. The environment variable KERNEL_VERSION will be set to the
182# kernel version that is used. Remember to add the initrd line 198# kernel version that is used. Remember to add the initrd line
@@ -201,6 +217,73 @@
201# The test will not modify that file. 217# The test will not modify that file.
202#REBOOT_TYPE = grub 218#REBOOT_TYPE = grub
203 219
220# The min config that is needed to build for the machine
221# A nice way to create this is with the following:
222#
223# $ ssh target
224# $ lsmod > mymods
225# $ scp mymods host:/tmp
226# $ exit
227# $ cd linux.git
228# $ rm .config
229# $ make LSMOD=mymods localyesconfig
230# $ grep '^CONFIG' .config > /home/test/config-min
231#
232# If you want even less configs:
233#
234# log in directly to target (do not ssh)
235#
236# $ su
237# # lsmod | cut -d' ' -f1 | xargs rmmod
238#
239# repeat the above several times
240#
241# # lsmod > mymods
242# # reboot
243#
244# May need to reboot to get your network back to copy the mymods
245# to the host, and then remove the previous .config and run the
246# localyesconfig again. The CONFIG_MIN generated like this will
247# not guarantee network activity to the box so the TEST_TYPE of
248# test may fail.
249#
250# You might also want to set:
251# CONFIG_CMDLINE="<your options here>"
252# randconfig may set the above and override your real command
253# line options.
254# (default undefined)
255#MIN_CONFIG = /home/test/config-min
256
257# Sometimes there's options that just break the boot and
258# you do not care about. Here are a few:
259# # CONFIG_STAGING is not set
260# Staging drivers are horrible, and can break the build.
261# # CONFIG_SCSI_DEBUG is not set
262# SCSI_DEBUG may change your root partition
263# # CONFIG_KGDB_SERIAL_CONSOLE is not set
264# KGDB may cause oops waiting for a connection that's not there.
265# This option points to the file containing config options that will be prepended
266# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
267#
268# Note, config options in MIN_CONFIG will override these options.
269#
270# (default undefined)
271#ADD_CONFIG = /home/test/config-broken
272
273# The location on the host where to write temp files
274# (default /tmp/ktest)
275#TMP_DIR = /tmp/ktest
276
277# Optional log file to write the status (recommended)
278# Note, this is a DEFAULT section only option.
279# (default undefined)
280#LOG_FILE = /home/test/logfiles/target.log
281
282# Remove old logfile if it exists before starting all tests.
283# Note, this is a DEFAULT section only option.
284# (default 0)
285#CLEAR_LOG = 0
286
204# Line to define a successful boot up in console output. 287# Line to define a successful boot up in console output.
205# This is what the line contains, not the entire line. If you need 288# This is what the line contains, not the entire line. If you need
206# the entire line to match, then use regural expression syntax like: 289# the entire line to match, then use regural expression syntax like:
@@ -211,6 +294,26 @@
211# (default "login:") 294# (default "login:")
212#SUCCESS_LINE = login: 295#SUCCESS_LINE = login:
213 296
297# Stop testing if a build fails. If set, the script will end if
298# a failure is detected, otherwise it will save off the .config,
299# dmesg and bootlog in a directory called
300# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
301# if the STORE_FAILURES directory is set.
302# (default 1)
303# Note, even if this is set to zero, there are some errors that still
304# stop the tests.
305#DIE_ON_FAILURE = 1
306
307# Directory to store failure directories on failure. If this is not
308# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
309# bootlog. This option is ignored if DIE_ON_FAILURE is not set.
310# (default undefined)
311#STORE_FAILURES = /home/test/failures
312
313# Build without doing a make mrproper, or removing .config
314# (default 0)
315#BUILD_NOCLEAN = 0
316
214# As the test reads the console, after it hits the SUCCESS_LINE 317# As the test reads the console, after it hits the SUCCESS_LINE
215# the time it waits for the monitor to settle down between reads 318# the time it waits for the monitor to settle down between reads
216# can usually be lowered. 319# can usually be lowered.
@@ -226,10 +329,6 @@
226# (default 120) 329# (default 120)
227#TIMEOUT = 120 330#TIMEOUT = 120
228 331
229# The location on the host where to write temp files
230# (default /tmp/ktest)
231#TMP_DIR = /tmp/ktest
232
233# In between tests, a reboot of the box may occur, and this 332# In between tests, a reboot of the box may occur, and this
234# is the time to wait for the console after it stops producing 333# is the time to wait for the console after it stops producing
235# output. Some machines may not produce a large lag on reboot 334# output. Some machines may not produce a large lag on reboot
@@ -247,10 +346,6 @@
247# (default 60) 346# (default 60)
248#BISECT_SLEEP_TIME = 60 347#BISECT_SLEEP_TIME = 60
249 348
250# Build without doing a make mrproper, or removing .config
251# (default 0)
252#BUILD_NOCLEAN = 0
253
254# Reboot the target box on error (default 0) 349# Reboot the target box on error (default 0)
255#REBOOT_ON_ERROR = 0 350#REBOOT_ON_ERROR = 0
256 351
@@ -286,22 +381,6 @@
286# (default undefined) 381# (default undefined)
287#POWEROFF_AFTER_HALT = 20 382#POWEROFF_AFTER_HALT = 20
288 383
289# Stop testing if a build fails. If set, the script will end if
290# a failure is detected, otherwise it will save off the .config,
291# dmesg and bootlog in a directory called
292# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
293# if the STORE_FAILURES directory is set.
294# (default 1)
295# Note, even if this is set to zero, there are some errors that still
296# stop the tests.
297#DIE_ON_FAILURE = 1
298
299# Directory to store failure directories on failure. If this is not
300# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
301# bootlog. This option is ignored if DIE_ON_FAILURE is not set.
302# (default undefined)
303#STORE_FAILURES = /home/test/failures
304
305# A script or command to power off the box (default undefined) 384# A script or command to power off the box (default undefined)
306# Needed for POWEROFF_ON_ERROR and SUCCESS 385# Needed for POWEROFF_ON_ERROR and SUCCESS
307# 386#
@@ -311,73 +390,6 @@
311# Example for a virtual guest call "Guest". 390# Example for a virtual guest call "Guest".
312#POWER_OFF = virsh destroy Guest 391#POWER_OFF = virsh destroy Guest
313 392
314# Any build options for the make of the kernel (not for other makes, like configs)
315# (default "")
316#BUILD_OPTIONS = -j20
317
318# Optional log file to write the status (recommended)
319# Note, this is a DEFAULT section only option.
320# (default undefined)
321#LOG_FILE = /home/test/logfiles/target.log
322
323# Remove old logfile if it exists before starting all tests.
324# Note, this is a DEFAULT section only option.
325# (default 0)
326#CLEAR_LOG = 0
327
328# The min config that is needed to build for the machine
329# A nice way to create this is with the following:
330#
331# $ ssh target
332# $ lsmod > mymods
333# $ scp mymods host:/tmp
334# $ exit
335# $ cd linux.git
336# $ rm .config
337# $ make LSMOD=mymods localyesconfig
338# $ grep '^CONFIG' .config > /home/test/config-min
339#
340# If you want even less configs:
341#
342# log in directly to target (do not ssh)
343#
344# $ su
345# # lsmod | cut -d' ' -f1 | xargs rmmod
346#
347# repeat the above several times
348#
349# # lsmod > mymods
350# # reboot
351#
352# May need to reboot to get your network back to copy the mymods
353# to the host, and then remove the previous .config and run the
354# localyesconfig again. The CONFIG_MIN generated like this will
355# not guarantee network activity to the box so the TEST_TYPE of
356# test may fail.
357#
358# You might also want to set:
359# CONFIG_CMDLINE="<your options here>"
360# randconfig may set the above and override your real command
361# line options.
362# (default undefined)
363#MIN_CONFIG = /home/test/config-min
364
365# Sometimes there's options that just break the boot and
366# you do not care about. Here are a few:
367# # CONFIG_STAGING is not set
368# Staging drivers are horrible, and can break the build.
369# # CONFIG_SCSI_DEBUG is not set
370# SCSI_DEBUG may change your root partition
371# # CONFIG_KGDB_SERIAL_CONSOLE is not set
372# KGDB may cause oops waiting for a connection that's not there.
373# This option points to the file containing config options that will be prepended
374# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
375#
376# Note, config options in MIN_CONFIG will override these options.
377#
378# (default undefined)
379#ADD_CONFIG = /home/test/config-broken
380
381#### Per test run options #### 393#### Per test run options ####
382# The following options are only allowed in TEST_START sections. 394# The following options are only allowed in TEST_START sections.
383# They are ignored in the DEFAULTS sections. 395# They are ignored in the DEFAULTS sections.