| Message ID | 1468917259-8475-10-git-send-email-pbonzini@redhat.com |
|---|---|
| State | New |
| Headers | show |
On Tue, Jul 19, 2016 at 10:34:16AM +0200, Paolo Bonzini wrote: > From: Pranith Kumar <bobby.prani@gmail.com> > > Move the README file to markdown so that it makes the github page look > prettier. I know that github repo is a mirror and not the official > repo, but I think it doesn't hurt to have it in markdown format. > > Signed-off-by: Pranith Kumar <bobby.prani@gmail.com> > Message-Id: <20160715043111.29007-1-bobby.prani@gmail.com> > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> > --- > README => README.md | 41 ++++++++++++++++++++--------------------- > 1 file changed, 20 insertions(+), 21 deletions(-) > rename README => README.md (85%) This has broken checkpatch.pl I'm afraid $ git show 724b36ac355895953662d3ba41901873d66c0679 | perl ./scripts/checkpatch.pl - Must be run from the top-level dir. of a kernel tree It seems "README" is one of the filenames checkpatch.pl requirs to be present. Regards, Daniel
On Tue, Jul 19, 2016 at 11:49 AM, Daniel P. Berrange <berrange@redhat.com> wrote: > On Tue, Jul 19, 2016 at 10:34:16AM +0200, Paolo Bonzini wrote: >> From: Pranith Kumar <bobby.prani@gmail.com> >> >> Move the README file to markdown so that it makes the github page look >> prettier. I know that github repo is a mirror and not the official >> repo, but I think it doesn't hurt to have it in markdown format. >> >> Signed-off-by: Pranith Kumar <bobby.prani@gmail.com> >> Message-Id: <20160715043111.29007-1-bobby.prani@gmail.com> >> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> >> --- >> README => README.md | 41 ++++++++++++++++++++--------------------- >> 1 file changed, 20 insertions(+), 21 deletions(-) >> rename README => README.md (85%) > > This has broken checkpatch.pl I'm afraid > > $ git show 724b36ac355895953662d3ba41901873d66c0679 | perl ./scripts/checkpatch.pl - > Must be run from the top-level dir. of a kernel tree > > > It seems "README" is one of the filenames checkpatch.pl requirs to > be present. > Hmm, my mistake. I thought changing README would not require running checkpatch since we are not touching any source. I wonder why that requirement exists.
On 19 July 2016 at 19:15, Pranith Kumar <bobby.prani@gmail.com> wrote: > On Tue, Jul 19, 2016 at 11:49 AM, Daniel P. Berrange > <berrange@redhat.com> wrote: >> On Tue, Jul 19, 2016 at 10:34:16AM +0200, Paolo Bonzini wrote: >>> From: Pranith Kumar <bobby.prani@gmail.com> >>> >>> Move the README file to markdown so that it makes the github page look >>> prettier. I know that github repo is a mirror and not the official >>> repo, but I think it doesn't hurt to have it in markdown format. >>> >>> Signed-off-by: Pranith Kumar <bobby.prani@gmail.com> >>> Message-Id: <20160715043111.29007-1-bobby.prani@gmail.com> >>> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> >>> --- >>> README => README.md | 41 ++++++++++++++++++++--------------------- >>> 1 file changed, 20 insertions(+), 21 deletions(-) >>> rename README => README.md (85%) >> >> This has broken checkpatch.pl I'm afraid >> >> $ git show 724b36ac355895953662d3ba41901873d66c0679 | perl ./scripts/checkpatch.pl - >> Must be run from the top-level dir. of a kernel tree >> >> >> It seems "README" is one of the filenames checkpatch.pl requirs to >> be present. >> > > Hmm, my mistake. I thought changing README would not require running > checkpatch since we are not touching any source. > > I wonder why that requirement exists. checkpatch is trying to determine whether you've run it from the right directory, so it just looks for some files we know to exist in the QEMU source tree. It doesn't try to do anything with them. thanks -- PMM
diff --git a/README b/README.md similarity index 85% rename from README rename to README.md index f38193f..99da481 100644 --- a/README +++ b/README.md @@ -1,5 +1,5 @@ - QEMU README - =========== +QEMU +--- QEMU is a generic and open source machine & userspace emulator and virtualizer. @@ -31,31 +31,31 @@ version 2. For full licensing details, consult the LICENSE file. Building -======== +--- QEMU is multi-platform software intended to be buildable on all modern Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety of other UNIX targets. The simple steps to build QEMU are: - mkdir build - cd build - ../configure - make + mkdir build + cd build + ../configure + make Complete details of the process for building and configuring QEMU for all supported host platforms can be found in the qemu-tech.html file. Additional information can also be found online via the QEMU website: - http://qemu-project.org/Hosts/Linux - http://qemu-project.org/Hosts/W32 + http://qemu-project.org/Hosts/Linux + http://qemu-project.org/Hosts/W32 Submitting patches -================== +--- The QEMU source code is maintained under the GIT version control system. - git clone git://git.qemu-project.org/qemu.git + git clone git://git.qemu-project.org/qemu.git When submitting patches, the preferred approach is to use 'git format-patch' and/or 'git send-email' to format & send the mail to the @@ -66,18 +66,18 @@ guidelines set out in the HACKING and CODING_STYLE files. Additional information on submitting patches can be found online via the QEMU website - http://qemu-project.org/Contribute/SubmitAPatch - http://qemu-project.org/Contribute/TrivialPatches + http://qemu-project.org/Contribute/SubmitAPatch + http://qemu-project.org/Contribute/TrivialPatches Bug reporting -============= +--- The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs found when running code built from QEMU git or upstream released sources should be reported via: - https://bugs.launchpad.net/qemu/ + https://bugs.launchpad.net/qemu/ If using QEMU via an operating system vendor pre-built binary package, it is preferable to report bugs to the vendor's own bug tracker first. If @@ -86,22 +86,21 @@ reported via launchpad. For additional information on bug reporting consult: - http://qemu-project.org/Contribute/ReportABug + http://qemu-project.org/Contribute/ReportABug Contact -======= +--- The QEMU community can be contacted in a number of ways, with the two main methods being email and IRC - - qemu-devel@nongnu.org - http://lists.nongnu.org/mailman/listinfo/qemu-devel - - #qemu on irc.oftc.net + - Mailing List: qemu-devel@nongnu.org + - Archives: http://lists.nongnu.org/mailman/listinfo/qemu-devel + - IRC: #qemu on irc.oftc.net Information on additional methods of contacting the community can be found online via the QEMU website: http://qemu-project.org/Contribute/StartHere --- End