git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Konrad Rzeszutek Wilk]

Hey,

I wanted to ask what folks would think of expanding the Wiki to include (making it a diff
for simpler) this change. With my giant 30 set of patches that not only CC-ed
xen-devel twice but had some patches CC some maintainers but not others - I figured
it may be good to describe this in the Wiki:

--- orig	2016-02-15 10:45:27.719204371 -0500
+++ new	2016-02-15 10:58:33.113755665 -0500
@@ -140,7 +140,35 @@
 * The maintainers are listed in the MAINTAINERS file at the top of the Xen source tree. If no maintainer is listed then there is no need for a CC (if you are modifying code with no maintainer then you might like to consider becoming the maintainer for that piece of code!).
 ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool and it will list the relevant maintainers.
 * In addition to CCing the maintainer you should always send patches to (via TO) the xen-devel@lists.xenproject.org mailing list as well.
-* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
+* To add a CC when sending the mail you can:
+  * use the ''--cc'' option to the ''git send-email'' command - however if your
+    patchset is to multiple maintainers - you may end up sending all of the
+    patches to all maintainers  - where some of them have no interest in
+    viewing them (as they are not under their responsibility).
+  * edit each patch to have the proper maintainer on the CC list by adding:
+<pre>
+CC: joe@doe.com
+</pre>
+   in the patch.
+  * or alternatively use --cc-cmd in your .gitconfig:
+<pre>
+[sendemail]
+    cc-cmd = scripts/get_maintainer.pl --remove-duplicates --no-l
+</pre>
+which will automatically add the proper maintainer on the CC line.
+The ''no-l'' is to not add the mailing list to the CC (as you would
+be adding that via the TO - see above)
+  * or you can do it manually in your MUA.
+
+In short, it could look like this:
+<pre>
+$pwd
+/home/joedoe/xen
+git send-email --to xen-devel@lists.xenproject.org --to jo@doe.com --compose --subject "[PATCH v1] Fixes to frobnicator." *.patch
+</pre>
+
+Which will send all patches to yourself on the TO, to xen-devel mailiing list (on the TO:)
+and the patches will have their CC: list generated based on scripts/get_maintainer.pl.
 
 === Providing a git branch ===

Re: git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Andrew Cooper]

On 15/02/16 16:00, Konrad Rzeszutek Wilk wrote:
> Hey,
>
> I wanted to ask what folks would think of expanding the Wiki to include (making it a diff
> for simpler) this change. With my giant 30 set of patches that not only CC-ed
> xen-devel twice but had some patches CC some maintainers but not others - I figured
> it may be good to describe this in the Wiki:
>
> --- orig	2016-02-15 10:45:27.719204371 -0500
> +++ new	2016-02-15 10:58:33.113755665 -0500
> @@ -140,7 +140,35 @@
>  * The maintainers are listed in the MAINTAINERS file at the top of the Xen source tree. If no maintainer is listed then there is no need for a CC (if you are modifying code with no maintainer then you might like to consider becoming the maintainer for that piece of code!).
>  ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool and it will list the relevant maintainers.
>  * In addition to CCing the maintainer you should always send patches to (via TO) the xen-devel@lists.xenproject.org mailing list as well.
> -* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
> +* To add a CC when sending the mail you can:
> +  * use the ''--cc'' option to the ''git send-email'' command - however if your
> +    patchset is to multiple maintainers - you may end up sending all of the
> +    patches to all maintainers  - where some of them have no interest in
> +    viewing them (as they are not under their responsibility).
> +  * edit each patch to have the proper maintainer on the CC list by adding:
> +<pre>
> +CC: joe@doe.com

andrewcoop@andrewcoop:/local/xen.git/xen$ dig -t ANY doe.com
...
;; AUTHORITY SECTION:
doe.com.        3600    IN    NS    ns52.domaincontrol.com.
doe.com.        3600    IN    NS    ns51.domaincontrol.com.

