From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:43681) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eq94s-0001vo-Oh for qemu-devel@nongnu.org; Sun, 25 Feb 2018 22:03:47 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eq94r-00036E-Nk for qemu-devel@nongnu.org; Sun, 25 Feb 2018 22:03:46 -0500 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:60842 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 1eq94r-00035a-Iv for qemu-devel@nongnu.org; Sun, 25 Feb 2018 22:03:45 -0500 From: Fam Zheng Date: Mon, 26 Feb 2018 11:03:26 +0800 Message-Id: <20180226030326.20219-3-famz@redhat.com> In-Reply-To: <20180226030326.20219-1-famz@redhat.com> References: <20180226030326.20219-1-famz@redhat.com> Subject: [Qemu-devel] [PATCH v4 2/2] README: Document 'git-publish' workflow List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: marcandre.lureau@gmail.com, f4bug@amsat.org, stefanha@redhat.com, pbonzini@redhat.com, eblake@redhat.com, mdroth@linux.vnet.ibm.com Signed-off-by: Fam Zheng --- README | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README b/README index 2c8e1c8cc4..7833b97365 100644 --- a/README +++ b/README @@ -56,7 +56,7 @@ The QEMU source code is maintained under the GIT version control system. git clone git://git.qemu.org/qemu.git -When submitting patches, the preferred approach is to use 'git +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 @@ -73,6 +73,35 @@ The QEMU website is also maintained under source control. git clone git://git.qemu.org/qemu-web.git https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/ +A 'git-profile' 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 +automate everything, so you may want to go through the above steps +manually for once. + +For installation instructions, please go to + + https://github.com/stefanha/git-publish + +The workflow with 'git-publish' is: + + $ git checkout master -b my-feature + $ # work on new commits, add your 'Signed-off-by' lines to each + $ git publish + +Your patch series will be sent and tagged as my-feature-v1 if you need to refer +back to it in the future. + +Sending v2: + + $ git checkout my-feature # same topic branch + $ # making changes to the commits (using 'git rebase', for example) + $ git publish + +Your patch series will be sent with 'v2' tag in the subject and the git tip +will be tagged as my-feature-v2. + Bug reporting ============= -- 2.14.3