qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: Kashyap Chamarthy <kchamart@redhat.com>
Cc: qemu-devel@nongnu.org, qemu-block@nongnu.org,
	vsementsov@virtuozzo.com, armbru@redhat.com, aliang@redhat.com,
	nsoffer@redhat.com, Fam Zheng <fam@euphon.net>,
	qemu-stable@nongnu.org, eblake@redhat.com
Subject: Re: [Qemu-devel] [PATCH v3 2/2] docs/interop/bitmaps: rewrite and modernize doc
Date: Tue, 30 Apr 2019 18:56:08 -0400	[thread overview]
Message-ID: <a9e5880b-cc9a-6f1e-3a6d-b1db09f1c895@redhat.com> (raw)
In-Reply-To: <20190429134454.GB4675@paraplu>



On 4/29/19 9:44 AM, Kashyap Chamarthy wrote:
> On Fri, Apr 26, 2019 at 06:15:28PM -0400, John Snow wrote:
>> This just about rewrites the entirety of the bitmaps.rst document to
>> make it consistent with the 4.0 release. I have added new features seen
>> in the 4.0 release, as well as tried to clarify some points that keep
>> coming up when discussing this feature both in-house and upstream.
>>
>> Yes, it's a lot longer, mostly due to examples. I get a bit chatty.
>> I could use a good editor to help reign in my chattiness.
>>
>> It does not yet cover pull backups or migration details, but I intend to
>> keep extending this document to cover those cases.
>>
>> Please try compiling it with sphinx and look at the rendered output, I
>> don't have hosting to share my copy at present. 
> 
> FWIW, here's a public rendering (with the "Alabaster" Sphinx theme) with
> your v3 applied:
> 
>     https://kashyapc.fedorapeople.org/QEMU-Docs-v4.0.0-143-g1cb2ca0415/_build/html/docs/interop/bitmaps.html
> 

Thank you!! We really need to figure out hosting for these.

> Thanks for the overhaul.  Afraid, I've been just too swamped to be able
> to look at this in detail, much as I'd love to.  I will slowly catch up.
> 
>     - - -
> 
> (Note to self: send to the list the text-to-rST converted QEMU docs
> sitting locally on a Git branch.)
> 

PLEASE do! Please CC me on them. I realize it's not a priority for you
at the moment but I will happily take any existing work you've done.

> [...]
> 
>> I think this new layout reads nicer in the HTML format than the old
>> one did, at the expense of looking less readable in the source tree
>> itself (though not completely unmanagable. We did decide to convert it
>> from Markdown to ReST, after all, so I am going all-in on ReST.)
> 
> [...]
> 

WARNING: multiple messages have this Message-ID (diff)
From: John Snow <jsnow@redhat.com>
To: Kashyap Chamarthy <kchamart@redhat.com>
Cc: Fam Zheng <fam@euphon.net>,
	vsementsov@virtuozzo.com, aliang@redhat.com,
	qemu-block@nongnu.org, qemu-stable@nongnu.org,
	qemu-devel@nongnu.org, armbru@redhat.com, nsoffer@redhat.com
Subject: Re: [Qemu-devel] [PATCH v3 2/2] docs/interop/bitmaps: rewrite and modernize doc
Date: Tue, 30 Apr 2019 18:56:08 -0400	[thread overview]
Message-ID: <a9e5880b-cc9a-6f1e-3a6d-b1db09f1c895@redhat.com> (raw)
Message-ID: <20190430225608.bHTxWmvjGLedKeJHSMtSiGgFgJMBN0EmpcCQDOVopWo@z> (raw)
In-Reply-To: <20190429134454.GB4675@paraplu>



On 4/29/19 9:44 AM, Kashyap Chamarthy wrote:
> On Fri, Apr 26, 2019 at 06:15:28PM -0400, John Snow wrote:
>> This just about rewrites the entirety of the bitmaps.rst document to
>> make it consistent with the 4.0 release. I have added new features seen
>> in the 4.0 release, as well as tried to clarify some points that keep
>> coming up when discussing this feature both in-house and upstream.
>>
>> Yes, it's a lot longer, mostly due to examples. I get a bit chatty.
>> I could use a good editor to help reign in my chattiness.
>>
>> It does not yet cover pull backups or migration details, but I intend to
>> keep extending this document to cover those cases.
>>
>> Please try compiling it with sphinx and look at the rendered output, I
>> don't have hosting to share my copy at present. 
> 
> FWIW, here's a public rendering (with the "Alabaster" Sphinx theme) with
> your v3 applied:
> 
>     https://kashyapc.fedorapeople.org/QEMU-Docs-v4.0.0-143-g1cb2ca0415/_build/html/docs/interop/bitmaps.html
> 

Thank you!! We really need to figure out hosting for these.

> Thanks for the overhaul.  Afraid, I've been just too swamped to be able
> to look at this in detail, much as I'd love to.  I will slowly catch up.
> 
>     - - -
> 
> (Note to self: send to the list the text-to-rST converted QEMU docs
> sitting locally on a Git branch.)
> 

PLEASE do! Please CC me on them. I realize it's not a priority for you
at the moment but I will happily take any existing work you've done.

> [...]
> 
>> I think this new layout reads nicer in the HTML format than the old
>> one did, at the expense of looking less readable in the source tree
>> itself (though not completely unmanagable. We did decide to convert it
>> from Markdown to ReST, after all, so I am going all-in on ReST.)
> 
> [...]
> 


  parent reply	other threads:[~2019-04-30 22:57 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-26 22:15 [Qemu-devel] [PATCH v3 0/2] docs/interop/bitmaps: rewrite and modernize doc John Snow
2019-04-26 22:15 ` John Snow
2019-04-26 22:15 ` [Qemu-devel] [PATCH v3 1/2] Makefile: add nit-picky mode to sphinx-build John Snow
2019-04-26 22:15   ` John Snow
2019-04-29  9:17   ` Vladimir Sementsov-Ogievskiy
2019-04-29  9:17     ` Vladimir Sementsov-Ogievskiy
2019-04-30 22:53     ` John Snow
2019-04-30 22:53       ` John Snow
2019-04-26 22:15 ` [Qemu-devel] [PATCH v3 2/2] docs/interop/bitmaps: rewrite and modernize doc John Snow
2019-04-26 22:15   ` John Snow
2019-04-29  9:30   ` Vladimir Sementsov-Ogievskiy
2019-04-29  9:30     ` Vladimir Sementsov-Ogievskiy
2019-04-29 13:44   ` Kashyap Chamarthy
2019-04-29 13:44     ` Kashyap Chamarthy
2019-04-30 22:56     ` John Snow [this message]
2019-04-30 22:56       ` John Snow

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a9e5880b-cc9a-6f1e-3a6d-b1db09f1c895@redhat.com \
    --to=jsnow@redhat.com \
    --cc=aliang@redhat.com \
    --cc=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=fam@euphon.net \
    --cc=kchamart@redhat.com \
    --cc=nsoffer@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-stable@nongnu.org \
    --cc=vsementsov@virtuozzo.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).