qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Daniel P. Berrangé" <berrange@redhat.com>
To: Yoni Bettan <ybettan@redhat.com>
Cc: qemu-devel@nongnu.org, ehabkost@redhat.com, stefanha@redhat.com
Subject: Re: [Qemu-devel] [PATCH V2 0/3] Formatted INFO files to fit Markdown (.md) format.
Date: Mon, 3 Sep 2018 10:45:50 +0100	[thread overview]
Message-ID: <20180903094550.GB3467@redhat.com> (raw)
In-Reply-To: <20180902175401.8195-1-ybettan@redhat.com>

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 :|

  parent reply	other threads:[~2018-09-03  9:46 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-02 17:53 [Qemu-devel] [PATCH V2 0/3] Formatted INFO files to fit Markdown (.md) format Yoni Bettan
2018-09-02 17:53 ` [Qemu-devel] [PATCH V2 1/3] README.md : Formatted " Yoni Bettan
2018-09-03  9:43   ` Daniel P. Berrangé
2018-09-02 17:54 ` [Qemu-devel] [PATCH V2 2/3] CODING_STYLE.md " Yoni Bettan
2018-09-02 17:54 ` [Qemu-devel] [PATCH V2 3/3] HACKING.md " Yoni Bettan
2018-09-03  9:45 ` Daniel P. Berrangé [this message]
2018-09-04 19:44 ` [Qemu-devel] [PATCH V2 0/3] Formatted INFO files " Eric Blake

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=20180903094550.GB3467@redhat.com \
    --to=berrange@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    --cc=ybettan@redhat.com \
    /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).