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

[Peter Xu <peterx@redhat.com>]

On Wed, Dec 18, 2024 at 02:53:16PM -0500, Steven Sistare wrote:
> 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?

Considering CPR is very closely attached to migration, while we do have the
migration doc in one place right now in devel/... it may make it harder for
people to find relevant info.

It might indeed be an issue, and it can be a more generic that migration
doc (no matter whether it's user or devel oriented..) always stays in
devel/ so far..

As of now.. How about we still keep it in devel/migration/ so migration
stuff is together, but then we move user-relevant migration docs out
instead?  That may contain more than CPR.

-- 
Peter Xu