[PATCH] docs: man: Unify wording for the description of '--timeout' of daemons
Daniel P. Berrangé
berrange at redhat.com
Wed Jan 19 15:31:48 UTC 2022
On Wed, Jan 19, 2022 at 04:05:05PM +0100, Peter Krempa wrote:
> Use a common wording for all various daemons to prevent having to adjust
> the documentation any further by just outlining that neither clients nor
> anything else needing the attention of the daemon must be present in
> order to shut down.
I don't think this is a good idea. The --timeout arg should be
specific about exactly what scenarios block timeout for the
daemon in question.
> Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=2035985
THis bug is reporting that they were expecting virtnetworkd
to stay running as long as any domains were still running.
ie they thought there was a link between virtqemud and
virtnetworkd staying running. The proposed text still
leaves that confusion present so doesn't address the problem
reported IMHO.
> Signed-off-by: Peter Krempa <pkrempa at redhat.com>
> ---
> docs/manpages/virtbhyved.rst | 3 ++-
> docs/manpages/virtinterfaced.rst | 3 ++-
> docs/manpages/virtlockd.rst | 5 +++--
> docs/manpages/virtlogd.rst | 5 +++--
> docs/manpages/virtlxcd.rst | 3 ++-
> docs/manpages/virtnetworkd.rst | 3 ++-
> docs/manpages/virtnodedevd.rst | 3 ++-
> docs/manpages/virtnwfilterd.rst | 3 ++-
> docs/manpages/virtproxyd.rst | 3 ++-
> docs/manpages/virtqemud.rst | 3 ++-
> docs/manpages/virtsecretd.rst | 3 ++-
> docs/manpages/virtstoraged.rst | 3 ++-
> docs/manpages/virtvboxd.rst | 3 ++-
> docs/manpages/virtvzd.rst | 3 ++-
> docs/manpages/virtxend.rst | 3 ++-
> 15 files changed, 32 insertions(+), 17 deletions(-)
>
> diff --git a/docs/manpages/virtbhyved.rst b/docs/manpages/virtbhyved.rst
> index 9fdaca6da2..2e56514914 100644
> --- a/docs/manpages/virtbhyved.rst
> +++ b/docs/manpages/virtbhyved.rst
> @@ -61,7 +61,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtinterfaced.rst b/docs/manpages/virtinterfaced.rst
> index 5777dba638..9b836b0b12 100644
> --- a/docs/manpages/virtinterfaced.rst
> +++ b/docs/manpages/virtinterfaced.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtlockd.rst b/docs/manpages/virtlockd.rst
> index 0bbee5a5f7..7ea720d1b7 100644
> --- a/docs/manpages/virtlockd.rst
> +++ b/docs/manpages/virtlockd.rst
> @@ -50,8 +50,9 @@ Use this configuration file, overriding the default value.
>
> ``-t``, ``--timeout`` *SECONDS*
>
> -Automatically shutdown after *SECONDS* have elapsed with
> -no active client or lock.
> +Exit after timeout period (in seconds), provided there are neither any client
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-p``, ``--pid-file`` *FILE*
>
> diff --git a/docs/manpages/virtlogd.rst b/docs/manpages/virtlogd.rst
> index 1e39ff1b49..0b00595a85 100644
> --- a/docs/manpages/virtlogd.rst
> +++ b/docs/manpages/virtlogd.rst
> @@ -50,8 +50,9 @@ Use this configuration file, overriding the default value.
>
> ``-t``, ``--timeout`` *SECONDS*
>
> -Automatically shutdown after *SECONDS* have elapsed with
> -no active console log.
> +Exit after timeout period (in seconds), provided there are neither any client
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-p``, ``--pid-file`` *FILE*
>
> diff --git a/docs/manpages/virtlxcd.rst b/docs/manpages/virtlxcd.rst
> index 2e9d8fd14b..4c9a441d0d 100644
> --- a/docs/manpages/virtlxcd.rst
> +++ b/docs/manpages/virtlxcd.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst
> index 6d9c5e5fa3..b9409723fb 100644
> --- a/docs/manpages/virtnetworkd.rst
> +++ b/docs/manpages/virtnetworkd.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtnodedevd.rst b/docs/manpages/virtnodedevd.rst
> index ef968e486e..1c79529bd8 100644
> --- a/docs/manpages/virtnodedevd.rst
> +++ b/docs/manpages/virtnodedevd.rst
> @@ -82,7 +82,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtnwfilterd.rst b/docs/manpages/virtnwfilterd.rst
> index 4faa6b225d..0690c795d9 100644
> --- a/docs/manpages/virtnwfilterd.rst
> +++ b/docs/manpages/virtnwfilterd.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtproxyd.rst b/docs/manpages/virtproxyd.rst
> index 0366935b9a..918aae6c2b 100644
> --- a/docs/manpages/virtproxyd.rst
> +++ b/docs/manpages/virtproxyd.rst
> @@ -105,7 +105,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtqemud.rst b/docs/manpages/virtqemud.rst
> index ea8d6e3105..f1f1710393 100644
> --- a/docs/manpages/virtqemud.rst
> +++ b/docs/manpages/virtqemud.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtsecretd.rst b/docs/manpages/virtsecretd.rst
> index fffb3a24f6..f35bfb6b5a 100644
> --- a/docs/manpages/virtsecretd.rst
> +++ b/docs/manpages/virtsecretd.rst
> @@ -82,7 +82,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtstoraged.rst b/docs/manpages/virtstoraged.rst
> index 4ceae57e40..ae25a90040 100644
> --- a/docs/manpages/virtstoraged.rst
> +++ b/docs/manpages/virtstoraged.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtvboxd.rst b/docs/manpages/virtvboxd.rst
> index d7339d99f2..0be68d87b8 100644
> --- a/docs/manpages/virtvboxd.rst
> +++ b/docs/manpages/virtvboxd.rst
> @@ -81,7 +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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtvzd.rst b/docs/manpages/virtvzd.rst
> index 42dfa263e4..d2d6fecce6 100644
> --- a/docs/manpages/virtvzd.rst
> +++ b/docs/manpages/virtvzd.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> diff --git a/docs/manpages/virtxend.rst b/docs/manpages/virtxend.rst
> index b08346b489..d12196956c 100644
> --- a/docs/manpages/virtxend.rst
> +++ b/docs/manpages/virtxend.rst
> @@ -83,7 +83,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.
> +connections nor any other resources (e.g. running domains, locks, etc.) needing
> +attention of the daemon.
>
> ``-v``, ``--verbose``
>
> --
> 2.34.1
>
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
More information about the libvir-list
mailing list