[libvirt] [PATCH] A description error about libvirtd manpage

[Martin Kletzander]

On Thu, Jun 30, 2016 at 07:32:53PM +0800, Jingjing Shao wrote:
>To fix the bug  The description of --timeout should be updated in libvirtd manpage
>https://bugzilla.redhat.com/show_bug.cgi?id=1325066
>
>According to the description, delete the part:
>"Be aware that resources such as autostart
>networks will result in never reaching the timeout, even when there are
>no client connections."
>---
> daemon/libvirtd.pod | 4 +---
> 1 file changed, 1 insertion(+), 3 deletions(-)
>

It would be nice to have some details explained in the commit message,
people should need not to look at the BZ.  It looks like you're almost
just reverting a077c562f60aa42cb9a665f5f596bb1d2cae2550 apart from the
fact that the change you are doing is not changing what is described
there.

>diff --git a/daemon/libvirtd.pod b/daemon/libvirtd.pod
>index 3b819a2..5adf8a2 100644
>--- a/daemon/libvirtd.pod
>+++ b/daemon/libvirtd.pod
>@@ -57,9 +57,7 @@ Use this name for the PID file, overriding the default value.
> =item B<-t, --timeout> I<SECONDS>
>
> Exit after timeout period (in seconds) elapse with no client connections
>-or registered resources.  Be aware that resources such as autostart
>-networks will result in never reaching the timeout, even when there are
>-no client connections.
>+or registered resources.
>

From what I understand from the BZ, libvirtd will stop after the timeout
even if there is something, e.g. network, started.  However this
paragraph will still state "with no connections or registered resources".

So either this need to be removed as well or the code needs to be
changed.  Either way, the reason for that needs to be described in the
commit message.  Just blindly changing documentation (or manual in that
manner) according to how the program behaves solves nothing.

Please describe what is the reason for this and the change a bit
thoroughly, thanks.

> =item B<-v, --verbose>
>
>--
>1.8.3.1
>
>--
>libvir-list mailing list
>libvir-list at redhat.com
>https://www.redhat.com/mailman/listinfo/libvir-list
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20160630/55e13bb6/attachment-0001.sig>