Skip to content

docs: Don't document disabled features

Kevin Wolf qemu-devel 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 3 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5docs: Pass disabled configure options to sphinxdocs/meson.build+10 -01 reply
2/5docs: Only mention iscsi in the man page when availabledocs/system/device-url-syntax.rst.inc qemu-options.hx+37 -322 replies
3/5docs: Only mention ssh in the man page when availabledocs/system/device-url-syntax.rst.inc+10 -80 replies
4/5docs: Only mention curl in the man page when availabledocs/system/device-url-syntax.rst.inc+58 -560 replies
5/5docs: Only mention gluster in the man page when availabledocs/system/device-url-syntax.rst.inc+33 -310 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/5] docs: Don't document disabled features

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(-)
Signature · 1 line
2.31.1