Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1fbd7e6 authored by Steven Rostedt's avatar Steven Rostedt Committed by Steven Rostedt
Browse files

ktest: Updated the sample.conf for the latest options 



Added documentation for SSH_EXEC, SCP_TO_TARGET, REBOOT,
and CONFIG_BISECT and friends.

Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent dbc6d0aa

tools/testing/ktest/sample.conf

+89 −1
Original line number Original line Diff line number Diff line
@@ -390,6 +390,21 @@ 
# Example for a virtual guest call "Guest".

# Example for a virtual guest call "Guest".

#POWER_OFF = virsh destroy Guest

#POWER_OFF = virsh destroy Guest





# The way to execute a command on the target

# (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)

# The variables SSH_USER, MACHINE and SSH_COMMAND are defined

#SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";



# The way to copy a file to the target

# (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)

# The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.

#SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE



# The nice way to reboot the target

# (default ssh $SSH_USER@$MACHINE reboot)

# The variables SSH_USER and MACHINE are defined.

#REBOOT = ssh $SSH_USER@$MACHINE reboot



#### Per test run options ####

#### Per test run options ####

# The following options are only allowed in TEST_START sections.

# The following options are only allowed in TEST_START sections.

# They are ignored in the DEFAULTS sections.

# They are ignored in the DEFAULTS sections.
@@ -442,7 +457,7 @@ 
#   CHECKOUT = mybranch

#   CHECKOUT = mybranch

#   PATCHCHECK_TYPE = boot

#   PATCHCHECK_TYPE = boot

#   PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7

#   PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7

#   PATCHCHEKC_END = HEAD~2

#   PATCHCHECK_END = HEAD~2

#

#

#

#

#

#
@@ -520,3 +535,76 @@ 
#   BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e

#   BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e

#   BISECT_TYPE = build

#   BISECT_TYPE = build

#   MIN_CONFIG = /home/test/config-bisect

#   MIN_CONFIG = /home/test/config-bisect

#

#

#

# For TEST_TYPE = config_bisect

#

#  In those cases that you have two different configs. One of them

#  work, the other does not, and you do not know what config causes

#  the problem.

#  The TEST_TYPE config_bisect will bisect the bad config looking for

#  what config causes the failure.

#

#  The way it works is this:

#

#   First it finds a config to work with. Since a different version, or

#   MIN_CONFIG may cause different dependecies, it must run through this

#   preparation.

#

#   Overwrites any config set in the bad config with a config set in

#   either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs

#   are minimal and do not disable configs you want to test:

#   (ie.  # CONFIG_FOO is not set).

#

#   An oldconfig is run on the bad config and any new config that

#   appears will be added to the configs to test.

#

#   Finally, it generates a config with the above result and runs it

#   again through make oldconfig to produce a config that should be

#   satisfied by kconfig.

#

#   Then it starts the bisect.

#

#   The configs to test are cut in half. If all the configs in this

#   half depend on a config in the other half, then the other half

#   is tested instead. If no configs are enabled by either half, then

#   this means a circular dependency exists and the test fails.

#

#   A config is created with the test half, and the bisect test is run.

#

#   If the bisect succeeds, then all configs in the generated config

#   are removed from the configs to test and added to the configs that

#   will be enabled for all builds (they will be enabled, but not be part

#   of the configs to examine).

#

#   If the bisect fails, then all test configs that were not enabled by

#   the config file are removed from the test. These configs will not

#   be enabled in future tests. Since current config failed, we consider

#   this to be a subset of the config that we started with.

#

#   When we are down to one config, it is considered the bad config.

#

#   Note, the config chosen may not be the true bad config. Due to

#   dependencies and selections of the kbuild system, mulitple

#   configs may be needed to cause a failure. If you disable the

#   config that was found and restart the test, if the test fails

#   again, it is recommended to rerun the config_bisect with a new

#   bad config without the found config enabled.

#

#  The option BUILD_TYPE will be ignored.

#

#  CONFIG_BISECT_TYPE is the type of test to perform:

#	build	- bad fails to build

#	boot	- bad builds but fails to boot

#	test	- bad boots but fails a test

#

#   CONFIG_BISECT is the config that failed to boot

#

# Example:

#   TEST_START

#   TEST_TYPE = config_bisect

#   CONFIG_BISECT_TYPE = build

#   CONFIG_BISECT = /home/test/¢onfig-bad

#   MIN_CONFIG = /home/test/config-min

#