summaryrefslogtreecommitdiffstats
path: root/utils/check-package
Commit message (Collapse)AuthorAgeFilesLines
* utils/check-package: allow to disable warning for a lineRicardo Martincoski2019-01-291-0/+4
| | | | | | | | | | | | | Currently any exceptions for a check function need to be coded into the check-package script itself. Create a pattern that can be used in a comment to make check-package ignore one or more warning types in the line immediately below: # check-package Indent, VariableWithBraces Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* check-package: fix Python3 supportRicardo Martincoski2019-01-161-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This script currently uses "/usr/bin/env python" as shebang but it does not really support Python3. Instead of limiting the script to Python2, fix it to support both versions. So change all imports to absolute imports because Python3 follows PEP328 and dropped implicit relative imports. In order to avoid errors when decoding files with the default 'utf-8' codec, use errors="surrogateescape" when opening files, the docs for open() states: "This is useful for processing files in an unknown encoding.". This argument is not compatible with Python2 open() so import 'six' to use it only when running in Python3. As a consequence the file handler becomes explicit, so use it to close() the file after it got processed. This "surrogateescape" is a simple alternative to the complete solution of opening files with "rb" and changing all functions in the lib*.py files to use bytes objects instead of strings. The only case we can have non-ascii/non-utf-8 files being checked by the script are for patch files when the upstream file to be patched is not ascii or utf-8. There is currently one case in the tree: package/urg/0002-urg-gcc6-fix-narrowing-conversion.patch. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Tested-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* check-package: support symlinks to the scriptArnout Vandecappelle (Essensium/Mind)2018-04-011-1/+1
| | | | | | | | | | | | | | | | The check-package script finds base_dir (= the Buildroot directory) and cd's into it. To be able to support relative paths as arguments, it first recalculates the arguments relative to base_dir. However, if there is a symlink anywhere on the path to the check-package script, the relative paths will be wrong. To solve this, use realpath() instead of abspath(), so symlinks are resolved before calculating the relative path. Cc: Ricardo Martincoski <ricardo.martincoski@gmail.com> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* check-package: enable for Config.in* in base dirRicardo Martincoski2018-04-011-1/+2
| | | | | | | | | | These files can benefit from this script to prevent common mistakes when submitting patches. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Cc: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* check-package: enable for toolchain/Ricardo Martincoski2018-04-011-0/+3
| | | | | | | | | | | | | | | | | | | | The toolchain directory can benefit from this script to prevent common mistakes when submitting patches. In order to accomplish this: Do not ignore anymore files from the toolchain/ directory. Ignore this symbol: - BR_LIBC: defined by the buildroot toolchain, used by gcc-final.mk. Ignore toolchain/toolchain-external/pkg-toolchain-external.mk as it declares a package infra and not a package itself. Ignore toolchain/helpers.mk as it contains only helper functions. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Romain Naour <romain.naour@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* check-package: enable for linux/Ricardo Martincoski2018-04-011-0/+1
| | | | | | | | | | | | | | | | | This directory can benefit from this script to prevent common mistakes when submitting patches. In order to accomplish this: Do not ignore anymore files from the linux/ directory. Ignore missing LINUX_EXT_ prefix as the variables for linux extensions do not use it. Ignore this symbol: - LINUX_EXTENSIONS: defined by each linux extension, used by linux/linux.mk. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* check-package: enable for fs/Ricardo Martincoski2018-04-011-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The filesystem types can benefit from this script to prevent common mistakes when submitting patches. In order to accomplish this: Do not ignore anymore files from the fs/ directory. Ignore fs/common.mk as it declares a package infra and not a package itself. Register the ROOTFS_ as a valid prefix for variables. Ignore these symbols: - PACKAGES_PERMISSIONS_TABLE: defined either by packages through pkg-generic or by filesystem types, used by fs/common.mk; - SUMTOOL: defined by package mtd, used by filesystem jffs2; - TARGETS_ROOTFS: defined by filesystem types, used in the main Makefile. Keep using loose checks that warn about common mistakes while keep the code simple. As a consequence the check functions do not differentiate between packages and filesystems so the symbol PACKAGE_UBI would not generate a warning for the ubi filesystem neither the symbol ROOTFS_MTD would generate a warning for the mtd package. But those kind of mistakes are not common and are obvious in the code review, unlike typos i.e. ROOTFS_UBl or PACKAGE_MID that would be hard to see in the code review. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Cc: Yann E. MORIN <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* check-package: enable for boot/Ricardo Martincoski2018-04-011-0/+2
| | | | | | | | | | | | | This directory can benefit from this script to prevent common mistakes when submitting patches. In order to accomplish this: Do not ignore anymore files from the boot/ directory. Ignore boot/barebox/barebox.mk as it declares a package infra and not a package itself. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* check-package: enable for arch/ and system/Ricardo Martincoski2018-04-011-0/+2
| | | | | | | | | | | | These directories can benefit from this script to prevent common mistakes when submitting patches. In order to accomplish this: Do not ignore anymore files from these directories. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Yann E. MORIN <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* check-package: prepare to extend to other directoriesRicardo Martincoski2018-04-011-5/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently the script only checks files inside the package/ directory. Upcoming patches will enable it for other directories. In order to reliably test for file names, i.e. the Config.in in the base directory, normalize the path of files to check to a relative path to the base directory. Rename the variable that holds the compiled regexp to better represent its content and rearrange how it is declared to make easy to later add new directories to check. As a consequence the files that declare package infra types would not be ignored anymore, so create a new variable to list the files intree to be ignored during the check. The same variable will be used by upcoming patches to ignore other files. Ignore pkg-*.mk and doc-asciidoc.mk since they are package infra files. In order to not produce weird results when used for files outside the tree (i.e. in a private br2-external) add an explicit command line option (-b) that bypasses any checks that would make a file be ignored by the path that contains it. When in this out-of-tree mode, the user is responsible for providing a list of files to check that do not contain files the script does not understand, e.g. package infra files. As a result of this patch, besides the known use: $ ./utils/check-package package/new-package/* someone with the utils/ directory in the path can now also run: $ cd package/new-package/ $ check-package * or $ check-package -b /path/to/br2-ext-tree/package/staging-package/* Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* tools: rename to 'utils'Thomas Petazzoni2017-07-011-0/+144
After some discussion, we found out that "tools" has the four first letters identical to the "toolchain" subfolder, which makes it a bit unpractical with tab-completion. So, this commit renames "tools" to "utils", which is more tab-completion-friendly. This has been discussed with Arnout and Yann. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
OpenPOWER on IntegriCloud