From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([140.186.70.92]:35362)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <anthony@codemonkey.ws>) id 1QKcB5-0003ca-1o
	for qemu-devel@nongnu.org; Thu, 12 May 2011 16:08:07 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <anthony@codemonkey.ws>) id 1QKcB3-0001pU-Mx
	for qemu-devel@nongnu.org; Thu, 12 May 2011 16:08:07 -0400
Received: from mail-gw0-f45.google.com ([74.125.83.45]:50397)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <anthony@codemonkey.ws>) id 1QKcB3-0001pM-JD
	for qemu-devel@nongnu.org; Thu, 12 May 2011 16:08:05 -0400
Received: by gwb19 with SMTP id 19so788261gwb.4
	for <qemu-devel@nongnu.org>; Thu, 12 May 2011 13:08:04 -0700 (PDT)
Message-ID: <4DCC3E21.6080101@codemonkey.ws>
Date: Thu, 12 May 2011 15:08:01 -0500
From: Anthony Liguori <anthony@codemonkey.ws>
MIME-Version: 1.0
References: <1305023443-8722-1-git-send-email-kraxel@redhat.com>	<201105101624.08253.bradh@frogmouth.net>	<4DCBA79B.5040608@redhat.com>	<m3d3jo2n1u.fsf@blackfin.pond.sub.org>	<4DCBFBFF.7000203@redhat.com>
	<4DCBFE2F.7040202@codemonkey.ws>	<m37h9vnbq0.fsf@blackfin.pond.sub.org>	<4DCC0981.4070801@codemonkey.ws>	<m3vcxfby1o.fsf@blackfin.pond.sub.org>	<BANLkTiniSyqXDTxeqARZJCjDska077MNsw@mail.gmail.com>
	<20110512193254.GH3045@playa.redhat.com>
In-Reply-To: <20110512193254.GH3045@playa.redhat.com>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Subject: Re: [Qemu-devel] qdev device documentation (Re: [PATCH 0/2]
 usb-linux: physical port handling.)
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <http://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
To: Peter Maydell <peter.maydell@linaro.org>, Markus Armbruster <armbru@redhat.com>, amit.shah@redhat.com, qemu-devel@nongnu.org, Gerd Hoffmann <kraxel@redhat.com>, Brad Hards <bradh@frogmouth.net>

On 05/12/2011 02:32 PM, Alon Levy wrote:
> We could have a (just picking up the Spice example) spice-docs file
> that was checked in and updated periodically by generation by the maintainer.
> It's error prone, you could still update the source but forget to checkin the spice-docs
> and get an old version, but at least it would still be auto-generated, and it would
> not prevent the docs builder from working.

It's not just Spice though.  There are still a number of devices that 
only get built with certain targets.

Doing it right is actually fairly complicated.  It's far easier to use a 
central doc file, and then add mechanisms to ensure things don't get out 
of sync.

Regards,

Anthony Liguori

>
>> -- PMM
>>
>