readme.txt 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. brmake
  5. a script that can be run instead of make, that prepends the date in
  6. front of each line, redirects all of the build output to a file
  7. ("'br.log' in the current directory), and just outputs the Buildroot
  8. messages (those lines starting with >>>) on stdout.
  9. To run this within a container using docker-run (see below), set
  10. BR2_DOCKER=y in the environment, i.e. call it as
  11. `BR2_DOCKER=y utils/brmake`.
  12. Do not run this script for interactive configuration (e.g. menuconfig)
  13. or on an unconfigured directory. The output is redirected so you will see
  14. nothing.
  15. check-package
  16. a script that checks the coding style across the buildroot tree. It
  17. checks package's Config.in and .mk files, runs shellcheck for all shell
  18. scripts, flake8 for python files, checks for typos, etc.
  19. It checks the .checkpackageignore file if errors should be ignored and
  20. errors if there's a file listed that doesn't produce an error.
  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. genrandconfig
  26. a script that generates a random configuration, used by the autobuilders
  27. (http://autobuild.buildroot.org). It selects a random toolchain from
  28. support/config-fragments/autobuild and randomly selects packages to build.
  29. get-developers
  30. a script to return the list of people interested in a specific part
  31. of Buildroot, so they can be Cc:ed on a mail. Accepts a patch as
  32. input, a package name or and architecture name.
  33. scancpan
  34. a script to create a Buildroot package by scanning a CPAN module
  35. description.
  36. scanpypi
  37. a script to create a Buildroot package by scanning a PyPI package
  38. description.
  39. size-stats-compare
  40. a script to compare the rootfs size between two different Buildroot
  41. configurations. This can be used to identify the size impact of
  42. a specific option, of a set of specific options, or of an update
  43. to a newer Buildroot version...
  44. test-pkg
  45. a script that tests a specific package against a set of various
  46. toolchains, with the goal to detect toolchain-related dependencies
  47. (wchar, threads...)