From nobody Wed Nov 5 18:27:52 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1535911127887822.7477109769726; Sun, 2 Sep 2018 10:58:47 -0700 (PDT) Received: from localhost ([::1]:41953 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fwWe1-00010I-KI for importer@patchew.org; Sun, 02 Sep 2018 13:58:41 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41170) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fwWZs-0005pg-Qs for qemu-devel@nongnu.org; Sun, 02 Sep 2018 13:54:27 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fwWZo-0002ic-RO for qemu-devel@nongnu.org; Sun, 02 Sep 2018 13:54:22 -0400 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:34416 helo=mx1.redhat.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fwWZl-0002dH-0n for qemu-devel@nongnu.org; Sun, 02 Sep 2018 13:54:18 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 1C389804B9F1 for ; Sun, 2 Sep 2018 17:54:14 +0000 (UTC) Received: from localhost.localdomain (unknown [10.35.206.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id 047722027EA5; Sun, 2 Sep 2018 17:54:12 +0000 (UTC) From: Yoni Bettan To: qemu-devel@nongnu.org Date: Sun, 2 Sep 2018 20:53:59 +0300 Message-Id: <20180902175401.8195-2-ybettan@redhat.com> In-Reply-To: <20180902175401.8195-1-ybettan@redhat.com> References: <20180902175401.8195-1-ybettan@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.8]); Sun, 02 Sep 2018 17:54:14 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.8]); Sun, 02 Sep 2018 17:54:14 +0000 (UTC) for IP:'10.11.54.4' DOMAIN:'int-mx04.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'ybettan@redhat.com' RCPT:'' X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 66.187.233.73 Subject: [Qemu-devel] [PATCH V2 1/3] README.md : Formatted to fit Markdown (.md) format. X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Yoni Bettan , ehabkost@redhat.com, stefanha@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RDMRC_1 RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Also updated scripts/checkpatch.pl and made it reference to README.md instead of README. Signed-off-by: Yoni Bettan --- README =3D> README.md | 89 ++++++++++++++++++++++--------------------- scripts/checkpatch.pl | 2 +- 2 files changed, 46 insertions(+), 45 deletions(-) rename README =3D> README.md (67%) diff --git a/README b/README.md similarity index 67% rename from README rename to README.md index 49a9fd09cd..5fc06dcf8a 100644 --- a/README +++ b/README.md @@ -1,5 +1,4 @@ - QEMU README - =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +# Qemu =20 QEMU is a generic and open source machine & userspace emulator and virtualizer. @@ -27,89 +26,93 @@ It is commonly invoked indirectly via the libvirt libra= ry when using open source applications such as oVirt, OpenStack and virt-manager. =20 QEMU as a whole is released under the GNU General Public License, -version 2. For full licensing details, consult the LICENSE file. +version 2. For full licensing details, consult the [LICENSE](LICENSE) file. =20 =20 -Building -=3D=3D=3D=3D=3D=3D=3D=3D +## Building =20 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: =20 - mkdir build - cd build - ../configure - make +``` +mkdir build +cd build +../configure +make +``` =20 Additional information can also be found online via the QEMU website: =20 - https://qemu.org/Hosts/Linux - https://qemu.org/Hosts/Mac - https://qemu.org/Hosts/W32 +* https://qemu.org/Hosts/Linux +* https://qemu.org/Hosts/Mac +* https://qemu.org/Hosts/W32 =20 =20 -Submitting patches -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +## Submitting patches =20 The QEMU source code is maintained under the GIT version control system. =20 - git clone git://git.qemu.org/qemu.git +`git clone git://git.qemu.org/qemu.git` =20 -When submitting patches, one common approach is to use 'git -format-patch' and/or 'git send-email' to format & send the mail to the -qemu-devel@nongnu.org mailing list. All patches submitted must contain -a 'Signed-off-by' line from the author. Patches should follow the -guidelines set out in the HACKING and CODING_STYLE files. +When submitting patches, one common approach is to use `git format-patch` +and/or `git send-email` to format & send the mail to the +[qemu-devel@nongnu.org](https://lists.nongnu.org/mailman/listinfo/qemu-dev= el) +mailing list. All patches submitted must contain a 'Signed-off-by' line fr= om +the author. Patches should follow the guidelines set out in the +[HACKING.md](HACKING.md) and [CODING_STYLE.md](CODING_STYLE.md) files. =20 Additional information on submitting patches can be found online via the QEMU website =20 - https://qemu.org/Contribute/SubmitAPatch - https://qemu.org/Contribute/TrivialPatches +* https://qemu.org/Contribute/SubmitAPatch +* https://qemu.org/Contribute/TrivialPatches =20 The QEMU website is also maintained under source control. =20 - git clone git://git.qemu.org/qemu-web.git - https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/ +`git clone git://git.qemu.org/qemu-web.git` +* https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/ =20 -A 'git-publish' utility was created to make above process less +A `git-publish` utility was created to make above process less cumbersome, and is highly recommended for making regular contributions, or even just for sending consecutive patch series revisions. It also -requires a working 'git send-email' setup, and by default doesn't +requires a working `git send-email` setup, and by default doesn't automate everything, so you may want to go through the above steps manually for once. =20 For installation instructions, please go to =20 - https://github.com/stefanha/git-publish +* https://github.com/stefanha/git-publish =20 The workflow with 'git-publish' is: =20 - $ git checkout master -b my-feature - $ # work on new commits, add your 'Signed-off-by' lines to each - $ git publish +``` +git checkout master -b my-feature +# work on new commits, add your 'Signed-off-by' lines to each +git publish +``` =20 Your patch series will be sent and tagged as my-feature-v1 if you need to = refer back to it in the future. =20 Sending v2: =20 - $ git checkout my-feature # same topic branch - $ # making changes to the commits (using 'git rebase', for example) - $ git publish +``` +git checkout my-feature # same topic branch +# making changes to the commits (using 'git rebase', for example) +git publish +``` =20 Your patch series will be sent with 'v2' tag in the subject and the git tip will be tagged as my-feature-v2. =20 -Bug reporting -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +## Bug reporting =20 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: =20 - https://bugs.launchpad.net/qemu/ +* https://bugs.launchpad.net/qemu/ =20 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 @@ -118,22 +121,20 @@ reported via launchpad. =20 For additional information on bug reporting consult: =20 - https://qemu.org/Contribute/ReportABug +* https://qemu.org/Contribute/ReportABug =20 =20 -Contact -=3D=3D=3D=3D=3D=3D=3D +## Contact =20 The QEMU community can be contacted in a number of ways, with the two main methods being email and IRC =20 - - qemu-devel@nongnu.org - https://lists.nongnu.org/mailman/listinfo/qemu-devel - - #qemu on irc.oftc.net +* [qemu-devel@nongnu.org](https://lists.nongnu.org/mailman/listinfo/qemu-d= evel) +* #qemu on irc.oftc.net =20 Information on additional methods of contacting the community can be found online via the QEMU website: =20 - https://qemu.org/Contribute/StartHere +* https://qemu.org/Contribute/StartHere =20 --- End +## End diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 42e1c50dd8..55167e064e 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -407,7 +407,7 @@ sub top_of_kernel_tree { =20 my @tree_check =3D ( "COPYING", "MAINTAINERS", "Makefile", - "README", "docs", "VERSION", + "README.md", "docs", "VERSION", "vl.c" ); =20 --=20 2.17.1