From mboxrd@z Thu Jan  1 00:00:00 1970
From: Andrew Jones <drjones@redhat.com>
Subject: Re: [PATCH 3/9] clean root dir of all x86-ness
Date: Thu, 17 Oct 2013 11:35:09 +0200
Message-ID: <20131017093509.GA2172@hawk.usersys.redhat.com>
References: <1381767815-12510-1-git-send-email-drjones@redhat.com>
 <1381767815-12510-4-git-send-email-drjones@redhat.com>
 <20131017010606.GG24837@cbox>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Cc: kvm@vger.kernel.org, kvmarm@lists.cs.columbia.edu, gleb@redhat.com
To: Christoffer Dall <christoffer.dall@linaro.org>
Return-path: <kvm-owner@vger.kernel.org>
Received: from mx1.redhat.com ([209.132.183.28]:18375 "EHLO mx1.redhat.com"
	rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
	id S1751091Ab3JQJfX (ORCPT <rfc822;kvm@vger.kernel.org>);
	Thu, 17 Oct 2013 05:35:23 -0400
Content-Disposition: inline
In-Reply-To: <20131017010606.GG24837@cbox>
Sender: kvm-owner@vger.kernel.org
List-ID: <kvm.vger.kernel.org>

On Wed, Oct 16, 2013 at 06:06:06PM -0700, Christoffer Dall wrote:
> > -The exit status of the binary (and the script) is inconsistent: with
> > -qemu-system, after the unittest is done, the exit status of qemu is 1,
> > -different from the 'old style' qemu-kvm, whose exit status in successful
> > -completion is 0.
> > +To create the tests' images do
> 
> tests' images doesn't read very nice, can we just say test images?

OK

> 
> > +  ./configure
> > +  make
> > +in this directory. Tests' images are created in ./<ARCH>/*.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.
> 
> While you're at it, it would be great to provide a little more context
> in the README file.
> 
> For example, we start talking abouter 'runner scripts', we refer to
> something called '.flat', and we refer to QEMU without explaining how
> this whole thing works, what the components are, what is required of
> QEMU etc.
> 
> I think that would be useful for the wider adoption of kvm-unit-tests to
> developers writing ad-hoc patches for KVM.
> 
> A reference to docs/testdev.txt from somewhere approrpriate in such text
> would probably also be useful...
> 
> I know much of this is arch-specific, but there must be something
> generic or common across the architecture, and that would in essense be
> capturing what 'kvm-unit-tests' give you, which I think is very useful
> to have in the readme.
> 

Agreed. I'll see what I can do with the overall documentation. And I need
to create an arm/README for arm specific documentation as well.

drew