From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:45919) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dT7u6-0000Kj-5P for qemu-devel@nongnu.org; Thu, 06 Jul 2017 10:37:15 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dT7u5-0006Xx-5G for qemu-devel@nongnu.org; Thu, 06 Jul 2017 10:37:14 -0400 From: Kashyap Chamarthy Date: Thu, 6 Jul 2017 16:36:44 +0200 Message-Id: <1499351806-3359-1-git-send-email-kchamart@redhat.com> Subject: [Qemu-devel] [PATCH v5 0/2] Rewrite 'live-block-ops.txt'; convert 'bitmaps.md' to rST List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: eblake@redhat.com, qemu-block@nongnu.org, kwolf@redhat.com, mreitz@redhat.com, jsnow@redhat.com, berto@igalia.com, Kashyap Chamarthy [v4: https://lists.nongnu.org/archive/html/qemu-devel/2017-06/msg06395.html] Rewrite the 'live-block-ops.txt' document (after renaming it to 'live-block-operations.rst') in reStructuredText (rST) format. Given upstream QEMU's desire[*] to take advantage of the Sphinx + rST framework to gerate its documentation: "Based on experience from the Linux kernel, QEMU's docs pipeline is going to be based on Sphinx [...] Sphinx is extensible and it is easy to add new input formats and input directives." And as part of review, John Snow suggested[+] to link to the 'bitmaps.md' document. So while at it, convert the 'bitmaps.md' document also into rST syntax. Then, moved both the documents ('live-block-operations.rst', and 'bitmaps.rst') to 'qemu/docs/interop' directory. (Paolo explained the term "interop" as: "management & interoperability with QEMU".) That's the result of this series: (1) Rewrite the 'live-block-ops.txt' document (for details, refer the commit message of the patch) in rST. Sphinx-generted HTML rendering: https://kashyapc.fedorapeople.org/v5-QEMU-Docs/_build/html/docs/live-block-operations.html (2) Convert the 'bitmaps.md' document to rST, as discussed on this[+] thread. Sphinx-generted HTML rendering: https://kashyapc.fedorapeople.org/v5-QEMU-Docs/_build/html/docs/bitmaps.html [*] http://wiki.qemu.org/Features/Documentation [+] https://lists.nongnu.org/archive/html/qemu-devel/2017-06/msg05428.html Kashyap Chamarthy (2): bitmaps.md: Convert to rST; move it into 'interop' dir live-block-ops.txt: Rename, rewrite, and improve it docs/devel/bitmaps.md | 505 --------------- docs/interop/bitmaps.rst | 555 +++++++++++++++++ docs/interop/live-block-operations.rst | 1072 ++++++++++++++++++++++++++++++++ docs/live-block-ops.txt | 72 --- 4 files changed, 1627 insertions(+), 577 deletions(-) delete mode 100644 docs/devel/bitmaps.md create mode 100644 docs/interop/bitmaps.rst create mode 100644 docs/interop/live-block-operations.rst delete mode 100644 docs/live-block-ops.txt -- 2.7.5