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

["Daniel P. Berrange" <berrange@redhat.com>]

On Tue, Jul 19, 2016 at 09:53:30PM +0100, Peter Maydell wrote:
> On 19 July 2016 at 18:47, Stefan Weil <sw@weilnetz.de> wrote:
> > Commit e5dfc5e8e715c572aea44ac4d96c43941d4741c7 renamed README but did not
> > update scripts/checkpatch.pl. Fix this.
> >
> > An update was also needed for qemu.nsi (Windows).
> >
> > Reported-by: Daniel P. Berrange <berrange@redhat.com>
> > Signed-off-by: Stefan Weil <sw@weilnetz.de>
> > ---
> >  qemu.nsi              | 4 ++--
> >  scripts/checkpatch.pl | 2 +-
> >  2 files changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/qemu.nsi b/qemu.nsi
> > index a20f6ef..c037017 100644
> > --- a/qemu.nsi
> > +++ b/qemu.nsi
> > @@ -116,7 +116,7 @@ Section "${PRODUCT} (required)"
> >      File "${SRCDIR}\Changelog"
> >      File "${SRCDIR}\COPYING"
> >      File "${SRCDIR}\COPYING.LIB"
> > -    File "${SRCDIR}\README"
> > +    File "${SRCDIR}\README.md"
> >      File "${SRCDIR}\VERSION"
> >
> >      File "${BINDIR}\*.bmp"
> > @@ -206,7 +206,7 @@ Section "Uninstall"
> >      Delete "$INSTDIR\Changelog"
> >      Delete "$INSTDIR\COPYING"
> >      Delete "$INSTDIR\COPYING.LIB"
> > -    Delete "$INSTDIR\README"
> > +    Delete "$INSTDIR\README.md"
> >      Delete "$INSTDIR\VERSION"
> >      Delete "$INSTDIR\*.bmp"
> >      Delete "$INSTDIR\*.bin"
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > index afa7f79..8247305 100755
> > --- a/scripts/checkpatch.pl
> > +++ b/scripts/checkpatch.pl
> > @@ -286,7 +286,7 @@ sub top_of_kernel_tree {
> >
> >         my @tree_check = (
> >                 "COPYING", "MAINTAINERS", "Makefile",
> > -               "README", "docs", "VERSION",
> > +               "README.md", "docs", "VERSION",
> >                 "vl.c"
> >         );
> 
> 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.

As mentioned in my original review, we could just create a symlink
between READE & README.md or vica-verca if we wish to preserve the
"normal" filename, but still have github do its magic.

Regards,
Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|