;; ADDITIONAL SECTION:
ns51.domaincontrol.com.    73514    IN    A    216.69.185.26
ns51.domaincontrol.com.    56142    IN    AAAA    2607:f208:206::1a

I would use example.com instead.

Otherwise, looks good to me.

~Andrew

Re: git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Ian Campbell]

On Mon, 2016-02-15 at 16:04 +0000, Andrew Cooper wrote:
> andrewcoop@andrewcoop:/local/xen.git/xen$ dig -t ANY doe.com
> ...
> ;; AUTHORITY SECTION:
> doe.com.        3600    IN    NS    ns52.domaincontrol.com.
> doe.com.        3600    IN    NS    ns51.domaincontrol.com.
> 
> ;; ADDITIONAL SECTION:
> ns51.domaincontrol.com.    73514    IN    A    216.69.185.26
> ns51.domaincontrol.com.    56142    IN    AAAA    2607:f208:206::1a
> 
> I would use example.com instead.

RFC2606 and I agree.
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Roger Pau Monné]

El 15/2/16 a les 17:00, Konrad Rzeszutek Wilk ha escrit:
> Hey,
> 
> I wanted to ask what folks would think of expanding the Wiki to include (making it a diff
> for simpler) this change. With my giant 30 set of patches that not only CC-ed
> xen-devel twice but had some patches CC some maintainers but not others - I figured
> it may be good to describe this in the Wiki:
> 
> --- orig	2016-02-15 10:45:27.719204371 -0500
> +++ new	2016-02-15 10:58:33.113755665 -0500
> @@ -140,7 +140,35 @@
>  * The maintainers are listed in the MAINTAINERS file at the top of the Xen source tree. If no maintainer is listed then there is no need for a CC (if you are modifying code with no maintainer then you might like to consider becoming the maintainer for that piece of code!).
>  ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool and it will list the relevant maintainers.
>  * In addition to CCing the maintainer you should always send patches to (via TO) the xen-devel@lists.xenproject.org mailing list as well.
> -* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
> +* To add a CC when sending the mail you can:
> +  * use the ''--cc'' option to the ''git send-email'' command - however if your
> +    patchset is to multiple maintainers - you may end up sending all of the
> +    patches to all maintainers  - where some of them have no interest in
> +    viewing them (as they are not under their responsibility).
> +  * edit each patch to have the proper maintainer on the CC list by adding:
> +<pre>
> +CC: joe@doe.com

I'm not a maintainer/committer myself, but since we are spelling this
out, I think maintainers/committers prefer that the "Cc:" tags are
placed after a "---".

Roger.

Re: git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Jan Beulich]

>>> On 15.02.16 at 17:10, <roger.pau@citrix.com> wrote:
> El 15/2/16 a les 17:00, Konrad Rzeszutek Wilk ha escrit:
>> Hey,
>> 
>> I wanted to ask what folks would think of expanding the Wiki to include 
> (making it a diff
>> for simpler) this change. With my giant 30 set of patches that not only CC-ed
>> xen-devel twice but had some patches CC some maintainers but not others - I 
> figured
>> it may be good to describe this in the Wiki:
>> 
>> --- orig	2016-02-15 10:45:27.719204371 -0500
>> +++ new	2016-02-15 10:58:33.113755665 -0500
>> @@ -140,7 +140,35 @@
>>  * The maintainers are listed in the MAINTAINERS file at the top of the Xen 
> source tree. If no maintainer is listed then there is no need for a CC (if 
> you are modifying code with no maintainer then you might like to consider 
> becoming the maintainer for that piece of code!).
>>  ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool 
> and it will list the relevant maintainers.
>>  * In addition to CCing the maintainer you should always send patches to 
> (via TO) the xen-devel@lists.xenproject.org mailing list as well.
>> -* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
>> +* To add a CC when sending the mail you can:
>> +  * use the ''--cc'' option to the ''git send-email'' command - however if your
>> +    patchset is to multiple maintainers - you may end up sending all of the
>> +    patches to all maintainers  - where some of them have no interest in
>> +    viewing them (as they are not under their responsibility).
>> +  * edit each patch to have the proper maintainer on the CC list by adding:
>> +<pre>
>> +CC: joe@doe.com 
> 
> I'm not a maintainer/committer myself, but since we are spelling this
> out, I think maintainers/committers prefer that the "Cc:" tags are
> placed after a "---".

