Re: [Qemu-devel] [PATCH v3] docs: add qemu-block-drivers(7) man page

[Stefan Hajnoczi <stefanha@redhat.com>]

[-- Attachment #1: Type: text/plain, Size: 1222 bytes --]

On Wed, Jul 26, 2017 at 02:09:13PM +0100, Daniel P. Berrange wrote:
> On Wed, Jul 26, 2017 at 02:03:37PM +0100, Stefan Hajnoczi wrote:
> > Block driver documentation is available in qemu-doc.html.  It would be
> > convenient to have documentation for formats, protocols, and filter
> > drivers in a man page.
> > 
> > Extract the relevant part of qemu-doc.html into a new file called
> > docs/qemu-block-drivers.texi.  This file can also be built as a
> > stand-alone document (man, html, etc).
> 
> Is there perhaps benefit it taking it further and creating one
> man page per block driver. Many of the block drivers are optional
> and can be turned off, so this would let us leave out the docs
> for disabled block drivers too.

That's a great idea - especially in the world of modular block drivers
(they can be installed after the core QEMU package).

Can we leave that for later when also documenting the open parameters?
We can still make use of a qemu-block-drivers(7) index for
discoverability - a introductory man page with references to all
possible block drivers (some of which may not be installed).  This is a
common man page idiom for programs with subcommands, like git(1).

Stefan

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 455 bytes --]