Skip to content

Commit

Permalink
submitting-patches: Update subject line format.
Browse files Browse the repository at this point in the history
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>
Acked-by: Dumitru Ceara <dceara@redhat.com>
Signed-off-by: Numan Siddique <numans@ovn.org>
  • Loading branch information
igsilya authored and numansiddique committed May 1, 2020
1 parent 2217bcc commit aa6cf5d
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions Documentation/internals/contributing/submitting-patches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
-----------
Expand Down

0 comments on commit aa6cf5d

Please sign in to comment.