Re: [PATCH V4 10/19] migration: cpr channel

[Steven Sistare]

On 12/6/2024 4:31 AM, Markus Armbruster wrote:
> Steven Sistare <steven.sistare@oracle.com> writes:
>
> > On 12/5/2024 10:37 AM, Markus Armbruster wrote:
> > > Steve Sistare <steven.sistare@oracle.com> writes:
> > >
> > > > Add the 'cpr' channel type, and stash the incoming cpr channel for use
> > > > in a subsequent patch.
> > > >
> > > > Signed-off-by: Steve Sistare <steven.sistare@oracle.com>
> > > [...]
> > >
> > > > diff --git a/qapi/migration.json b/qapi/migration.json
> > > > index a605dc2..a26960b 100644
> > > > --- a/qapi/migration.json
> > > > +++ b/qapi/migration.json
> > > > @@ -1578,11 +1578,12 @@
> > > >   # The migration channel-type request options.
> > > >   #
> > > >   # @main: Main outbound migration channel.
> > > > +# @cpr: cpr state channel.
> > > What does "cpr" stand for?
> >
> > docs/devel/migration/CPR.rst:  CheckPoint and Restart (CPR)
>
> Suggest something like
>
>       # The migration channel-type request options.
>       #
>       # @main: Main outbound migration channel.
>       #
>       # @cpr: Checkpoint and restart state channel
>
> A quick glance at docs/devel/migration/CPR.rst makes me wonder: is that
> really *developer* documentation?
>
> Should we have something meant for *users*, too?  QAPI docs could then
> link to it.

I agree, CPR.rst is user documentation.

Peter, are you OK with me moving it to the "System Emulation" section of
the documention?

- Steve