guest-agent: improve help for --allow-rpcs and --block-rpcs

[PATCH] guest-agent: improve help for --allow-rpcs and --block-rpcs

Posted by Angel M. Villegas 1 year, 1 month ago

Resolves: https://gitlab.com/qemu-project/qemu/-/issues/1757

Updates to qga help output and documentation for --allow-rpcs and --blocks-rpcs

Signed-off-by: Angel M. Villegas <anvilleg@cisco.com>
---
 docs/interop/qemu-ga.rst | 8 ++++----
 qga/main.c               | 4 ++--
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
index 461c5a35ee..72fb75a6f5 100644
--- a/docs/interop/qemu-ga.rst
+++ b/docs/interop/qemu-ga.rst
@@ -81,13 +81,13 @@ Options
 
 .. option:: -b, --block-rpcs=LIST
 
-  Comma-separated list of RPCs to disable (no spaces, use ``help`` to
-  list available RPCs).
+  Comma-separated list of RPCs to disable (no spaces, use ``--block-rpcs=help``
+  to list available RPCs).
 
 .. option:: -a, --allow-rpcs=LIST
 
-  Comma-separated list of RPCs to enable (no spaces, use ``help`` to
-  list available RPCs).
+  Comma-separated list of RPCs to enable (no spaces, use ``--allow-rpcs=help``
+  to list available RPCs).
 
 .. option:: -D, --dump-conf
 
diff --git a/qga/main.c b/qga/main.c
index 8668b9f3d3..bdf5344584 100644
--- a/qga/main.c
+++ b/qga/main.c
@@ -261,9 +261,9 @@ QEMU_COPYRIGHT "\n"
 "  -s, --service     service commands: install, uninstall, vss-install, vss-uninstall\n"
 #endif
 "  -b, --block-rpcs  comma-separated list of RPCs to disable (no spaces,\n"
-"                    use \"help\" to list available RPCs)\n"
+"                    use \"--block-rpcs=help\" to list available RPCs)\n"
 "  -a, --allow-rpcs  comma-separated list of RPCs to enable (no spaces,\n"
-"                    use \"help\" to list available RPCs)\n"
+"                    use \"--allow-rpcs=help\" to list available RPCs)\n"
 "  -D, --dump-conf   dump a qemu-ga config file based on current config\n"
 "                    options / command-line parameters to stdout\n"
 "  -r, --retry-path  attempt re-opening path if it's unavailable or closed\n"
-- 
2.39.2 (Apple Git-143)

Re: [PATCH] guest-agent: improve help for --allow-rpcs and --block-rpcs

Posted by Konstantin Kostiuk 1 year, 1 month ago

Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>

On Fri, Oct 13, 2023 at 6:53 PM Angel M. Villegas <anvilleg@cisco.com>
wrote:

> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/1757
>
> Updates to qga help output and documentation for --allow-rpcs and
> --blocks-rpcs
>
> Signed-off-by: Angel M. Villegas <anvilleg@cisco.com>
> ---
>  docs/interop/qemu-ga.rst | 8 ++++----
>  qga/main.c               | 4 ++--
>  2 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
> index 461c5a35ee..72fb75a6f5 100644
> --- a/docs/interop/qemu-ga.rst
> +++ b/docs/interop/qemu-ga.rst
> @@ -81,13 +81,13 @@ Options
>
>  .. option:: -b, --block-rpcs=LIST
>
> -  Comma-separated list of RPCs to disable (no spaces, use ``help`` to
> -  list available RPCs).
> +  Comma-separated list of RPCs to disable (no spaces, use
> ``--block-rpcs=help``
> +  to list available RPCs).
>
>  .. option:: -a, --allow-rpcs=LIST
>
> -  Comma-separated list of RPCs to enable (no spaces, use ``help`` to
> -  list available RPCs).
> +  Comma-separated list of RPCs to enable (no spaces, use
> ``--allow-rpcs=help``
> +  to list available RPCs).
>
>  .. option:: -D, --dump-conf
>
> diff --git a/qga/main.c b/qga/main.c
> index 8668b9f3d3..bdf5344584 100644
> --- a/qga/main.c
> +++ b/qga/main.c
> @@ -261,9 +261,9 @@ QEMU_COPYRIGHT "\n"
>  "  -s, --service     service commands: install, uninstall, vss-install,
> vss-uninstall\n"
>  #endif
>  "  -b, --block-rpcs  comma-separated list of RPCs to disable (no
> spaces,\n"
> -"                    use \"help\" to list available RPCs)\n"
> +"                    use \"--block-rpcs=help\" to list available RPCs)\n"
>  "  -a, --allow-rpcs  comma-separated list of RPCs to enable (no spaces,\n"
> -"                    use \"help\" to list available RPCs)\n"
> +"                    use \"--allow-rpcs=help\" to list available RPCs)\n"
>  "  -D, --dump-conf   dump a qemu-ga config file based on current config\n"
>  "                    options / command-line parameters to stdout\n"
>  "  -r, --retry-path  attempt re-opening path if it's unavailable or
> closed\n"
> --
> 2.39.2 (Apple Git-143)
>
>