From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:48766) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dOTi6-0006kJ-Qi for qemu-devel@nongnu.org; Fri, 23 Jun 2017 14:53:40 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dOTi5-0007MT-SI for qemu-devel@nongnu.org; Fri, 23 Jun 2017 14:53:38 -0400 References: <1498040351-6376-2-git-send-email-kchamart@redhat.com> <20170622085610.wasfoafo3b46iv4q@eukaryote> <3e638f0a-49f8-6fd0-04eb-12904768d571@redhat.com> <20170623081538.nqaxrylinzgg37il@eukaryote> From: John Snow Message-ID: <187bf584-3d27-323b-4ee9-a395d521669a@redhat.com> Date: Fri, 23 Jun 2017 14:53:30 -0400 MIME-Version: 1.0 In-Reply-To: <20170623081538.nqaxrylinzgg37il@eukaryote> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable Subject: Re: [Qemu-devel] [PATCH v3] live-block-ops.txt: Rename, rewrite, and improve it List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Kashyap Chamarthy Cc: qemu-devel@nongnu.org, kwolf@redhat.com, qemu-block@nongnu.org, stephen@that.guru, armbru@redhat.com, mreitz@redhat.com On 06/23/2017 04:15 AM, Kashyap Chamarthy wrote: > On Thu, Jun 22, 2017 at 10:13:03AM -0400, John Snow wrote: >> On 06/22/2017 04:56 AM, Kashyap Chamarthy wrote: >>> On Wed, Jun 21, 2017 at 06:49:02PM -0400, John Snow wrote: >=20 > [...] >=20 >>> Yes, I was thinking of this, too -- just link to the 'bitmaps' docume= nt. >>> >>> A quick side question here: Since upstream QEMU is converging onto >>> Sphinx, and rST, hope you mind if I convert docs/devel/bitmaps.md int= o >>> rST at somepoint, for consistency's sake. I'll file a separate revie= w, >>> anyway for that. In the long term, all / most other documents would >>> also be converted. >>> >> >> Of course not. I chose bitmaps.md so that it would be nice to view fro= m >> the github interface while remaining nice to read in plaintext, but fe= el >> free to convert it if we actually do standardize on Sphinx/rST. >> >> If you can make the generated output look prettier than the github >> rendering of the markdown I'll ACK it ;) >=20 > :-) Here's a sneak-peak (don't miss the index to your left hand side): >=20 > https://kashyapc.fedorapeople.org/v3-QEMU-Docs/_build/html/docs/bit= maps.html >=20 Looking good, you've got an errant backslash: 'Let=E2=80=99s assume the full backup is named full\_backup.img.' I also think we should change "Let=E2=80=99s assume it is named incremental.0.img." to "Let's assume the new incremental image is named incremental.0.img" so as to avoid "it" when dealing with two images. Otherwise, LGTM. > Compare that with the GitHub rendering: >=20 > https://github.com/qemu/qemu/blob/master/docs/devel/bitmaps.md >=20 > And, here's the source (in reStructuredText, despite the ".txt" > extension) for the 'bitmaps' doc (I made tiny styling changes): >=20 > https://kashyapc.fedorapeople.org/v3-QEMU-Docs/_build/html/_sources= /docs/bitmaps.txt > =20 >>> Yes, I fully agree with your suggestion. I will simply link to the >>> detailed document you wrote, which I was thinking of anyhow. >>> >>> Thanks for your comments! >>> >> Sure. You could perhaps mention the different sync modes, including to= p, >> none, full and incremental and urge readers to check out the bitmaps >> document for detailed workings of the incremental mode. >=20 > Yeah, good point. I'll make that edit in v2. >=20