jeans/motioneyeos
jeans/motioneyeos
1
0
Fork 0
mirror of https://github.com/motioneye-project/motioneyeos.git synced 2025-07-27 05:06:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/manual: add check-package to "Tips and tricks"

Browse Source 
And add two references to it: in "Submitting patches" and in "Adding new
packages to Buildroot" sections.

Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
This commit is contained in:
Ricardo Martincoski 2018-04-01 19:31:56 -03:00 committed by Thomas Petazzoni
parent dab038d1ac
commit 01e9dd2995
3 changed files with 39 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/manual/adding-packages-tips.txt
View File

@ -32,6 +32,38 @@ using the following rules:
with `.` and `-` characters substituted with `_` (e.g.: with `.` and `-` characters substituted with `_` (e.g.:
+FOO_BAR_BOO_VERSION+). +FOO_BAR_BOO_VERSION+).
[[check-package]]
==== How to check the coding style
Buildroot provides a script in +utils/check-package+ that checks new or
changed files for coding style. It is not a complete language validator,
but it catches many common mistakes. It is meant to run in the actual
files you created or modified, before creating the patch for submission.
This script can be used for packages, filesystem makefiles, Config.in
files, etc. It does not check the files defining the package
infrastructures and some other files containing similar common code.
To use it, run the +check-package+ script, by telling which files you
created or changed:
----
$ ./utils/check-package package/new-package/*
----
If you have the +utils+ directory in your path you can also run:
----
$ cd package/new-package/
$ check-package *
----
The tool can also be used for packages in a br2-external:
----
$ check-package -b /path/to/br2-ext-tree/package/my-package/*
----
[[testing-package]] [[testing-package]]
==== How to test your package ==== How to test your package

5
docs/manual/adding-packages.txt
View File

@ -9,8 +9,9 @@ applications) can be integrated into Buildroot. It also shows how
existing packages are integrated, which is needed for fixing issues or existing packages are integrated, which is needed for fixing issues or
tuning their configuration. tuning their configuration.
When you add a new package, be sure to test it in various conditions; When you add a new package, be sure to test it in various conditions
see xref:testing-package[] (see xref:testing-package[]) and also check it for coding style (see
xref:check-package[]).
include::adding-packages-directory.txt[] include::adding-packages-directory.txt[]

4
docs/manual/contribute.txt
View File

@ -264,6 +264,10 @@ yourself to the DEVELOPERS file. This should be done in the same patch
creating or modifying the package. See xref:DEVELOPERS[the DEVELOPERS file] creating or modifying the package. See xref:DEVELOPERS[the DEVELOPERS file]
for more information. for more information.
Buildroot provides a handy tool to check for common coding style
mistakes on files you created or modified, called +check-package+ (see
xref:check-package[] for more information).
==== Preparing a patch series ==== Preparing a patch series
Starting from the changes committed in your local git view, _rebase_ Starting from the changes committed in your local git view, _rebase_