From 68de69c4d7f61ab5da4dd9cad221fb82e9e1abce Mon Sep 17 00:00:00 2001 From: Brandon Maier Date: Tue, 8 Oct 2024 15:57:50 +0000 Subject: [PATCH] docs/manual/adding-packages-tips: mention check-package requirements Call out the requirements to run check-package and mention that Docker can be used to run check-package without installing dependencies. Signed-off-by: Brandon Maier Signed-off-by: Thomas Petazzoni --- docs/manual/adding-packages-tips.adoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/manual/adding-packages-tips.adoc b/docs/manual/adding-packages-tips.adoc index b04b42b51f..85400c0f31 100644 --- a/docs/manual/adding-packages-tips.adoc +++ b/docs/manual/adding-packages-tips.adoc @@ -64,6 +64,19 @@ The tool can also be used for packages in a br2-external: $ check-package -b /path/to/br2-ext-tree/package/my-package/* ---- +The +check-package+ script requires you install +shellcheck+ and the +Python PyPi packages +flake8+ and +python-magic+. The Buildroot code +base is currently tested against version 0.7.1 of ShellCheck. If you +use a different version of ShellCheck, you may see additional, +unfixed, warnings. + +If you have Docker or Podman you can run +check-package+ without +installing dependencies: + +---- +$ ./utils/docker-run ./utils/check-package +---- + [[testing-package]] ==== How to test your package