[3/3] KVM test: Points user to online documentation

Commit Message

Lucas Meneghel Rodrigues Sept. 10, 2009, 2:47 p.m. UTC

* Renamed BEFORE_YOU_START to README, and point
   to the online documentation in there (it's
   pointless to duplicate procedures).
 * The control file docstring points to the
   top level KVM testing documentation.
 * The kvm class docstring points to the getting
   started guide.

Signed-off-by: Lucas Meneghel Rodrigues <[e-mail]>
---
 client/tests/kvm/BEFORE_YOU_START |   19 -------------------
 client/tests/kvm/README           |    3 +++
 client/tests/kvm/control          |    2 ++
 client/tests/kvm/kvm.py           |    3 +++
 4 files changed, 8 insertions(+), 19 deletions(-)
 delete mode 100644 client/tests/kvm/BEFORE_YOU_START
 create mode 100644 client/tests/kvm/README

Patch

diff --git a/client/tests/kvm/BEFORE_YOU_START b/client/tests/kvm/BEFORE_YOU_START
deleted file mode 100644
index 7478d9d..0000000
--- a/client/tests/kvm/BEFORE_YOU_START
+++ /dev/null
@@ -1,19 +0,0 @@ 
-Install kvm and load modules.
-Remove 'env' file if exists.
-Remove control.state file if exists.
-
-Copy kvm_tests.cfg.sample into kvm_tests.cfg
-Modify kvm_tests.cfg to your liking.
-Modify control if you prefer to "use your own kvm" (comment out kvm_install).
-
-Create those symbolic links under kvm or under <rootdir>
-qemu                   -> qemu-kvm binary (unless using kvm_install)
-qemu-img               -> qemu-img binary (unless using kvm_install)
-isos/                  -> isos (mount or symlink)
-images/                -> images (mount or symlink)
-autotest/              -> ../../ (an autotest client directroy)
-steps_data/            -> steps_data dir (when available)
-
-Please make sure qemu points to an "installed" kvm-qemu executable, and
-not one just compiled in the source directory. An installed executable "knows"
-where to find its associated data-dir (e.g. for bios).
diff --git a/client/tests/kvm/README b/client/tests/kvm/README
new file mode 100644
index 0000000..88d2c15
--- /dev/null
+++ b/client/tests/kvm/README
@@ -0,0 +1,3 @@ 
+In order to get started, please refer to the online documentation:
+
+http://www.linux-kvm.org/page/KVM-Autotest/Client_Install
diff --git a/client/tests/kvm/control b/client/tests/kvm/control
index 2ad8d81..f8390d6 100644
--- a/client/tests/kvm/control
+++ b/client/tests/kvm/control
@@ -16,6 +16,8 @@  DOC = """
 Executes the KVM test framework on a given host. This module is separated in
 minor functions, that execute different tests for doing Quality Assurance on
 KVM (both kernelspace and userspace) code.
+
+For online docs, please refer to http://www.linux-kvm.org/page/KVM-Autotest
 """
 
 
diff --git a/client/tests/kvm/kvm.py b/client/tests/kvm/kvm.py
index 4930e80..8e66fc0 100644
--- a/client/tests/kvm/kvm.py
+++ b/client/tests/kvm/kvm.py
@@ -38,6 +38,9 @@  class kvm(test.test):
     @author: David Huff ([e-mail])
     @author: Alexey Eromenko ([e-mail])
     @author: Mike Burns ([e-mail])
+
+    @see: http://www.linux-kvm.org/page/KVM-Autotest/Client_Install
+            (Online doc - Getting started with KVM testing)
     """
     version = 1
     def initialize(self):