Re: [Qemu-devel] [PATCH V2 0/3] Formatted INFO files to fit Markdown (.md) format.

[Daniel P . Berrangé]

On Sun, Sep 02, 2018 at 08:53:58PM +0300, Yoni Bettan wrote:
> This patch make INFO files (e.g. README, CODING_STYLE and HACKING) much more
> readable when watched from GitHub GUI.
> 
> ./VERSION, ./MAINTAINERS were leave untouched otherwise
> ./scripts/get_maintainer.pl breaks.
> 
> ./COPYING, ./LICENSE ./COPYING.LIB were leave untouched because it look likes
> they come from GNU and not QEMU. 
> 
> Visualization of the change can be found at
> https://github.com/ybettan/qemu/tree/md.

As Peter mentioned on v1, QEMU has decided on using RST for docs, so I agree
with him that adding Markdown is not desirable.

As you can see from existing docs, GitHub knows how to display RST nicely
already:

  https://github.com/ybettan/qemu/blob/md/docs/pr-manager.rst

So if we did want to change these files, we should stick with RST.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|