Skip to content

Commit 396492b

Browse files
kuba-moodavem330
authored andcommitted
docs: networking: netdevsim rules
There are aspects of netdevsim which are commonly misunderstood and pointed out in review. Cong suggest we document them. Suggested-by: Cong Wang <[email protected]> Signed-off-by: Jakub Kicinski <[email protected]> Signed-off-by: David S. Miller <[email protected]>
1 parent d00551b commit 396492b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

Documentation/networking/netdev-FAQ.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,23 @@ before posting to the mailing list. The patchwork build bot instance
228228
gets overloaded very easily and netdev@vger really doesn't need more
229229
traffic if we can help it.
230230

231+
netdevsim is great, can I extend it for my out-of-tree tests?
232+
-------------------------------------------------------------
233+
234+
No, `netdevsim` is a test vehicle solely for upstream tests.
235+
(Please add your tests under tools/testing/selftests/.)
236+
237+
We also give no guarantees that `netdevsim` won't change in the future
238+
in a way which would break what would normally be considered uAPI.
239+
240+
Is netdevsim considered a "user" of an API?
241+
-------------------------------------------
242+
243+
Linux kernel has a long standing rule that no API should be added unless
244+
it has a real, in-tree user. Mock-ups and tests based on `netdevsim` are
245+
strongly encouraged when adding new APIs, but `netdevsim` in itself
246+
is **not** considered a use case/user.
247+
231248
Any other tips to help ensure my net/net-next patch gets OK'd?
232249
--------------------------------------------------------------
233250
Attention to detail. Re-read your own work as if you were the

0 commit comments

Comments
 (0)