aboutsummaryrefslogtreecommitdiff
path: root/utils/readme.txt
diff options
context:
space:
mode:
authorGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2017-07-01 18:07:00 +0200
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2017-07-01 18:07:00 +0200
commit7ca9fc3170de1a41fbcbc5dfdc2838c75bff72a5 (patch)
tree414aac66ba7b23b1f9e4beca5fa02bd83dd90202 /utils/readme.txt
parentafdb545b2847d2a922ee202775998d4658900fec (diff)
downloadbuildroot-7ca9fc3170de1a41fbcbc5dfdc2838c75bff72a5.tar.gz
buildroot-7ca9fc3170de1a41fbcbc5dfdc2838c75bff72a5.tar.bz2
tools: rename to 'utils'
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>
Diffstat (limited to 'utils/readme.txt')
-rw-r--r--utils/readme.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/utils/readme.txt b/utils/readme.txt
new file mode 100644
index 0000000000..a90805fb00
--- /dev/null
+++ b/utils/readme.txt
@@ -0,0 +1,40 @@
+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.
+
+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-stat-compare
+ a script to compare the rootfs size between two differnt Buildroot
+ configurations. This can be used to identify the size impact of
+ a specific option, or of a set of specific options, or 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...)