[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH v2] docs: add qemu-block-drivers(7) man page
From: |
Kevin Wolf |
Subject: |
Re: [Qemu-devel] [PATCH v2] docs: add qemu-block-drivers(7) man page |
Date: |
Mon, 24 Jul 2017 11:46:14 +0200 |
User-agent: |
Mutt/1.5.21 (2010-09-15) |
Am 27.06.2017 um 17:41 hat Stefan Hajnoczi geschrieben:
> 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.
This is specifically for create options, which is a good start.
I think we should probably also plan how to integrate run-time options
(basically the equivalent of the QAPI schema comments for blockdev-add).
Maybe we can even generate this from the schema in order to avoid that
the documentation becomes outdated?
> 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).
>
> Signed-off-by: Stefan Hajnoczi <address@hidden>
> Reviewed-by: John Snow <address@hidden>
Looks good, but doesn't apply any more.
A rebased version can still be included in QEMU 2.10, documentation
improvements are fine during the freeze.
Kevin