ktest: Clarify config file usage

Simply telling a new user to edit "the config file" without giving any
hints on where that file should go, what it should be named, or where
a template can be found, is not particularly helpful.

Link: http://lkml.kernel.org/r/20170717001630.10518-1-swood@redhat.com
Signed-off-by: Scott Wood <swood@redhat.com>
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>

diff --git a/tools/testing/ktest/ktest.pl b/tools/testing/ktest/ktest.pl
index a959b6f79ce50f0335e0902ae77330546b65401a..c85a9f9342f492e6dbe1ce9568752eee9646a025 100755 (executable)
--- a/tools/testing/ktest/ktest.pl
+++ b/tools/testing/ktest/ktest.pl
@@ -1143,7 +1143,8 @@ sub __read_config {
 sub get_test_case {
        print "What test case would you like to run?\n";
        print " (build, install or boot)\n";
-       print " Other tests are available but require editing the config file\n";
+       print " Other tests are available but require editing ktest.conf\n";
+       print " (see tools/testing/ktest/sample.conf)\n";
        my $ans = <STDIN>;
        chomp $ans;
        $default{"TEST_TYPE"} = $ans;

diff --git a/tools/testing/ktest/sample.conf b/tools/testing/ktest/sample.conf
index 8df62c837dd1e45b5e667745c0cd9d3007fea175..e628e7c8d875c1fc654b550229ec0e1ba0752a30 100644 (file)
--- a/tools/testing/ktest/sample.conf
+++ b/tools/testing/ktest/sample.conf
@@ -1,6 +1,9 @@
 #
 # Config file for ktest.pl
 #
+# Place your customized version of this, named ktest.conf, in the
+# working directory that ktest.pl is run from.
+#
 # Note, all paths must be absolute
 #