buildroot/utils
Ricardo Martincoski a7b4bbfc14 check-package: prepare to extend to other directories
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>
2018-04-01 07:58:07 +02:00
..
checkpackagelib check-package: Flag usage of '\t \\$'. 2018-03-31 23:02:14 +02:00
brmake utils/brmake: print the error code of the build 2017-07-05 00:15:05 +02:00
check-package check-package: prepare to extend to other directories 2018-04-01 07:58:07 +02:00
config utils/config: new script to manipulate .config files on the command line 2017-09-27 22:45:35 +02:00
diffconfig utils/diffconfig: add diffconfig utility 2017-11-25 13:46:41 +01:00
genrandconfig utils/genrandconfig: use --no-check-certificate in wget by default 2018-03-31 17:17:51 +02:00
get-developers get-developers: fix code style 2018-01-29 23:14:24 +01:00
getdeveloperlib.py get-developers: fix code style 2018-01-29 23:14:24 +01:00
readme.txt utils/readme.txt: add documentation of genrandconfig 2017-07-29 15:41:09 +02:00
scancpan perl: bump to version 5.26.1 2017-09-28 22:04:48 +02:00
scanpypi utils/scanpypi: don't hardcode python2 2018-04-01 07:53:58 +02:00
size-stats-compare size-stats-compare: fix code style 2018-03-13 22:27:19 +01:00
test-pkg utils/test-pkg: always run a global legal-info 2018-01-08 09:16:50 +01:00

This directory contains various useful scripts and tools for working
with Buildroot. You need not add this directory in your PATH to use
any of those tools, but you may do so if you want.

brmake
    a script that can be run instead of make, that prepends the date in
    front of each line, redirects all of the build output to a file
    ("'br.log' in the current directory), and just outputs the Buildroot
    messages (those lines starting with >>>) on stdout.
    Do not run this script for interactive configuration (e.g. menuconfig)
    or on an unconfigured directory. The output is redirected so you will see
    nothing.

check-package
    a script that checks the coding style of a package's Config.in and
    .mk files, and also tests them for various types of typoes.

genrandconfig
    a script that generates a random configuration, used by the autobuilders
    (http://autobuild.buildroot.org). It selects a random toolchain from
    support/config-fragments/autobuild and randomly selects packages to build.

get-developpers
    a script to return the list of people interested in a specific part
    of Buildroot, so they can be Cc:ed on a mail. Accepts a patch as
    input, a package name or and architecture name.

scancpan
    a script to create a Buildroot package by scanning a CPAN module
    description.

scanpypi
    a script to create a Buildroot package by scanning a PyPI package
    description.

size-stats-compare
    a script to compare the rootfs size between two different Buildroot
    configurations. This can be used to identify the size impact of
    a specific option, of a set of specific options, or of an update
    to a newer Buildroot version...

test-pkg
    a script that tests a specific package against a set of various
    toolchains, with the goal to detect toolchain-related dependencies
    (wchar, threads...)