mbox series

[0/4] Reformatted INFO files to fit the Markdown (.md) format.

Message ID 20180902123608.124586-1-ybettan@redhat.com (mailing list archive)
Headers show
Series Reformatted INFO files to fit the Markdown (.md) format. | expand

Message

Yoni Bettan Sept. 2, 2018, 12:36 p.m. UTC 
This patch make INFO files (e.g. README, CODING_STYLE etc) much more
readable when watched from GitHub GUI.

./VERSION and ./MAINTAINERS were leave untouched otherwise
./scripts/get_maintainer.pl breaks.

./COPYING and ./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.
NOTE:
This last part of the message should be removed from the commit message
since I will remove the 'md' brance from my fork if the patch is
accepted.

Yoni Bettan (4):
  README.md : Reformatted to fit the Markdown (.md) format.
  CODING_STYLE.md : Reformatted to fit the Markdown (.md) format.
  HACKING.md : Reformatted to fit the Markdown (.md) format.
  LICENSE.md : Reformatted to fit the Markdown (.md) format.

 CODING_STYLE => CODING_STYLE.md | 151 ++++++++++++++------------
 HACKING => HACKING.md           | 186 +++++++++++++++++---------------
 LICENSE => LICENSE.md           |   4 +-
 README => README.md             |  87 +++++++--------
 4 files changed, 224 insertions(+), 204 deletions(-)
 rename CODING_STYLE => CODING_STYLE.md (50%)
 rename HACKING => HACKING.md (53%)
 rename LICENSE => LICENSE.md (90%)
 rename README => README.md (68%)

Comments

Peter Maydell Sept. 2, 2018, 5:13 p.m. UTC | #1 
On 2 September 2018 at 13:36, Yoni Bettan <ybettan@redhat.com> wrote:
> This patch make INFO files (e.g. README, CODING_STYLE etc) much more
> readable when watched from GitHub GUI.
>
> ./VERSION and ./MAINTAINERS were leave untouched otherwise
> ./scripts/get_maintainer.pl breaks.
>
> ./COPYING and ./COPYING.LIB were leave untouched because it look likes
> they come from GNU and not QEMU.

Thanks for this patch, but we don't use Markdown format.
We use RST for docs files, but README, CODING_STYLE, etc
are just plain text and fine as they are I think.

-- PMM
Yoni Bettan Sept. 2, 2018, 5:59 p.m. UTC | #2 
On 9/2/18 8:13 PM, Peter Maydell wrote:
> On 2 September 2018 at 13:36, Yoni Bettan <ybettan@redhat.com> wrote:
>> This patch make INFO files (e.g. README, CODING_STYLE etc) much more
>> readable when watched from GitHub GUI.
>>
>> ./VERSION and ./MAINTAINERS were leave untouched otherwise
>> ./scripts/get_maintainer.pl breaks.
>>
>> ./COPYING and ./COPYING.LIB were leave untouched because it look likes
>> they come from GNU and not QEMU.
> Thanks for this patch, but we don't use Markdown format.
> We use RST for docs files, but README, CODING_STYLE, etc
> are just plain text and fine as they are I think.

Thanks for your reply.
I sent a V2 patch before I have noticed your response so if you could 
please copy your response to the V2 mail I will appreciate it.

Thanks,
Yoni
>
> -- PMM
Yoni Bettan Sept. 2, 2018, 6 p.m. UTC | #3 
Please ignore this message as a V2 was already sent.


Thanks,

Yoni.


On 9/2/18 3:36 PM, Yoni Bettan wrote:
> This patch make INFO files (e.g. README, CODING_STYLE etc) much more
> readable when watched from GitHub GUI.
>
> ./VERSION and ./MAINTAINERS were leave untouched otherwise
> ./scripts/get_maintainer.pl breaks.
>
> ./COPYING and ./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.
> NOTE:
> This last part of the message should be removed from the commit message
> since I will remove the 'md' brance from my fork if the patch is
> accepted.
>
> Yoni Bettan (4):
>    README.md : Reformatted to fit the Markdown (.md) format.
>    CODING_STYLE.md : Reformatted to fit the Markdown (.md) format.
>    HACKING.md : Reformatted to fit the Markdown (.md) format.
>    LICENSE.md : Reformatted to fit the Markdown (.md) format.
>
>   CODING_STYLE => CODING_STYLE.md | 151 ++++++++++++++------------
>   HACKING => HACKING.md           | 186 +++++++++++++++++---------------
>   LICENSE => LICENSE.md           |   4 +-
>   README => README.md             |  87 +++++++--------
>   4 files changed, 224 insertions(+), 204 deletions(-)
>   rename CODING_STYLE => CODING_STYLE.md (50%)
>   rename HACKING => HACKING.md (53%)
>   rename LICENSE => LICENSE.md (90%)
>   rename README => README.md (68%)
>