Commit 72e9647e authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

selftests: drv-net: clarify linters and frameworks in README 



Minor clarifications in the README:
 - call out what linters we expect to be clean
 - make it clear that by "frameworks" we mean code under lib/
   not just factoring code out in the same file

Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent c3388f8c

tools/testing/selftests/drivers/net/README.rst

+8 −2
Original line number Diff line number Diff line
@@ -211,8 +211,8 @@ Avoid libraries and frameworks 


Test files should be relatively self contained. The libraries should

only include very core or non-trivial code.

It may be tempting to "factor out" the common code, but fight that urge.

Library code increases the barrier of entry, and complexity in general.

It may be tempting to "factor out" the common code to lib/py/, but fight that

urge. Library code increases the barrier of entry, and complexity in general.



Avoid mixing test code and boilerplate

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -290,6 +290,12 @@ or:: 
  def test(cfg, mode, protocol):

      pass



Linters

~~~~~~~



We expect clean ``ruff check`` and ``pylint --disable=R``.

The code should be clean, avoid disabling pylint warnings explicitly!



Running tests CI-style

======================