diff --git a/docs/how-to/source-code/index.md b/docs/how-to/source-code/index.md index 5c2b979..559977f 100644 --- a/docs/how-to/source-code/index.md +++ b/docs/how-to/source-code/index.md @@ -9,4 +9,5 @@ preparing the kernel before the build process. Obtain kernel source using Git Enable kernel source package repositories +Send patches to the mailing-list ``` diff --git a/docs/how-to/source-code/send-patches.rst b/docs/how-to/source-code/send-patches.rst new file mode 100644 index 0000000..9721c9a --- /dev/null +++ b/docs/how-to/source-code/send-patches.rst @@ -0,0 +1,53 @@ +.. _how-to-send-patches: + +How to send patches to the mailing-list +####################################### + +To send kernel patches to the mailing-list, you should use the ``git +send-email`` command. + +.. note:: + + Most of the options explained here do not appear in the man page of + ``git-send-email`` but ``git-format-patch`` instead. They however work the + same. + +Specify series +============== + +All patches must be targeted at some series (unstable, noble, ...). +Specify the targeted series with the ``--subject-prefix`` option: + +.. code-block:: shell + + $ git send-email --subject-prefix="SRU][o/n/j:linux-azure][PATCH" ... + +The tags used in this example show that this patch set is targeting the +following kernels for an SRU update: *oracular*, *noble*, and +*jammy:linux-azure*. + +Send a new version of a patchset +================================ + +Mistakes happens, we are all humans. If you want to send a new version of your +patchset that fixes some issues, you can use the ``-v,--reroll-count`` option: + +.. code-block:: shell + + $ git send-email --subject-prefix=... -v 2 + +This will generate ``[PATCH v2]`` instead of just ``[PATCH]`` to indicate that +this is a new revision of a patchset. + +You should first make sure that your original patchset was rejected by having a +NAK/NACK in its thread. You can reply to this email saying that you will send a +new version of the patchset. If you found out a mistake you made, you can NAK +and say that you will send a new version in the same email. + +In the cover letter of the new patchset, you should describe what was changed +compared to the previous submitted version. + +See also +======== + +- (Reference) :ref:`ubuntu-patches-acceptance-criteria`