selftests: forwarding: README: Mention defer, adf_

Mention how it would be nice if new code used defer. Also if it does that
in dirtying helpers, how it would be nice if these were named adf_*.

Signed-off-by: Petr Machata <petrm@nvidia.com>
Reviewed-by: Simon Horman <horms@kernel.org>
Link: https://patch.msgid.link/0764bdb9266cd516da23ddeec110e01118cf981e.1758821127.git.petrm@nvidia.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Petr Machata
2025-09-25 19:31:56 +02:00
committed by Jakub Kicinski
parent 040a6cbead
commit fca6ff9191

View File

@@ -57,6 +57,21 @@ o Code shall be checked using ShellCheck [1] prior to submission.
1. https://www.shellcheck.net/
Cleanups
--------
o lib.sh brings in defer.sh (by way of ../lib.sh) by default. Consider
making use of the defer primitive to schedule automatic cleanups. This
makes it harder to forget to remove a temporary netdevice, kill a running
process or perform other cleanup when the test script is interrupted.
o When adding a helper that dirties the environment, but schedules all
necessary cleanups through defer, consider prefixing it adf_ for
consistency with lib.sh and ../lib.sh helpers. This serves as an
immediately visible bit of documentation about the helper API.
o Definitely do the above for any new code in lib.sh, if practical.
Customization
=============