|
From: | Stefan Weil |
Subject: | Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown |
Date: | Tue, 15 Nov 2011 19:06:12 +0100 |
User-agent: | Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.16) Gecko/20111110 Iceowl/1.0b1 Icedove/3.0.11 |
Am 15.11.2011 14:44, schrieb Anthony Liguori:
On 11/15/2011 02:28 AM, Avi Kivity wrote:On 11/15/2011 12:41 AM, Anthony Liguori wrote:Right now our specs are written in psuedo-wiki syntax. This series convertsthem to markdown. markdown is a simple markup format that's gaining in popularity.The big advantage of using markdown is that there are tools that can convert it to relatively simple HTML. That means we can build a make infrastructure thatgenerates a nice set of static web pages. The syntax is also more human friendly than mediawiki syntax. To see what the stylized version of this looks like, check out: https://github.com/aliguori/qemu/tree/markdown/docs/specsNice. Suggest you enable rename detection, to make patches like these easier to read (not that it truly matters in the particular case).I haven't figured out yet how to make this sane to merge, but I've also converted qemu-doc.texi to a bunch of separate markdown files[1].The info is fairly out of date. I'll try to get patches out RSN so that we can all take a pass at trying to modernize some of the sections before the release.[1] https://github.com/aliguori/qemu/tree/markdown/docs/manual Regards, Anthony Liguori
Markdown is nice for separated specs and README files, but is it also possible to create a complete printed manual from all markdown files? I thought of a different solution: keep qemu-doc.texi and qemu-tech.texi and integrate texi files made from markdown files (with pandoc) into these two documents to get complete manuals. Regards, Stefan Weil
[Prev in Thread] | Current Thread | [Next in Thread] |