tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: submitting-patches: improve the base commit explanation

After receiving a second patchset this week without knowing which tree
it applies on and trying to apply it on the obvious ones and failing,
make sure the base tree information which needs to be supplied in the
0th message of the patchset is spelled out more explicitly.

Also, make the formulations stronger as this really is a requirement and
not only a useful thing anymore.

Signed-off-by: "Borislav Petkov (AMD)" <bp@alien8.de>
change-id: <unique-series-id>
base-commit: <commit-id-or-tag>
Reviewed-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231115170330.16626-1-bp@alien8.de

authored by

Borislav Petkov (AMD) and committed by
Jonathan Corbet d254d263 c7dd2c42

+11 -4
+11 -4
Documentation/process/submitting-patches.rst
··· 790 790 ------------------------------- 791 791 792 792 When other developers receive your patches and start the review process, 793 - it is often useful for them to know where in the tree history they 794 - should place your work. This is particularly useful for automated CI 795 - processes that attempt to run a series of tests in order to establish 796 - the quality of your submission before the maintainer starts the review. 793 + it is absolutely necessary for them to know what is the base 794 + commit/branch your work applies on, considering the sheer amount of 795 + maintainer trees present nowadays. Note again the **T:** entry in the 796 + MAINTAINERS file explained above. 797 + 798 + This is even more important for automated CI processes that attempt to 799 + run a series of tests in order to establish the quality of your 800 + submission before the maintainer starts the review. 797 801 798 802 If you are using ``git format-patch`` to generate your patches, you can 799 803 automatically include the base tree information in your submission by ··· 840 836 either below the ``---`` line or at the very bottom of all other 841 837 content, right before your email signature. 842 838 839 + Make sure that base commit is in an official maintainer/mainline tree 840 + and not in some internal, accessible only to you tree - otherwise it 841 + would be worthless. 843 842 844 843 References 845 844 ----------