While I'm one of those who indeed does, I recall there having been
different views (derived from there being different view on whether
it is a good idea to retain these Cc-s in what gets committed).

Jan

Re: git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Konrad Rzeszutek Wilk]

On Mon, Feb 15, 2016 at 09:59:11AM -0700, Jan Beulich wrote:
> >>> On 15.02.16 at 17:10, <roger.pau@citrix.com> wrote:
> > El 15/2/16 a les 17:00, Konrad Rzeszutek Wilk ha escrit:
> >> Hey,
> >> 
> >> I wanted to ask what folks would think of expanding the Wiki to include 
> > (making it a diff
> >> for simpler) this change. With my giant 30 set of patches that not only CC-ed
> >> xen-devel twice but had some patches CC some maintainers but not others - I 
> > figured
> >> it may be good to describe this in the Wiki:
> >> 
> >> --- orig	2016-02-15 10:45:27.719204371 -0500
> >> +++ new	2016-02-15 10:58:33.113755665 -0500
> >> @@ -140,7 +140,35 @@
> >>  * The maintainers are listed in the MAINTAINERS file at the top of the Xen 
> > source tree. If no maintainer is listed then there is no need for a CC (if 
> > you are modifying code with no maintainer then you might like to consider 
> > becoming the maintainer for that piece of code!).
> >>  ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool 
> > and it will list the relevant maintainers.
> >>  * In addition to CCing the maintainer you should always send patches to 
> > (via TO) the xen-devel@lists.xenproject.org mailing list as well.
> >> -* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
> >> +* To add a CC when sending the mail you can:
> >> +  * use the ''--cc'' option to the ''git send-email'' command - however if your
> >> +    patchset is to multiple maintainers - you may end up sending all of the
> >> +    patches to all maintainers  - where some of them have no interest in
> >> +    viewing them (as they are not under their responsibility).
> >> +  * edit each patch to have the proper maintainer on the CC list by adding:
> >> +<pre>
> >> +CC: joe@doe.com 
> > 
> > I'm not a maintainer/committer myself, but since we are spelling this
> > out, I think maintainers/committers prefer that the "Cc:" tags are
> > placed after a "---".
> 
> While I'm one of those who indeed does, I recall there having been
> different views (derived from there being different view on whether
> it is a good idea to retain these Cc-s in what gets committed).
> 


How about:


--- orig	2016-02-15 10:45:27.719204371 -0500
+++ new	2016-02-19 11:57:34.827213537 -0500
@@ -140,7 +140,42 @@
 * The maintainers are listed in the MAINTAINERS file at the top of the Xen source tree. If no maintainer is listed then there is no need for a CC (if you are modifying code with no maintainer then you might like to consider becoming the maintainer for that piece of code!).
 ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool and it will list the relevant maintainers.
 * In addition to CCing the maintainer you should always send patches to (via TO) the xen-devel@lists.xenproject.org mailing list as well.
-* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
+* To add a CC when sending the mail you can:
+  * use the ''--cc'' option to the ''git send-email'' command - however if your
+    patchset is to multiple maintainers - you may end up sending all of the
+    patches to all maintainers  - where some of them have no interest in
+    viewing them (as they are not under their responsibility)
+  * edit each patch to have the proper maintainer on the CC list by adding:
+<pre>
+---
+CC: joe@example.com
+---
+</pre>
+   in the patch. The ''---'' means that when the patch is applied the text
+in between them is discarded.
+  * or alternatively use --cc-cmd in your .gitconfig or git-send-email:
+<pre>
+[sendemail]
+    cc-cmd = scripts/get_maintainer.pl --no-l
+</pre>
+or:
+<pre>
+git send-email --cc-cmd="scripts/get_maintainer.pl 
+</pre>
+which will automatically add the proper maintainer on the CC line.
+The ''no-l'' is to not add the mailing list to the CC (as you would
+be adding that via the TO - see above)
+  * or you can do it manually in your MUA.
+
+In short, it could look like this:
+<pre>
+$pwd
+/home/joe/xen
+git send-email --cc-cmd="scripts/get_maintainer.pl --no-l --to xen-devel@lists.xenproject.org --to jo@example.com --compose --subject "[PATCH v1] Fixes to frobnicator." *.patch
+</pre>
+
+Which will send all patches to yourself on the TO, to xen-devel mailiing list (on the TO:)
+and the patches will have their CC: list generated based on scripts/get_maintainer.pl.
 
 === Providing a git branch ===

Re: git workflow and http://wiki.xenproject.org/wiki/Submitting_Xen_Project_Patches

[Wei Liu]

On Mon, Feb 15, 2016 at 11:00:58AM -0500, Konrad Rzeszutek Wilk wrote:
> Hey,
> 
> I wanted to ask what folks would think of expanding the Wiki to include (making it a diff
> for simpler) this change. With my giant 30 set of patches that not only CC-ed
> xen-devel twice but had some patches CC some maintainers but not others - I figured
> it may be good to describe this in the Wiki:
> 
> --- orig	2016-02-15 10:45:27.719204371 -0500
> +++ new	2016-02-15 10:58:33.113755665 -0500
> @@ -140,7 +140,35 @@
>  * The maintainers are listed in the MAINTAINERS file at the top of the Xen source tree. If no maintainer is listed then there is no need for a CC (if you are modifying code with no maintainer then you might like to consider becoming the maintainer for that piece of code!).
>  ** You can pipe your patch to the <code>./scripts/get_maintainer.pl</code> tool and it will list the relevant maintainers.
>  * In addition to CCing the maintainer you should always send patches to (via TO) the xen-devel@lists.xenproject.org mailing list as well.
> -* To add a CC when sending the mail you can use the ''--cc'' option to the ''git send-email'' command, or you can do it manually in your MUA.
> +* To add a CC when sending the mail you can:
> +  * use the ''--cc'' option to the ''git send-email'' command - however if your
> +    patchset is to multiple maintainers - you may end up sending all of the
> +    patches to all maintainers  - where some of them have no interest in
> +    viewing them (as they are not under their responsibility).
> +  * edit each patch to have the proper maintainer on the CC list by adding:
> +<pre>
> +CC: joe@doe.com
> +</pre>
> +   in the patch.
> +  * or alternatively use --cc-cmd in your .gitconfig:

I wouldn't encourage people to put this in their global gitconfig
file.

It either needs to be in project local gitconfig .git/config or be
spelled out explicitly in command line.

Wei.

> +<pre>
> +[sendemail]
> +    cc-cmd = scripts/get_maintainer.pl --remove-duplicates --no-l
> +</pre>
> +which will automatically add the proper maintainer on the CC line.
> +The ''no-l'' is to not add the mailing list to the CC (as you would
> +be adding that via the TO - see above)
> +  * or you can do it manually in your MUA.
> +
> +In short, it could look like this:
> +<pre>
> +$pwd
> +/home/joedoe/xen
> +git send-email --to xen-devel@lists.xenproject.org --to jo@doe.com --compose --subject "[PATCH v1] Fixes to frobnicator." *.patch
> +</pre>
> +
> +Which will send all patches to yourself on the TO, to xen-devel mailiing list (on the TO:)
> +and the patches will have their CC: list generated based on scripts/get_maintainer.pl.
>  
>  === Providing a git branch ===
>  
> 
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xen.org
> http://lists.xen.org/xen-devel