Re: [Qemu-devel] [PULL 09/13] hmp: Add hmp_announce_self

["Dr. David Alan Gilbert" <dgilbert@redhat.com>]

* Thomas Huth (thuth@redhat.com) wrote:
> On 22/02/2019 15.55, Jason Wang wrote:
> > From: "Dr. David Alan Gilbert" <dgilbert@redhat.com>
> > 
> > Add an HMP command to trigger self annocements.
> > Unlike the QMP command (which takes a set of parameters), the HMP
> > command reuses the set of parameters used for migration.
> > 
> > Signend-off-by: Vladislav Yasevich <vyasevic@redhat.com>
> > Signed-off-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
> > Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
> > Signed-off-by: Jason Wang <jasowang@redhat.com>
> > ---
> >  hmp-commands.hx  | 14 ++++++++++++++
> >  hmp.c            |  5 +++++
> >  hmp.h            |  1 +
> >  tests/test-hmp.c |  1 +
> >  4 files changed, 21 insertions(+)
> > 
> > diff --git a/hmp-commands.hx b/hmp-commands.hx
> > index ba71558..9f812bc 100644
> > --- a/hmp-commands.hx
> > +++ b/hmp-commands.hx
> > @@ -931,6 +931,20 @@ stops because the size limit is reached.
> >  ETEXI
> >  
> >      {
> > +        .name       = "announce_self",
> > +        .args_type  = "",
> > +        .params     = "",
> > +        .help       = "Trigger GARP/RARP announcements",
> > +        .cmd        = hmp_announce_self,
> > +    },
> > +
> > +STEXI
> > +@item announce_self
> > +@findex announce_self
> > +Trigger GARP/RARP announcements.
> > +ETEXI
> 
> The help text is incredibly sparse. I doubt that the average user
> manages to find out the meaning of this command just by looking at this
> short information. Also, shouldn't you mention here that the parameters
> used for migration are re-used here, like in the patch description?
> Thus, could you please send a follow-up patch to increase that
> information here a little bit, please?

I've updated that to:
+STEXI
+@item announce_self
+@findex announce_self
+Trigger a round of GARP/RARP broadcasts; this is useful for explicitly updating the
+network infrastructure after a reconfiguration or some forms of migration.
+The timings of the round are set by the migration announce parameters.
 ETEXI

None of these pieces of help seem to be particularly deep.

Dave

>  Thanks,
>   Thomas
--
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK