docs: add warning about virt-qemu-run being experimental

[libvirt PATCH] docs: add warning about virt-qemu-run being experimental

Daniel P. Berrangé posted 1 patch 4 years, 2 months ago

Download mbox

Test syntax-check failed

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

docs/manpages/virt-qemu-run.rst | 5 +++++
1 file changed, 5 insertions(+)

Expand all Fold all

[libvirt PATCH] docs: add warning about virt-qemu-run being experimental

Posted by Daniel P. Berrangé 4 years, 2 months ago

We currently note that the QEMU embedded driver in experimental
in the drvqemu.html file, but we should do the same in the
virt-qemu-run man page.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/manpages/virt-qemu-run.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/manpages/virt-qemu-run.rst b/docs/manpages/virt-qemu-run.rst
index 5074a928b7..b06c311b1d 100644
--- a/docs/manpages/virt-qemu-run.rst
+++ b/docs/manpages/virt-qemu-run.rst
@@ -33,6 +33,11 @@ If the virt-qemu-run program is interrupted (eg Ctrl-C) it will
 immediately terminate the virtual machine without giving the guest
 OS any opportunity to gracefully shutdown.
 
+**NOTE: this tool is currently considered experimental.** Its
+usage and behaviour is still subject to change in future libvirt
+releases. For further information on its usage consult the
+`QEMU driver documentation <https://libvirt.org/drvqemu.html#uriembedded>`_.
+
 OPTIONS
 =======
 
-- 
2.24.1

Re: [libvirt PATCH] docs: add warning about virt-qemu-run being experimental

Posted by Erik Skultety 4 years, 2 months ago

On Wed, Jan 29, 2020 at 11:18:51AM +0000, Daniel P. Berrangé wrote:
> We currently note that the QEMU embedded driver in experimental

s/in/is

> in the drvqemu.html file, but we should do the same in the
> virt-qemu-run man page.
>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

Reviewed-by: Erik Skultety <eskultet@redhat.com>