From: Avi Kivity <avi@redhat.com>
To: Anthony Liguori <aliguori@us.ibm.com>
Cc: qemu-devel@nongnu.org
Subject: Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown
Date: Tue, 15 Nov 2011 15:51:42 +0200 [thread overview]
Message-ID: <4EC26E6E.4030805@redhat.com> (raw)
In-Reply-To: <4EC26CB8.5020508@us.ibm.com>
On 11/15/2011 03:44 PM, Anthony Liguori wrote:
> 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
>
Does markdown support rendering into man pages?
A similar alternative is asciidoc, which is used by git.
--
error compiling committee.c: too many arguments to function
next prev parent reply other threads:[~2011-11-15 13:51 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-11-14 22:41 [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown Anthony Liguori
2011-11-14 22:41 ` [Qemu-devel] [PATCH 1/5] docs: convert qed_spec.txt " Anthony Liguori
2011-11-14 22:41 ` [Qemu-devel] [PATCH 2/5] docs: convert qcow2 specification " Anthony Liguori
2011-11-14 22:41 ` [Qemu-devel] [PATCH 3/5] docs: convert ivshmem device spec " Anthony Liguori
2011-11-14 22:41 ` [Qemu-devel] [PATCH 4/5] docs: convert acpi_pci_hotplug " Anthony Liguori
2011-11-14 22:41 ` [Qemu-devel] [PATCH 5/5] docs: add readme to specifications directory Anthony Liguori
2011-11-15 6:07 ` [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown Stefan Weil
2011-11-15 8:28 ` Avi Kivity
2011-11-15 13:44 ` Anthony Liguori
2011-11-15 13:51 ` Avi Kivity [this message]
2011-11-15 13:56 ` Alex Bradbury
2011-11-15 17:25 ` Stefano Stabellini
2011-11-15 14:49 ` Anthony Liguori
2011-11-15 18:06 ` Stefan Weil
2011-11-15 19:00 ` Anthony Liguori
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=4EC26E6E.4030805@redhat.com \
--to=avi@redhat.com \
--cc=aliguori@us.ibm.com \
--cc=qemu-devel@nongnu.org \
/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).