[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 6/6] README: Document 'git-publish' workflow
From: |
Stefan Hajnoczi |
Subject: |
[Qemu-devel] [PULL 6/6] README: Document 'git-publish' workflow |
Date: |
Mon, 5 Mar 2018 09:40:06 +0000 |
From: Fam Zheng <address@hidden>
Signed-off-by: Fam Zheng <address@hidden>
Message-id: address@hidden
Signed-off-by: Stefan Hajnoczi <address@hidden>
---
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
address@hidden 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
- [Qemu-devel] [PULL 0/6] Block patches, Stefan Hajnoczi, 2018/03/05
- [Qemu-devel] [PULL 4/6] tests/libqos: Check for valid dev pointer when looking for PCI devices, Stefan Hajnoczi, 2018/03/05
- [Qemu-devel] [PULL 2/6] util/uri.c: remove brackets that wrap `return` statement's content., Stefan Hajnoczi, 2018/03/05
- [Qemu-devel] [PULL 5/6] Add a git-publish configuration file, Stefan Hajnoczi, 2018/03/05
- [Qemu-devel] [PULL 3/6] util/uri.c: wrap single statement blocks with braces {}, Stefan Hajnoczi, 2018/03/05
- [Qemu-devel] [PULL 6/6] README: Document 'git-publish' workflow,
Stefan Hajnoczi <=
- [Qemu-devel] [PULL 1/6] util/uri.c: Coding style check, Only whitespace involved, Stefan Hajnoczi, 2018/03/05
- Re: [Qemu-devel] [PULL 0/6] Block patches, no-reply, 2018/03/05
- Re: [Qemu-devel] [PULL 0/6] Block patches, Peter Maydell, 2018/03/05