From patchwork Wed Jan 11 16:28:38 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 90936 Delivered-To: patch@linaro.org Received: by 10.140.20.99 with SMTP id 90csp1203728qgi; Wed, 11 Jan 2017 08:29:38 -0800 (PST) X-Received: by 10.84.232.10 with SMTP id h10mr14523883plk.121.1484152178766; Wed, 11 Jan 2017 08:29:38 -0800 (PST) Return-Path: Received: from bombadil.infradead.org (bombadil.infradead.org. [2001:1868:205::9]) by mx.google.com with ESMTPS id f3si6238770pga.210.2017.01.11.08.29.38 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 11 Jan 2017 08:29:38 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-arm-kernel-bounces+patch=linaro.org@lists.infradead.org designates 2001:1868:205::9 as permitted sender) client-ip=2001:1868:205::9; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org; spf=pass (google.com: best guess record for domain of linux-arm-kernel-bounces+patch=linaro.org@lists.infradead.org designates 2001:1868:205::9 as permitted sender) smtp.mailfrom=linux-arm-kernel-bounces+patch=linaro.org@lists.infradead.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.87 #1 (Red Hat Linux)) id 1cRLmL-0000ux-8O; Wed, 11 Jan 2017 16:29:37 +0000 Received: from mail-wj0-x235.google.com ([2a00:1450:400c:c01::235]) by bombadil.infradead.org with esmtps (Exim 4.87 #1 (Red Hat Linux)) id 1cRLly-0008UJ-2B for linux-arm-kernel@lists.infradead.org; Wed, 11 Jan 2017 16:29:16 +0000 Received: by mail-wj0-x235.google.com with SMTP id tn15so106672849wjb.1 for ; Wed, 11 Jan 2017 08:28:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=8nq7LuDJOrYTvoKrrRPUQmQnJhTwE0u5bJ8YPBpvKLU=; b=bROkshTeLZCTtwJVlGoB2fNltotK0ef4pPXdb5MhLSunv3K18/w19aug3Pghl4ibvM Gwvemi6OPHFp3qcHwtZaXEQ9I+3YAaklnpiVNVTqP/2wsQSo+j+4rkOTAFsMdP2ngpMO oht6z557piHnTzsyhCRfpiHTTbuUFNYLnoIA4= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=8nq7LuDJOrYTvoKrrRPUQmQnJhTwE0u5bJ8YPBpvKLU=; b=bc6bRmWc2ROeBmzVZ8zS9JElF2g/6CfMSTVQOi1VfIRk6lGatkuGMnCKN/We0yGMur Xee8oYLgYhSZd/neE/bSgcZhoaxpD5iljPlLWrHr7fOy+YQsJV7f1Hwc6Mr2+UzH0hIP NGSpY/orduH/GWJ/qqmomQl49TGF3+OJN5OJj5O0VcRv9BlIOJbjg8hXR2zOYsXN7whi bRr+YG6+F6xoXcEIJFinIrQBEx/JKqyUbaZ296JG0FfLcAJ+rClFAsaPcit3adSTwuZd E91fd/tjsISjguKgwwPJuPzMNcU730b64BQlLbXd8d0MAAAMaVshRy/ZdVAGAMY7FL9Z fatw== X-Gm-Message-State: AIkVDXJmlpZAwXSIsCR7org1Nj7+Sm2GXg2/7qkpJPKJ1TkYYEprcPX07ujn4XUEk60MhMN+ X-Received: by 10.195.11.41 with SMTP id ef9mr5815432wjd.89.1484152132074; Wed, 11 Jan 2017 08:28:52 -0800 (PST) Received: from zen.linaro.local ([81.128.185.34]) by smtp.gmail.com with ESMTPSA id k7sm9299317wjz.33.2017.01.11.08.28.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 11 Jan 2017 08:28:50 -0800 (PST) Received: from zen.linaroharston (localhost [127.0.0.1]) by zen.linaro.local (Postfix) with ESMTP id C71F63E06B6; Wed, 11 Jan 2017 16:28:48 +0000 (GMT) From: =?UTF-8?q?Alex=20Benn=C3=A9e?= To: drjones@redhat.com, pbonzini@redhat.com Subject: [kvm-unit-tests PATCH 3/6] docs: move README to README.md and symlink Date: Wed, 11 Jan 2017 16:28:38 +0000 Message-Id: <20170111162841.15569-4-alex.bennee@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170111162841.15569-1-alex.bennee@linaro.org> References: <20170111162841.15569-1-alex.bennee@linaro.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20170111_082914_281058_184F66B0 X-CRM114-Status: GOOD ( 15.09 ) X-Spam-Score: -2.0 (--) X-Spam-Report: SpamAssassin version 3.4.1 on bombadil.infradead.org summary: Content analysis details: (-2.0 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [2a00:1450:400c:c01:0:0:0:235 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kvm@vger.kernel.org, marc.zyngier@arm.com, linux-arm-kernel@lists.infradead.org, =?UTF-8?q?Alex=20Benn=C3=A9e?= , kvmarm@lists.cs.columbia.edu, christoffer.dall@linaro.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patch=linaro.org@lists.infradead.org This allows a slightly nicer formatting of the text when displayed on some repository hosts. We keep a symlink from README for the old-school purists. Signed-off-by: Alex Bennée --- README | 69 +---------------------------------------------------- README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 68 deletions(-) mode change 100644 => 120000 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index f8f196d..0000000 --- a/README +++ /dev/null @@ -1,68 +0,0 @@ -Welcome to kvm-unit-tests - -See http://www.linux-kvm.org/page/KVM-unit-tests for a high-level -description of this project, as well as running tests and adding -tests HOWTOs. - -This directory contains sources for a kvm test suite. - -To create the test images do - ./configure - make -in this directory. Test images are created in .//*.flat - -Then use the runner script to detect the correct invocation and -invoke the test, e.g. - ./x86-run ./x86/msr.flat -or - ./run_tests.sh -to run them all. - -To select a specific qemu binary, specify the QEMU= -environment variable, e.g. - QEMU=/tmp/qemu/x86_64-softmmu/qemu-system-x86_64 ./x86-run ./x86/msr.flat - -To create and use standalone tests do - ./configure - make standalone - (send tests/some-test somewhere) - (go to somewhere) - ./some-test - -'make install' will install all tests in PREFIX/share/kvm-unit-tests/tests, -each as a standalone test. - -Directory structure: -.: configure script, top-level Makefile, and run_tests.sh -./scripts: helper scripts for building and running tests -./lib: general architecture neutral services for the tests -./lib/: architecture dependent services for the tests -./: the sources of the tests and the created objects/images - -See /README for architecture specific documentation. - -CONTRIBUTING: -============= - -Style ------ - -Currently there is a mix of indentation styles so any changes to -existing files should be consistent with the existing style. For new -files: - - - C: please use standard linux-with-tabs - - Shell: use TABs for indentation - -Patches -------- - -Patches are welcome at the KVM mailing list . - -Please prefix messages with: [kvm-unit-tests PATCH] - -You can add the following to .git/config to do this automatically for you: - -[format] - subjectprefix = kvm-unit-tests PATCH - diff --git a/README b/README new file mode 120000 index 0000000..42061c0 --- /dev/null +++ b/README @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..5027b62 --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# Welcome to kvm-unit-tests + +See http://www.linux-kvm.org/page/KVM-unit-tests for a high-level +description of this project, as well as running tests and adding +tests HOWTOs. + +# Building the tests + +This directory contains sources for a kvm test suite. + +To create the test images do: + + ./configure + make + +in this directory. Test images are created in .//*.flat + +## Standalone tests + +The tests can be built as standalone +To create and use standalone tests do: + + ./configure + make standalone + (send tests/some-test somewhere) + (go to somewhere) + ./some-test + +'make install' will install all tests in PREFIX/share/kvm-unit-tests/tests, +each as a standalone test. + + +# Running the tests + +Then use the runner script to detect the correct invocation and +invoke the test: + + ./x86-run ./x86/msr.flat +or: + + ./run_tests.sh + +to run them all. + +To select a specific qemu binary, specify the QEMU= +environment variable: + + QEMU=/tmp/qemu/x86_64-softmmu/qemu-system-x86_64 ./x86-run ./x86/msr.flat + +# Contributing + +## Directory structure + + .: configure script, top-level Makefile, and run_tests.sh + ./scripts: helper scripts for building and running tests + ./lib: general architecture neutral services for the tests + ./lib/: architecture dependent services for the tests + ./: the sources of the tests and the created objects/images + +See /README for architecture specific documentation. + +## Style + +Currently there is a mix of indentation styles so any changes to +existing files should be consistent with the existing style. For new +files: + + - C: please use standard linux-with-tabs + - Shell: use TABs for indentation + +## Patches + +Patches are welcome at the KVM mailing list . + +Please prefix messages with: [kvm-unit-tests PATCH] + +You can add the following to .git/config to do this automatically for you: + + [format] + subjectprefix = kvm-unit-tests PATCH +