Re: [Qemu-devel] [PATCH] Fix regressions caused by renaming README

[Markus Armbruster <armbru@redhat.com>]

Peter Maydell <peter.maydell@linaro.org> writes:

> On 19 July 2016 at 22:17, Pranith Kumar <bobby.prani@gmail.com> wrote:
>> On Tue, Jul 19, 2016 at 4:53 PM, Peter Maydell <peter.maydell@linaro.org> wrote:
>>> Does raise the question of whether we should be renaming
>>> the file in the first place. README is the traditional
>>> name and fits with all our other basically-plain-text
>>> document names like COPYING, MAINTAINERS, HACKING.
>>>
>>
>> I was hoping that this change would be helpful since mark
>> down(at-least the way we have it) still looks like plain text if you
>> open in a text editor. The advantage is that github repositories look
>> way better since mark down is formatted well there. I am open to
>> getting it reverted if it really is bothering.
>
> On the other hand we don't use github as our primary git
> repo, and we don't try to render the markdown anywhere
> in our build process. The documentation really is a
> plain text file in my view, and I'm not hugely enthusiastic
> about switching the filename to placate a website we
> don't even use except as a backup/mirror.

I'd less unenthusiastic if MarkDown worked the same everywhere.  Its
common core does, but how would we ensure we stick to the common core?
How would we even know what the core common to the various MarkDown
dialects is?  Or are we ready to commit to GitHub's dialect?