From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([140.186.70.92]:42325) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RQNPO-0006z9-MU for qemu-devel@nongnu.org; Tue, 15 Nov 2011 13:07:02 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RQNPK-0003nZ-Te for qemu-devel@nongnu.org; Tue, 15 Nov 2011 13:06:58 -0500 Received: from v220110690675601.yourvserver.net ([78.47.199.172]:41401) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RQNPK-0003nK-P7 for qemu-devel@nongnu.org; Tue, 15 Nov 2011 13:06:54 -0500 Message-ID: <4EC2AA14.3000106@weilnetz.de> Date: Tue, 15 Nov 2011 19:06:12 +0100 From: Stefan Weil MIME-Version: 1.0 References: <1321310505-27845-1-git-send-email-aliguori@us.ibm.com> <4EC222A3.9010209@redhat.com> <4EC26CB8.5020508@us.ibm.com> In-Reply-To: <4EC26CB8.5020508@us.ibm.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Subject: Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Anthony Liguori Cc: Avi Kivity , qemu-devel@nongnu.org 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 >>> converts >>> them 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 that >>> generates 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/specs >>> >>> >> >> Nice. 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