[ovs-dev] [PATCH ovn v2] submitting-patches: Update subject line format.

Dumitru Ceara dceara at redhat.com
Fri Mar 6 14:51:55 UTC 2020


On 3/6/20 3:17 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 at ovn.org>

This version looks good too and it is indeed nicer to have the git
config example.

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

Thanks,
Dumitru

> ---
> 
> Version 2:
>   - Added .git/config example.
> 
>  .../contributing/submitting-patches.rst       | 19 ++++++++++++++-----
>  1 file changed, 14 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst
> index 5889e3c44..0a9de5866 100644
> --- a/Documentation/internals/contributing/submitting-patches.rst
> +++ b/Documentation/internals/contributing/submitting-patches.rst
> @@ -79,11 +79,21 @@ 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" ...``.  It might be useful
> +  to add following configuration to a local ``.git/config``::
> +
> +    [format]
> +          subjectPrefix = "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 +104,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
>  -----------
> 



More information about the dev mailing list