docs: Don't document disabled features

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

Kevin Wolf posted 5 patches 2 years, 3 months ago

Download series mbox

Test checkpatch passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20220131170411.125198-1-kwolf@redhat.com

docs/meson.build                      |  10 +
docs/system/device-url-syntax.rst.inc | 252 +++++++++++++-------------
qemu-options.hx                       |   9 +-
3 files changed, 146 insertions(+), 125 deletions(-)

Expand all Fold all

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

Posted by Kevin Wolf 2 years, 3 months ago

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