utils/readme.txt

   1 This directory contains various useful scripts and tools for working
   2 with Buildroot. You need not add this directory in your PATH to use
   3 any of those tools, but you may do so if you want.
   4
   5 brmake
   6     a script that can be run instead of make, that prepends the date in
   7     front of each line, redirects all of the build output to a file
   8     ("'br.log' in the current directory), and just outputs the Buildroot
   9     messages (those lines starting with >>>) on stdout.
  10     Do not run this script for interactive configuration (e.g. menuconfig)
  11     or on an unconfigured directory. The output is redirected so you will see
  12     nothing.
  13
  14 check-package
  15     a script that checks the coding style across the buildroot tree. It
  16     checks package's Config.in and .mk files, runs shellcheck for all shell
  17     scripts, flake8 for python files, checks for typoes, etc.
  18     It checks the .checkpackageignore file if errors should be ignored and
  19     errors if there's a file listed that doesn't produce an error.
  20
  21 docker-run
  22     a script that runs a command (like make check-package) inside the
  23     buildroot CI docker container; pass no command to get an interactive
  24     shell.
  25
  26 genrandconfig
  27     a script that generates a random configuration, used by the autobuilders
  28     (http://autobuild.buildroot.org). It selects a random toolchain from
  29     support/config-fragments/autobuild and randomly selects packages to build.
  30
  31 get-developers
  32     a script to return the list of people interested in a specific part
  33     of Buildroot, so they can be Cc:ed on a mail. Accepts a patch as
  34     input, a package name or and architecture name.
  35
  36 scancpan
  37     a script to create a Buildroot package by scanning a CPAN module
  38     description.
  39
  40 scanpypi
  41     a script to create a Buildroot package by scanning a PyPI package
  42     description.
  43
  44 size-stats-compare
  45     a script to compare the rootfs size between two different Buildroot
  46     configurations. This can be used to identify the size impact of
  47     a specific option, of a set of specific options, or of an update
  48     to a newer Buildroot version...
  49
  50 test-pkg
  51     a script that tests a specific package against a set of various
  52     toolchains, with the goal to detect toolchain-related dependencies
  53     (wchar, threads...)