Skip to content

Commit 6f7a1f9

Browse files
kuba-moodavem330
authored andcommitted
Documentation: netdev-FAQ: suggest how to post co-dependent series
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> Reviewed-by: David Ahern <dsahern@kernel.org> Signed-off-by: David S. Miller <davem@davemloft.net>
1 parent 26c8996 commit 6f7a1f9

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

Documentation/networking/netdev-FAQ.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,32 @@ you will have done run-time testing specific to your change, but at a
254254
minimum, your changes should survive an ``allyesconfig`` and an
255255
``allmodconfig`` build without new warnings or failures.
256256

257+
Q: How do I post corresponding changes to user space components?
258+
----------------------------------------------------------------
259+
A: User space code exercising kernel features should be posted
260+
alongside kernel patches. This gives reviewers a chance to see
261+
how any new interface is used and how well it works.
262+
263+
When user space tools reside in the kernel repo itself all changes
264+
should generally come as one series. If series becomes too large
265+
or the user space project is not reviewed on netdev include a link
266+
to a public repo where user space patches can be seen.
267+
268+
In case user space tooling lives in a separate repository but is
269+
reviewed on netdev (e.g. patches to `iproute2` tools) kernel and
270+
user space patches should form separate series (threads) when posted
271+
to the mailing list, e.g.::
272+
273+
[PATCH net-next 0/3] net: some feature cover letter
274+
└─ [PATCH net-next 1/3] net: some feature prep
275+
└─ [PATCH net-next 2/3] net: some feature do it
276+
└─ [PATCH net-next 3/3] selftest: net: some feature
277+
278+
[PATCH iproute2-next] ip: add support for some feature
279+
280+
Posting as one thread is discouraged because it confuses patchwork
281+
(as of patchwork 2.2.2).
282+
257283
Q: Any other tips to help ensure my net/net-next patch gets OK'd?
258284
-----------------------------------------------------------------
259285
A: Attention to detail. Re-read your own work as if you were the

0 commit comments

Comments
 (0)