diff mbox series

[v2,2/2] README: Document 'git-publish' workflow

Message ID 20180202063412.22466-3-famz@redhat.com
State New
Headers show
Series Add git-publish config file | expand

Commit Message

Fam Zheng Feb. 2, 2018, 6:34 a.m. UTC
Signed-off-by: Fam Zheng <famz@redhat.com>
---
 .gitpublish |  1 +
 README      | 30 +++++++++++++++++++++++++++++-
 2 files changed, 30 insertions(+), 1 deletion(-)

Comments

Michael Roth Feb. 5, 2018, 4:57 a.m. UTC | #1
Quoting Fam Zheng (2018-02-02 00:34:12)
> Signed-off-by: Fam Zheng <famz@redhat.com>
> ---
>  .gitpublish |  1 +
>  README      | 30 +++++++++++++++++++++++++++++-
>  2 files changed, 30 insertions(+), 1 deletion(-)
> 
> diff --git a/.gitpublish b/.gitpublish
> index 170bd2ed48..7542e878fc 100644
> --- a/.gitpublish
> +++ b/.gitpublish
> @@ -26,6 +26,7 @@ cccmd = scripts/get_maintainer.pl --noroles --norolestats --nogit --nogit-fallba
>  base = master
>  prefix = PATCH
>  to = qemu-devel@nongnu.org
> +cc = qemu-trivial@nongnu.org

I think you meant to squash this into patch 1?

>  cccmd = scripts/get_maintainer.pl --noroles --norolestats --nogit --nogit-fallback 2>/dev/null
> 
>  [gitpublishprofile "block"]
> diff --git a/README b/README
> index b92a07a61a..d1a944ce20 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
> @@ -68,6 +68,34 @@ the QEMU website
>    https://qemu.org/Contribute/SubmitAPatch
>    https://qemu.org/Contribute/TrivialPatches
> 
> +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
> 
>
diff mbox series

Patch

diff --git a/.gitpublish b/.gitpublish
index 170bd2ed48..7542e878fc 100644
--- a/.gitpublish
+++ b/.gitpublish
@@ -26,6 +26,7 @@  cccmd = scripts/get_maintainer.pl --noroles --norolestats --nogit --nogit-fallba
 base = master
 prefix = PATCH
 to = qemu-devel@nongnu.org
+cc = qemu-trivial@nongnu.org
 cccmd = scripts/get_maintainer.pl --noroles --norolestats --nogit --nogit-fallback 2>/dev/null
 
 [gitpublishprofile "block"]
diff --git a/README b/README
index b92a07a61a..d1a944ce20 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
@@ -68,6 +68,34 @@  the QEMU website
   https://qemu.org/Contribute/SubmitAPatch
   https://qemu.org/Contribute/TrivialPatches
 
+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
 =============