[ovs-dev,ovn] submitting-patches: Update subject line format.
diff mbox series

Message ID 20200226125743.520295-1-i.maximets@ovn.org
State Superseded
Headers show
Series
  • [ovs-dev,ovn] submitting-patches: Update subject line format.
Related show

Commit Message

Ilya Maximets Feb. 26, 2020, 12:57 p.m. UTC
Since OVS and OVN are split but still using the same mailing list for
development, subject line should contain 'ovn' word.  This helps
to identify to which project patch should be applied.  Especially,
it helps to ovsrobot to not try and fail OVN patches on OVS repository.

Additionally removed unwanted empty line that makes '<summary>' part
look different in generated documents.

Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
---
 .../internals/contributing/submitting-patches.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

Comments

Dumitru Ceara Feb. 26, 2020, 3:10 p.m. UTC | #1
On 2/26/20 1:57 PM, Ilya Maximets wrote:
> Since OVS and OVN are split but still using the same mailing list for
> development, subject line should contain 'ovn' word.  This helps
> to identify to which project patch should be applied.  Especially,
> it helps to ovsrobot to not try and fail OVN patches on OVS repository.
> 
> Additionally removed unwanted empty line that makes '<summary>' part
> look different in generated documents.
> 
> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>

Looks good to me.

Acked-by: Dumitru Ceara <dceara@redhat.com>

Thanks,
Dumitru

> ---
>  .../internals/contributing/submitting-patches.rst | 15 ++++++++++-----
>  1 file changed, 10 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst
> index 5889e3c44..a89e2cd19 100644
> --- a/Documentation/internals/contributing/submitting-patches.rst
> +++ b/Documentation/internals/contributing/submitting-patches.rst
> @@ -79,11 +79,17 @@ Email Subject
>  
>  The subject line of your email should be in the following format:
>  
> -    [PATCH <n>/<m>] <area>: <summary>
> +    [PATCH ovn <n>/<m>] <area>: <summary>
>  
>  Where:
>  
> -``[PATCH <n>/<m>]``:
> +``[PATCH ovn]``:
> +  indicates that this is the patch and it is targeted for OVN project.  This
> +  is important since OVN and OVS are using same mailing lists for development.
> +  ``ovn`` word could be added manually or by using
> +  ``git format-patch --subject-prefix="PATCH ovn" ...``.
> +
> +``<n>/<m>``:
>    indicates that this is the nth of a series of m patches.  It helps reviewers
>    to read patches in the correct order.  You may omit this prefix if you are
>    sending only one patch.
> @@ -94,14 +100,13 @@ Where:
>    multiple distinct pieces of code.
>  
>  ``<summary>``:
> -
>    briefly describes the change.  Use the imperative form,
>    e.g. "Force SNAT for multiple gateway routers." or "Fix daemon exit
>    for bad datapaths or flows."  Try to keep the summary short, about
>    50 characters wide.
>  
> -The subject, minus the ``[PATCH <n>/<m>]`` prefix, becomes the first line of
> -the commit's change log message.
> +The subject, minus the ``[PATCH ovn <n>/<m>]`` prefix, becomes the first line
> +of the commit's change log message.
>  
>  Description
>  -----------
>
Ilya Maximets March 6, 2020, 2:55 p.m. UTC | #2
On 2/26/20 4:10 PM, Dumitru Ceara wrote:
> On 2/26/20 1:57 PM, Ilya Maximets wrote:
>> Since OVS and OVN are split but still using the same mailing list for
>> development, subject line should contain 'ovn' word.  This helps
>> to identify to which project patch should be applied.  Especially,
>> it helps to ovsrobot to not try and fail OVN patches on OVS repository.
>>
>> Additionally removed unwanted empty line that makes '<summary>' part
>> look different in generated documents.
>>
>> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
> 
> Looks good to me.
> 
> Acked-by: Dumitru Ceara <dceara@redhat.com>

Thanks Dumitru!

Replying to this thread just to mention that I've sent v2 and this
version (v1) should not be applied.

Best regards, Ilya Maximets.

Patch
diff mbox series

diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst
index 5889e3c44..a89e2cd19 100644
--- a/Documentation/internals/contributing/submitting-patches.rst
+++ b/Documentation/internals/contributing/submitting-patches.rst
@@ -79,11 +79,17 @@  Email Subject
 
 The subject line of your email should be in the following format:
 
-    [PATCH <n>/<m>] <area>: <summary>
+    [PATCH ovn <n>/<m>] <area>: <summary>
 
 Where:
 
-``[PATCH <n>/<m>]``:
+``[PATCH ovn]``:
+  indicates that this is the patch and it is targeted for OVN project.  This
+  is important since OVN and OVS are using same mailing lists for development.
+  ``ovn`` word could be added manually or by using
+  ``git format-patch --subject-prefix="PATCH ovn" ...``.
+
+``<n>/<m>``:
   indicates that this is the nth of a series of m patches.  It helps reviewers
   to read patches in the correct order.  You may omit this prefix if you are
   sending only one patch.
@@ -94,14 +100,13 @@  Where:
   multiple distinct pieces of code.
 
 ``<summary>``:
-
   briefly describes the change.  Use the imperative form,
   e.g. "Force SNAT for multiple gateway routers." or "Fix daemon exit
   for bad datapaths or flows."  Try to keep the summary short, about
   50 characters wide.
 
-The subject, minus the ``[PATCH <n>/<m>]`` prefix, becomes the first line of
-the commit's change log message.
+The subject, minus the ``[PATCH ovn <n>/<m>]`` prefix, becomes the first line
+of the commit's change log message.
 
 Description
 -----------