diff mbox series

[net,v2] Documentation: netdev-FAQ: suggest how to post co-dependent series

Message ID 20201125041524.190170-1-kuba@kernel.org
State Superseded
Headers show
Series [net,v2] Documentation: netdev-FAQ: suggest how to post co-dependent series | expand

Commit Message

Jakub Kicinski Nov. 25, 2020, 4:15 a.m. UTC
Make an explicit suggestion how to post user space side of kernel
patches to avoid reposts when patchwork groups the wrong patches.

v2: mention the cases unlike iproute2 explicitly

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
---
 Documentation/networking/netdev-FAQ.rst | 26 +++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

Comments

David Ahern Nov. 25, 2020, 4:38 a.m. UTC | #1
On 11/24/20 9:15 PM, Jakub Kicinski wrote:
> Make an explicit suggestion how to post user space side of kernel
> patches to avoid reposts when patchwork groups the wrong patches.
> 
> v2: mention the cases unlike iproute2 explicitly
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
> ---
>  Documentation/networking/netdev-FAQ.rst | 26 +++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
> 
> diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
> index 21537766be4d..4b9ed5874d5a 100644
> --- a/Documentation/networking/netdev-FAQ.rst
> +++ b/Documentation/networking/netdev-FAQ.rst
> @@ -254,6 +254,32 @@ you will have done run-time testing specific to your change, but at a
>  minimum, your changes should survive an ``allyesconfig`` and an
>  ``allmodconfig`` build without new warnings or failures.
>  
> +Q: How do I post corresponding changes to user space components?
> +----------------------------------------------------------------
> +A: User space code exercising kernel features should be posted
> +alongside kernel patches. This gives reviewers a chance to see
> +how any new interface is used and how well it works.
> +
> +When user space tools reside in the kernel repo itself all changes
> +should generally come as one series. If series becomes too large
> +or the user space project is not reviewed on netdev include a link
> +to a public repo where user space patches can be seen.
> +
> +In case user space tooling lives in a separate repository but is
> +reviewed on netdev  (e.g. patches to `iproute2` tools) kernel and

double space. besides that:
Reviewed-by: David Ahern <dsahern@kernel.org>
David Miller Nov. 25, 2020, 4:47 a.m. UTC | #2
From: Jakub Kicinski <kuba@kernel.org>
Date: Tue, 24 Nov 2020 20:15:24 -0800

> Make an explicit suggestion how to post user space side of kernel
> patches to avoid reposts when patchwork groups the wrong patches.
> 
> v2: mention the cases unlike iproute2 explicitly
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>

Applied, thanks!!
Toke Høiland-Jørgensen Nov. 25, 2020, 10:37 a.m. UTC | #3
>David Miller <davem@davemloft.net> writes:

> From: Jakub Kicinski <kuba@kernel.org>
> Date: Tue, 24 Nov 2020 20:15:24 -0800
>
>> Make an explicit suggestion how to post user space side of kernel
>> patches to avoid reposts when patchwork groups the wrong patches.
>> 
>> v2: mention the cases unlike iproute2 explicitly
>> 
>> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
>> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
>
> Applied, thanks!!

W000t! Welcome back Davem - we missed you! :)

-Toke
diff mbox series

Patch

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 21537766be4d..4b9ed5874d5a 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -254,6 +254,32 @@  you will have done run-time testing specific to your change, but at a
 minimum, your changes should survive an ``allyesconfig`` and an
 ``allmodconfig`` build without new warnings or failures.
 
+Q: How do I post corresponding changes to user space components?
+----------------------------------------------------------------
+A: User space code exercising kernel features should be posted
+alongside kernel patches. This gives reviewers a chance to see
+how any new interface is used and how well it works.
+
+When user space tools reside in the kernel repo itself all changes
+should generally come as one series. If series becomes too large
+or the user space project is not reviewed on netdev include a link
+to a public repo where user space patches can be seen.
+
+In case user space tooling lives in a separate repository but is
+reviewed on netdev  (e.g. patches to `iproute2` tools) kernel and
+user space patches should form separate series (threads) when posted
+to the mailing list, e.g.::
+
+  [PATCH net-next 0/3] net: some feature cover letter
+   └─ [PATCH net-next 1/3] net: some feature prep
+   └─ [PATCH net-next 2/3] net: some feature do it
+   └─ [PATCH net-next 3/3] selftest: net: some feature
+
+  [PATCH iproute2-next] ip: add support for some feature
+
+Posting as one thread is discouraged because it confuses patchwork
+(as of patchwork 2.2.2).
+
 Q: Any other tips to help ensure my net/net-next patch gets OK'd?
 -----------------------------------------------------------------
 A: Attention to detail.  Re-read your own work as if you were the