[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown
From: |
Avi Kivity |
Subject: |
Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown |
Date: |
Tue, 15 Nov 2011 15:51:42 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:7.0.1) Gecko/20110930 Thunderbird/7.0.1 |
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
- [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown, Anthony Liguori, 2011/11/14
- [Qemu-devel] [PATCH 2/5] docs: convert qcow2 specification to markdown, Anthony Liguori, 2011/11/14
- [Qemu-devel] [PATCH 5/5] docs: add readme to specifications directory, Anthony Liguori, 2011/11/14
- [Qemu-devel] [PATCH 1/5] docs: convert qed_spec.txt to markdown, Anthony Liguori, 2011/11/14
- [Qemu-devel] [PATCH 3/5] docs: convert ivshmem device spec to markdown, Anthony Liguori, 2011/11/14
- [Qemu-devel] [PATCH 4/5] docs: convert acpi_pci_hotplug to markdown, Anthony Liguori, 2011/11/14
- Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown, Stefan Weil, 2011/11/15
- Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown, Avi Kivity, 2011/11/15
- Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown, Stefan Weil, 2011/11/15
- Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown, Anthony Liguori, 2011/11/15