From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([140.186.70.92]:36131) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QKbdQ-0007qw-Ly for qemu-devel@nongnu.org; Thu, 12 May 2011 15:33:21 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QKbdO-0003GB-K3 for qemu-devel@nongnu.org; Thu, 12 May 2011 15:33:20 -0400 Received: from mx1.redhat.com ([209.132.183.28]:1570) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QKbdO-0003Ft-BQ for qemu-devel@nongnu.org; Thu, 12 May 2011 15:33:18 -0400 Date: Thu, 12 May 2011 22:32:54 +0300 From: Alon Levy Message-ID: <20110512193254.GH3045@playa.redhat.com> References: <1305023443-8722-1-git-send-email-kraxel@redhat.com> <201105101624.08253.bradh@frogmouth.net> <4DCBA79B.5040608@redhat.com> <4DCBFBFF.7000203@redhat.com> <4DCBFE2F.7040202@codemonkey.ws> <4DCC0981.4070801@codemonkey.ws> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Subject: Re: [Qemu-devel] qdev device documentation (Re: [PATCH 0/2] usb-linux: physical port handling.) List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Peter Maydell Cc: amit.shah@redhat.com, Gerd Hoffmann , Markus Armbruster , Brad Hards , qemu-devel@nongnu.org On Thu, May 12, 2011 at 08:15:43PM +0200, Peter Maydell wrote: > On 12 May 2011 19:58, Markus Armbruster wrote: > > Anthony Liguori writes: > >> But for things like Spice where the lack of libspice influences > >> whether the device is available, how do I extract formal documentation > >> to publish on qemu.org reliably? > > > > If no maintainer of QEMU can build with Spice enabled, it got more > > serious problems than extracting its documentation. > > The point isn't that you can arrange to build with option Foo > enabled but that if the build environment changes accidentally > there's not much warning that the official docs have suddenly > lost some devices. The spice probe in configure will barf if you > said "--enable-spice" and spice wasn't found, but I bet not all > configure checks that influence availability of a device do that. > And since there isn't currently an '--enable-all' option to > configure the docs builder would have to keep track of every > new --enable-foo switch and add it to the configure command... > > Which looks pretty ugly and not very reliable to me. > 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. > -- PMM >