* [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl @ 2016-07-20 7:27 Fam Zheng 2016-07-20 9:16 ` Stefan Hajnoczi 2016-07-20 10:36 ` Peter Maydell 0 siblings, 2 replies; 8+ messages in thread From: Fam Zheng @ 2016-07-20 7:27 UTC (permalink / raw) To: qemu-devel Cc: Paolo Bonzini, Stefan Weil, Peter Maydell, Pranith Kumar, Markus Armbruster 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. Reported-by: Daniel P. Berrange <berrange@redhat.com> Signed-off-by: Fam Zheng <famz@redhat.com> --- README | 1 + 1 file changed, 1 insertion(+) create mode 120000 README diff --git a/README b/README new file mode 120000 index 0000000..42061c0 --- /dev/null +++ b/README @@ -0,0 +1 @@ +README.md \ No newline at end of file -- 2.7.4 ^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 7:27 [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl Fam Zheng @ 2016-07-20 9:16 ` Stefan Hajnoczi 2016-07-20 10:36 ` Peter Maydell 1 sibling, 0 replies; 8+ messages in thread From: Stefan Hajnoczi @ 2016-07-20 9:16 UTC (permalink / raw) To: Fam Zheng Cc: qemu-devel, Peter Maydell, Paolo Bonzini, Pranith Kumar, Markus Armbruster, Stefan Weil [-- Attachment #1: Type: text/plain, Size: 795 bytes --] On Wed, Jul 20, 2016 at 03:27:05PM +0800, Fam Zheng 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. > > Reported-by: Daniel P. Berrange <berrange@redhat.com> > Signed-off-by: Fam Zheng <famz@redhat.com> > --- > README | 1 + > 1 file changed, 1 insertion(+) > create mode 120000 README > > diff --git a/README b/README > new file mode 120000 For anyone wondering what happens on Windows hosts: On some Windows hosts this file will simply contain the path to README.md. This seems okay-ish. Stefan [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 473 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 7:27 [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl Fam Zheng 2016-07-20 9:16 ` Stefan Hajnoczi @ 2016-07-20 10:36 ` Peter Maydell 2016-07-20 10:42 ` Daniel P. Berrange 2016-07-20 10:48 ` Stefan Weil 1 sibling, 2 replies; 8+ messages in thread From: Peter Maydell @ 2016-07-20 10:36 UTC (permalink / raw) To: Fam Zheng Cc: QEMU Developers, Paolo Bonzini, Stefan Weil, Pranith Kumar, Markus Armbruster On 20 July 2016 at 08:27, Fam Zheng <famz@redhat.com> 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 10:36 ` Peter Maydell @ 2016-07-20 10:42 ` Daniel P. Berrange 2016-07-20 10:48 ` Stefan Weil 1 sibling, 0 replies; 8+ messages in thread From: Daniel P. Berrange @ 2016-07-20 10:42 UTC (permalink / raw) To: Peter Maydell Cc: Fam Zheng, Paolo Bonzini, Pranith Kumar, QEMU Developers, Markus Armbruster, Stefan Weil On Wed, Jul 20, 2016 at 11:36:36AM +0100, Peter Maydell wrote: > On 20 July 2016 at 08:27, Fam Zheng <famz@redhat.com> 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? Should be fine https://www.kernel.org/pub/software/scm/git/docs/git-config.html "core.symlinks If false, symbolic links are checked out as small plain files that contain the link text. git-update-index(1) and git-add(1) will not change the recorded type to regular file. Useful on filesystems like FAT that do not support symbolic links. The default is true, except git-clone(1) or git-init(1) will probe and set core.symlinks false if appropriate when the repository is created." IOW, git will just "do the right thing" and automatically default core.symlinks to false on FAT. 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 :| ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 10:36 ` Peter Maydell 2016-07-20 10:42 ` Daniel P. Berrange @ 2016-07-20 10:48 ` Stefan Weil 2016-07-20 12:31 ` Eric Blake 1 sibling, 1 reply; 8+ messages in thread From: Stefan Weil @ 2016-07-20 10:48 UTC (permalink / raw) To: Peter Maydell, Fam Zheng Cc: Paolo Bonzini, Pranith Kumar, QEMU Developers, Markus Armbruster Am 20.07.2016 um 12:36 schrieb Peter Maydell: > On 20 July 2016 at 08:27, Fam Zheng <famz@redhat.com> 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 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. 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 10:48 ` Stefan Weil @ 2016-07-20 12:31 ` Eric Blake 2016-07-20 18:07 ` John Snow 0 siblings, 1 reply; 8+ messages in thread From: Eric Blake @ 2016-07-20 12:31 UTC (permalink / raw) To: Stefan Weil, Peter Maydell, Fam Zheng Cc: Paolo Bonzini, Pranith Kumar, QEMU Developers, Markus Armbruster [-- Attachment #1: Type: text/plain, Size: 1898 bytes --] 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 <famz@redhat.com> 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 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 > > -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org [-- Attachment #2: OpenPGP digital signature --] [-- Type: application/pgp-signature, Size: 604 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 12:31 ` Eric Blake @ 2016-07-20 18:07 ` John Snow 2016-07-20 18:35 ` Stefan Weil 0 siblings, 1 reply; 8+ messages in thread From: John Snow @ 2016-07-20 18:07 UTC (permalink / raw) To: Eric Blake, Stefan Weil, Peter Maydell, Fam Zheng Cc: Paolo Bonzini, Pranith Kumar, QEMU Developers, Markus Armbruster 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 <famz@redhat.com> 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 >> >> > ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl 2016-07-20 18:07 ` John Snow @ 2016-07-20 18:35 ` Stefan Weil 0 siblings, 0 replies; 8+ messages in thread From: Stefan Weil @ 2016-07-20 18:35 UTC (permalink / raw) To: John Snow, Eric Blake, Peter Maydell, Fam Zheng Cc: Paolo Bonzini, Pranith Kumar, QEMU Developers, Markus Armbruster On 07/20/16 20:07, John Snow wrote: > 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 <famz@redhat.com> 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? Well, I don't know whether GitHub will always do the right thing, but in this case it does, see my test here: https://github.com/stweil/qemu/tree/readme Stefan ^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2016-07-20 18:35 UTC | newest] Thread overview: 8+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2016-07-20 7:27 [Qemu-devel] [PATCH] Symlink README.md as README to unbreak checkpatch.pl Fam Zheng 2016-07-20 9:16 ` Stefan Hajnoczi 2016-07-20 10:36 ` Peter Maydell 2016-07-20 10:42 ` Daniel P. Berrange 2016-07-20 10:48 ` Stefan Weil 2016-07-20 12:31 ` Eric Blake 2016-07-20 18:07 ` John Snow 2016-07-20 18:35 ` Stefan Weil
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).