NetCube-Systems-Austria/kumquat-buildroot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/manual/adding-packages-tips: mention check-package requirements

Browse Source 
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 <brandon.maier@collins.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
(cherry picked from commit 68de69c4d7f61ab5da4dd9cad221fb82e9e1abce)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
This commit is contained in:
Brandon Maier 2024-10-08 15:57:50 +00:00 committed by Peter Korsgaard
parent 92a63d7aca
commit a21e4b5007
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/manual/adding-packages-tips.adoc
View File

@ -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