From: Kevin Wolf <kwolf@redhat.com>
To: qemu-block@nongnu.org
Cc: kwolf@redhat.com, pbonzini@redhat.com, qemu-devel@nongnu.org,
timao@redhat.com
Subject: [PATCH 0/5] docs: Don't document disabled features
Date: Mon, 31 Jan 2022 18:04:06 +0100 [thread overview]
Message-ID: <20220131170411.125198-1-kwolf@redhat.com> (raw)
It was reported that it's confusing that the QEMU man page contains
documentation of features that aren't even available in the build
because they were disabled during configure.
This series makes documentation for some block drivers conditional so
that it is only included in the man page (and other documentation) when
the feature is actually available in the build.
Kevin Wolf (5):
docs: Pass disabled configure options to sphinx
docs: Only mention iscsi in the man page when available
docs: Only mention ssh in the man page when available
docs: Only mention curl in the man page when available
docs: Only mention gluster in the man page when available
docs/meson.build | 10 +
docs/system/device-url-syntax.rst.inc | 252 +++++++++++++-------------
qemu-options.hx | 9 +-
3 files changed, 146 insertions(+), 125 deletions(-)
--
2.31.1
next reply other threads:[~2022-01-31 17:24 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-31 17:04 Kevin Wolf [this message]
2022-01-31 17:04 ` [PATCH 1/5] docs: Pass disabled configure options to sphinx Kevin Wolf
2022-01-31 17:53 ` Daniel P. Berrangé
2022-01-31 17:04 ` [PATCH 2/5] docs: Only mention iscsi in the man page when available Kevin Wolf
2022-01-31 18:57 ` Peter Maydell
2022-02-01 8:40 ` Kevin Wolf
2022-01-31 17:04 ` [PATCH 3/5] docs: Only mention ssh " Kevin Wolf
2022-01-31 17:04 ` [PATCH 4/5] docs: Only mention curl " Kevin Wolf
2022-01-31 17:04 ` [PATCH 5/5] docs: Only mention gluster " Kevin Wolf
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=20220131170411.125198-1-kwolf@redhat.com \
--to=kwolf@redhat.com \
--cc=pbonzini@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=timao@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).