From patchwork Thu Sep 10 14:47:04 2009 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lucas Meneghel Rodrigues X-Patchwork-Id: 46616 Received: from vger.kernel.org (vger.kernel.org [209.132.176.167]) by demeter.kernel.org (8.14.2/8.14.2) with ESMTP id n8AElLTH029624 for ; Thu, 10 Sep 2009 14:47:21 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751283AbZIJOrN (ORCPT ); Thu, 10 Sep 2009 10:47:13 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1751258AbZIJOrM (ORCPT ); Thu, 10 Sep 2009 10:47:12 -0400 Received: from mx1.redhat.com ([209.132.183.28]:1027 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751165AbZIJOrK (ORCPT ); Thu, 10 Sep 2009 10:47:10 -0400 Received: from int-mx02.intmail.prod.int.phx2.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id n8AElC6R013434; Thu, 10 Sep 2009 10:47:13 -0400 Received: from localhost.localdomain (vpn-10-65.bos.redhat.com [10.16.10.65]) by int-mx02.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id n8AEl6Ro013010; Thu, 10 Sep 2009 10:47:11 -0400 From: Lucas Meneghel Rodrigues To: autotest@test.kernel.org Cc: kvm@vger.kernel.org, Lucas Meneghel Rodrigues Subject: [PATCH 3/3] KVM test: Points user to online documentation Date: Thu, 10 Sep 2009 11:47:04 -0300 Message-Id: <1252594024-5836-3-git-send-email-lmr@redhat.com> In-Reply-To: <1252594024-5836-2-git-send-email-lmr@redhat.com> References: <1252594024-5836-1-git-send-email-lmr@redhat.com> <1252594024-5836-2-git-send-email-lmr@redhat.com> X-Scanned-By: MIMEDefang 2.67 on 10.5.11.12 Sender: kvm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org * 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 --- 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 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 -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 (dhuff@redhat.com) @author: Alexey Eromenko (aeromenk@redhat.com) @author: Mike Burns (mburns@redhat.com) + + @see: http://www.linux-kvm.org/page/KVM-Autotest/Client_Install + (Online doc - Getting started with KVM testing) """ version = 1 def initialize(self):