qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpat


From: John Snow
Subject: Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl
Date: Wed, 20 Jul 2016 14:07:59 -0400
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.1.1


On 07/20/2016 08:31 AM, Eric Blake wrote:
> On 07/20/2016 04:48 AM, Stefan Weil wrote:
>> Am 20.07.2016 um 12:36 schrieb Peter Maydell:
>>> On 20 July 2016 at 08:27, Fam Zheng <address@hidden> wrote:
>>>> Commit e5dfc5e8e71 renamed README to README.md but
>>>> scripts/checkpatch.pl still looks for the old name to sanity check
>>>> that it's invoked from the toplevel of tree. Create a symbol link to
>>>> README.md to fix that. I've verified that on github README.md still
>>>> takes precedence and page is rendered. 
>>> Have you checked that the symlink does sensible things if the git tree
>>> is checked out under Windows? thanks -- PMM
>>
>>
>> ... and that the Windows installer will get a working README, not only a
>> symlink?
>> You could move README.md to README and link that to README.md
>> (as suggested by Paolo) - that would avoid such problems.
> 
> I would favor README as the real file, and README.md as the symlink. The

Will Github DTRT?

> Windows installer would pick up the real file, and github, where
> symlinks work, will render things just fine.  Making README the symlink
> risks the Windows installer picking up a file whose contents are
> "README.md", which is not what you want.
> 
>>
>> I suggest to revert the README rename for the coming new release.
>> It can be added again later, maybe with a few improvements like
>> those in my branch https://github.com/stweil/qemu/tree/readme.
> 
> It's just documentation, so we can still tweak it during hard freeze,
> but I agree that a revert is the most conservative approach.
> 
>>
>> For https://github.com/stweil/qemu/blob/readme/README.md,
>> I removed tab characters, used underlining which also looks
>> nice without markup formatting, used a uniform notification
>> for links (so that they actually work as links) and marked
>> code in the text.
>>
>> Stefan
>>
>>
> 




reply via email to

[Prev in Thread] Current Thread [Next in Thread]