From: Anthony Liguori <aliguori@us.ibm.com>
To: Stefan Weil <sw@weilnetz.de>
Cc: Avi Kivity <avi@redhat.com>, qemu-devel@nongnu.org
Subject: Re: [Qemu-devel] [PATCH 0/5] docs: convert specifications to markdown
Date: Tue, 15 Nov 2011 13:00:50 -0600 [thread overview]
Message-ID: <4EC2B6E2.8010603@us.ibm.com> (raw)
In-Reply-To: <4EC2AA14.3000106@weilnetz.de>
On 11/15/2011 12:06 PM, Stefan Weil wrote:
> Am 15.11.2011 14:44, schrieb 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 think high quality information beats pretty formatting any day. The problem I
see with our current documentation strategy is that it's very monolithic (one
big printed manual) and it's in a format that many people consider obscure.
I think small stand alone documents that are easy to author are going to result
in a better end user experience than one big document with pretty formatting.
Regards,
Anthony Liguori
> 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 parent reply other threads:[~2011-11-15 19:01 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
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 [this message]
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=4EC2B6E2.8010603@us.ibm.com \
--to=aliguori@us.ibm.com \
--cc=avi@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=sw@weilnetz.de \
/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).