[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-block] [Qemu-devel] [PATCH v3] docs: add qemu-block-drivers(7)
Daniel P. Berrange
Re: [Qemu-block] [Qemu-devel] [PATCH v3] docs: add qemu-block-drivers(7) man page
Thu, 27 Jul 2017 11:13:20 +0100
On Thu, Jul 27, 2017 at 11:12:35AM +0100, Stefan Hajnoczi wrote:
> 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).
Sure, fine with me.
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|