Re: [Qemu-devel] [PATCH] docs: Convert migration.txt to rst

[Kashyap Chamarthy <kchamart@redhat.com>]

On Wed, Dec 13, 2017 at 08:11:46PM +0000, Dr. David Alan Gilbert wrote:
> * Kashyap Chamarthy (kchamart@redhat.com) wrote:
> > On Tue, Dec 12, 2017 at 01:56:00PM +0000, Dr. David Alan Gilbert (git) wrote:

[...]

> > A good chunk of changes I suggest are pre-existing, so take it with a
> > grain of salt :-).  I'm ambivalent on whether to keep the conversion to
> > rST and the other rST syntax changes separate.  Maybe we can keep in one
> > change, as this doesn't impact backports in terms of code /
> > functionality.
> 
> I'd like to fix the non-rST fixes some other time; there's plenty wrong
> with the actual contents of this file.

That's fine.

> (I need to pull in a fix from Jay Zhou before resending this actually).
 
[...]

> > Not this patch's problem, but do we have the more information that is to
> > be filled in above?
> 
> Oh yes, plenty!

Okay, I take it that you'd address them as a future patch.

[...]

> > - I think the above is a TODO item; so you can use:
> > 
> >     .. TODO (dgilbert):: talk about how vmstate <-> qdev interact, and
> >     what the instance ids mean.
> > 
> >   As that'll keep it only in the source rST; but not in the rendered
> >   version.
> 
> I'd rather leave the items rendered, otherwise they have even less
> chance of being fixed.

Yeah, I thought about it too; you're correct, a visual reminder works
better.

[...]

> > >  When postcopy starts the source sends the page discard data and then
> > >  forms the 'package' containing:
> > >  
> > > -   Command: 'postcopy listen'
> > > -   The device state
> > 
> > In my local Sphinx-based HTML rendering, the above "The device state"
> > ended up being bold somehow.
> 
> Any idea why? It's fine both in vim and rst2html-3's output.

Don't know yet.  You can see here in the Sphinx-rendered HTML version:

    https://kashyapc.fedorapeople.org/QEMU-Docs/_build/html/docs/migration.html

You can also see in the "Massaging functions" --> "Subsections" --> "For
example;" also turned into bold.

Same for the "Postcopy states".  And a couple of other places, where
text turned into bold.

I'll let you know once I figure it out.

[...]

-- 
/kashyap