[libvirt PATCH 0/2] docs: clarify --timeout description in manpages
The reference to running domains is not true for most of the daemons. virtlxcd(8) and virtqemud(8) are left untouched. Ján Tomko (2): docs: clarify --timeout description for split daemons docs: clarify --timeout description for virtsecretd docs/manpages/virtbhyved.rst | 4 ++-- docs/manpages/virtinterfaced.rst | 4 ++-- docs/manpages/virtnetworkd.rst | 4 ++-- docs/manpages/virtnodedevd.rst | 4 ++-- docs/manpages/virtnwfilterd.rst | 4 ++-- docs/manpages/virtproxyd.rst | 4 ++-- docs/manpages/virtsecretd.rst | 2 +- docs/manpages/virtstoraged.rst | 4 ++-- docs/manpages/virtvboxd.rst | 4 ++-- docs/manpages/virtvzd.rst | 4 ++-- 10 files changed, 19 insertions(+), 19 deletions(-) -- 2.39.2
Remove the reference to "running domains" for daemons that happily exit while domains are running. https://bugzilla.redhat.com/show_bug.cgi?id=2035985 Signed-off-by: Ján Tomko <jtomko@redhat.com> --- docs/manpages/virtbhyved.rst | 4 ++-- docs/manpages/virtinterfaced.rst | 4 ++-- docs/manpages/virtnetworkd.rst | 4 ++-- docs/manpages/virtnodedevd.rst | 4 ++-- docs/manpages/virtnwfilterd.rst | 4 ++-- docs/manpages/virtproxyd.rst | 4 ++-- docs/manpages/virtstoraged.rst | 4 ++-- docs/manpages/virtvboxd.rst | 4 ++-- docs/manpages/virtvzd.rst | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/manpages/virtbhyved.rst b/docs/manpages/virtbhyved.rst index 9fdaca6da2..32e636ce35 100644 --- a/docs/manpages/virtbhyved.rst +++ b/docs/manpages/virtbhyved.rst @@ -60,8 +60,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtinterfaced.rst b/docs/manpages/virtinterfaced.rst index 17884ed701..419d523494 100644 --- a/docs/manpages/virtinterfaced.rst +++ b/docs/manpages/virtinterfaced.rst @@ -81,8 +81,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst index 4a7d99a9d3..fa3bb8ab45 100644 --- a/docs/manpages/virtnetworkd.rst +++ b/docs/manpages/virtnetworkd.rst @@ -81,8 +81,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtnodedevd.rst b/docs/manpages/virtnodedevd.rst index 8ee108c37e..74c539602d 100644 --- a/docs/manpages/virtnodedevd.rst +++ b/docs/manpages/virtnodedevd.rst @@ -80,8 +80,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtnwfilterd.rst b/docs/manpages/virtnwfilterd.rst index 60fdb30d5c..5998f3084e 100644 --- a/docs/manpages/virtnwfilterd.rst +++ b/docs/manpages/virtnwfilterd.rst @@ -81,8 +81,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtproxyd.rst b/docs/manpages/virtproxyd.rst index 76156c9e02..0ac7ded9c4 100644 --- a/docs/manpages/virtproxyd.rst +++ b/docs/manpages/virtproxyd.rst @@ -103,8 +103,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtstoraged.rst b/docs/manpages/virtstoraged.rst index ab67a42b4a..23e508df50 100644 --- a/docs/manpages/virtstoraged.rst +++ b/docs/manpages/virtstoraged.rst @@ -81,8 +81,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtvboxd.rst b/docs/manpages/virtvboxd.rst index 2fe8ae0009..199bffd824 100644 --- a/docs/manpages/virtvboxd.rst +++ b/docs/manpages/virtvboxd.rst @@ -80,8 +80,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` diff --git a/docs/manpages/virtvzd.rst b/docs/manpages/virtvzd.rst index 1837351aec..c9360b944b 100644 --- a/docs/manpages/virtvzd.rst +++ b/docs/manpages/virtvzd.rst @@ -81,8 +81,8 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` -Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +Exit after timeout period (in seconds), provided there are no client +connections. ``-v``, ``--verbose`` -- 2.39.2
As of commit 9e3cc0ff5 the virtsecretd daemon does not timeout while it keeps any ephemeral secrets. https://bugzilla.redhat.com/show_bug.cgi?id=2035985 Signed-off-by: Ján Tomko <jtomko@redhat.com> --- docs/manpages/virtsecretd.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manpages/virtsecretd.rst b/docs/manpages/virtsecretd.rst index 87e1e5d5a1..a4abb2963c 100644 --- a/docs/manpages/virtsecretd.rst +++ b/docs/manpages/virtsecretd.rst @@ -81,7 +81,7 @@ Use this name for the PID file, overriding the default value. ``-t``, ``--timeout *SECONDS*`` Exit after timeout period (in seconds), provided there are neither any client -connections nor any running domains. +connections nor any ephemeral secrets. ``-v``, ``--verbose`` -- 2.39.2
On Wed, Mar 15, 2023 at 11:24:02AM +0100, Ján Tomko wrote:
The reference to running domains is not true for most of the daemons. virtlxcd(8) and virtqemud(8) are left untouched.
Ján Tomko (2): docs: clarify --timeout description for split daemons docs: clarify --timeout description for virtsecretd
Reviewed-by: Andrea Bolognani <abologna@redhat.com> -- Andrea Bolognani / Red Hat / Virtualization
participants (2)
-
Andrea Bolognani -
Ján Tomko