From: Kevin Wolf <kwolf@redhat.com>
To: Stefan Hajnoczi <stefanha@redhat.com>
Cc: qemu-devel@nongnu.org, qemu-block@nongnu.org,
Eric Blake <eblake@redhat.com>,
el13635@mail.ntua.gr
Subject: Re: [Qemu-devel] [PATCH v2] docs: add qemu-block-drivers(7) man page
Date: Mon, 24 Jul 2017 11:46:14 +0200 [thread overview]
Message-ID: <20170724094614.GF4630@noname.str.redhat.com> (raw)
In-Reply-To: <20170627154120.20346-1-stefanha@redhat.com>
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 <stefanha@redhat.com>
> Reviewed-by: John Snow <jsnow@redhat.com>
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
next prev parent reply other threads:[~2017-07-24 9:46 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-27 15:41 [Qemu-devel] [PATCH v2] docs: add qemu-block-drivers(7) man page Stefan Hajnoczi
2017-07-06 23:48 ` no-reply
2017-07-07 0:00 ` Fam Zheng
2017-07-17 18:37 ` [Qemu-devel] [Qemu-block] " John Snow
2017-07-19 15:34 ` Stefan Hajnoczi
2017-07-24 9:46 ` Kevin Wolf [this message]
2017-07-26 13:04 ` [Qemu-devel] " Stefan Hajnoczi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170724094614.GF4630@noname.str.redhat.com \
--to=kwolf@redhat.com \
--cc=eblake@redhat.com \
--cc=el13635@mail.ntua.gr \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).