tools/buildman/README

   1 # Copyright (c) 2013 The Chromium OS Authors.
   2 #
   3 # SPDX-License-Identifier:      GPL-2.0+
   4 #
   5
   6 (Please read 'How to change from MAKEALL' if you are used to that tool)
   7
   8 What is this?
   9 =============
  10
  11 This tool handles building U-Boot to check that you have not broken it
  12 with your patch series. It can build each individual commit and report
  13 which boards fail on which commits, and which errors come up. It aims
  14 to make full use of multi-processor machines.
  15
  16 A key feature of buildman is its output summary, which allows warnings,
  17 errors or image size increases in a particular commit or board to be
  18 quickly identified and the offending commit pinpointed. This can be a big
  19 help for anyone working with >10 patches at a time.
  20
  21
  22 Caveats
  23 =======
  24
  25 Buildman is still in its infancy. It is already a very useful tool, but
  26 expect to find problems and send patches.
  27
  28 Buildman can be stopped and restarted, in which case it will continue
  29 where it left off. This should happen cleanly and without side-effects.
  30 If not, it is a bug, for which a patch would be welcome.
  31
  32 Buildman gets so tied up in its work that it can ignore the outside world.
  33 You may need to press Ctrl-C several times to quit it. Also it will print
  34 out various exceptions when stopped.
  35
  36
  37 Theory of Operation
  38 ===================
  39
  40 (please read this section in full twice or you will be perpetually confused)
  41
  42 Buildman is a builder. It is not make, although it runs make. It does not
  43 produce any useful output on the terminal while building, except for
  44 progress information (except with -v, see below). All the output (errors,
  45 warnings and binaries if you ask for them) is stored in output
  46 directories, which you can look at while the build is progressing, or when
  47 it is finished.
  48
  49 Buildman produces a concise summary of which boards succeeded and failed.
  50 It shows which commit introduced which board failure using a simple
  51 red/green colour coding. Full error information can be requested, in which
  52 case it is de-duped and displayed against the commit that introduced the
  53 error. An example workflow is below.
  54
  55 Buildman stores image size information and can report changes in image size
  56 from commit to commit. An example of this is below.
  57
  58 Buildman starts multiple threads, and each thread builds for one board at
  59 a time. A thread starts at the first commit, configures the source for your
  60 board and builds it. Then it checks out the next commit and does an
  61 incremental build. Eventually the thread reaches the last commit and stops.
  62 If errors or warnings are found along the way, the thread will reconfigure
  63 after every commit, and your build will be very slow. This is because a
  64 file that produces just a warning would not normally be rebuilt in an
  65 incremental build.
  66
  67 Buildman works in an entirely separate place from your U-Boot repository.
  68 It creates a separate working directory for each thread, and puts the
  69 output files in the working directory, organised by commit name and board
  70 name, in a two-level hierarchy.
  71
  72 Buildman is invoked in your U-Boot directory, the one with the .git
  73 directory. It clones this repository into a copy for each thread, and the
  74 threads do not affect the state of your git repository. Any checkouts done
  75 by the thread affect only the working directory for that thread.
  76
  77 Buildman automatically selects the correct tool chain for each board. You
  78 must supply suitable tool chains, but buildman takes care of selecting the
  79 right one.
  80
  81 Buildman generally builds a branch (with the -b flag), and in this case
  82 builds the upstream commit as well, for comparison. It cannot build
  83 individual commits at present, unless (maybe) you point it at an empty
  84 branch. Put all your commits in a branch, set the branch's upstream to a
  85 valid value, and all will be well. Otherwise buildman will perform random
  86 actions. Use -n to check what the random actions might be.
  87
  88 If you just want to build the current source tree, leave off the -b flag
  89 and add -e. This will display results and errors as they happen. You can
  90 still look at them later using -se. Note that buildman will assume that the
  91 source has changed, and will build all specified boards in this case.
  92
  93 Buildman is optimised for building many commits at once, for many boards.
  94 On multi-core machines, Buildman is fast because it uses most of the
  95 available CPU power. When it gets to the end, or if you are building just
  96 a few commits or boards, it will be pretty slow. As a tip, if you don't
  97 plan to use your machine for anything else, you can use -T to increase the
  98 number of threads beyond the default.
  99
 100 Buildman lets you build all boards, or a subset. Specify the subset by passing
 101 command-line arguments that list the desired board name, architecture name,
 102 SOC name, or anything else in the boards.cfg file. Multiple arguments are
 103 allowed. Each argument will be interpreted as a regular expression, so
 104 behaviour is a superset of exact or substring matching. Examples are:
 105
 106 * 'tegra20'      All boards with a Tegra20 SoC
 107 * 'tegra'        All boards with any Tegra Soc (Tegra20, Tegra30, Tegra114...)
 108 * '^tegra[23]0$' All boards with either Tegra20 or Tegra30 SoC
 109 * 'powerpc'      All PowerPC boards
 110
 111 While the default is to OR the terms together, you can also make use of
 112 the '&' operator to limit the selection:
 113
 114 * 'freescale & arm sandbox'  All Freescale boards with ARM architecture,
 115                              plus sandbox
 116
 117 You can also use -x to specifically exclude some boards. For example:
 118
 119  buildmand arm -x nvidia,freescale,.*ball$
 120
 121 means to build all arm boards except nvidia, freescale and anything ending
 122 with 'ball'.
 123
 124 It is convenient to use the -n option to see what will be built based on
 125 the subset given.
 126
 127 Buildman does not store intermediate object files. It optionally copies
 128 the binary output into a directory when a build is successful. Size
 129 information is always recorded. It needs a fair bit of disk space to work,
 130 typically 250MB per thread.
 131
 132
 133 Setting up
 134 ==========
 135
 136 1. Get the U-Boot source. You probably already have it, but if not these
 137 steps should get you started with a repo and some commits for testing.
 138
 139 $ cd /path/to/u-boot
 140 $ git clone git://git.denx.de/u-boot.git .
 141 $ git checkout -b my-branch origin/master
 142 $ # Add some commits to the branch, reading for testing
 143
 144 2. Create ~/.buildman to tell buildman where to find tool chains (see 'The
 145 .buildman file' later for details). As an example:
 146
 147 # Buildman settings file
 148
 149 [toolchain]
 150 root: /
 151 rest: /toolchains/*
 152 eldk: /opt/eldk-4.2
 153 arm: /opt/linaro/gcc-linaro-arm-linux-gnueabihf-4.8-2013.08_linux
 154 aarch64: /opt/linaro/gcc-linaro-aarch64-none-elf-4.8-2013.10_linux
 155
 156 [toolchain-alias]
 157 x86: i386
 158 blackfin: bfin
 159 nds32: nds32le
 160 openrisc: or1k
 161
 162
 163 This selects the available toolchain paths. Add the base directory for
 164 each of your toolchains here. Buildman will search inside these directories
 165 and also in any '/usr' and '/usr/bin' subdirectories.
 166
 167 Make sure the tags (here root: rest: and eldk:) are unique.
 168
 169 The toolchain-alias section indicates that the i386 toolchain should be used
 170 to build x86 commits.
 171
 172 Note that you can also specific exactly toolchain prefixes if you like:
 173
 174 [toolchain-prefix]
 175 arm: /opt/arm-eabi-4.6/bin/arm-eabi-
 176
 177 or even:
 178
 179 [toolchain-prefix]
 180 arm: /opt/arm-eabi-4.6/bin/arm-eabi-gcc
 181
 182 This tells buildman that you want to use this exact toolchain for the arm
 183 architecture. This will override any toolchains found by searching using the
 184 [toolchain] settings.
 185
 186 Since the toolchain prefix is an explicit request, buildman will report an
 187 error if a toolchain is not found with that prefix. The current PATH will be
 188 searched, so it is possible to use:
 189
 190 [toolchain-prefix]
 191 arm: arm-none-eabi-
 192
 193 and buildman will find arm-none-eabi-gcc in /usr/bin if you have it installed.
 194
 195 3. Make sure you have the require Python pre-requisites
 196
 197 Buildman uses multiprocessing, Queue, shutil, StringIO, ConfigParser and
 198 urllib2. These should normally be available, but if you get an error like
 199 this then you will need to obtain those modules:
 200
 201     ImportError: No module named multiprocessing
 202
 203
 204 4. Check the available toolchains
 205
 206 Run this check to make sure that you have a toolchain for every architecture.
 207
 208 $ ./tools/buildman/buildman --list-tool-chains
 209 Scanning for tool chains
 210    - scanning prefix '/opt/gcc-4.6.3-nolibc/x86_64-linux/bin/x86_64-linux-'
 211 Tool chain test:  OK, arch='x86', priority 1
 212    - scanning prefix '/opt/arm-eabi-4.6/bin/arm-eabi-'
 213 Tool chain test:  OK, arch='arm', priority 1
 214    - scanning path '/toolchains/gcc-4.9.0-nolibc/i386-linux'
 215       - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/.'
 216       - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/bin'
 217          - found '/toolchains/gcc-4.9.0-nolibc/i386-linux/bin/i386-linux-gcc'
 218       - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/usr/bin'
 219 Tool chain test:  OK, arch='i386', priority 4
 220    - scanning path '/toolchains/gcc-4.9.0-nolibc/aarch64-linux'
 221       - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/.'
 222       - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin'
 223          - found '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc'
 224       - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/usr/bin'
 225 Tool chain test:  OK, arch='aarch64', priority 4
 226    - scanning path '/toolchains/gcc-4.9.0-nolibc/microblaze-linux'
 227       - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/.'
 228       - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin'
 229          - found '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc'
 230       - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/usr/bin'
 231 Tool chain test:  OK, arch='microblaze', priority 4
 232    - scanning path '/toolchains/gcc-4.9.0-nolibc/mips64-linux'
 233       - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/.'
 234       - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/bin'
 235          - found '/toolchains/gcc-4.9.0-nolibc/mips64-linux/bin/mips64-linux-gcc'
 236       - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/usr/bin'
 237 Tool chain test:  OK, arch='mips64', priority 4
 238    - scanning path '/toolchains/gcc-4.9.0-nolibc/sparc64-linux'
 239       - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/.'
 240       - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin'
 241          - found '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin/sparc64-linux-gcc'
 242       - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/usr/bin'
 243 Tool chain test:  OK, arch='sparc64', priority 4
 244    - scanning path '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi'
 245       - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/.'
 246       - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin'
 247          - found '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin/arm-unknown-linux-gnueabi-gcc'
 248       - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/usr/bin'
 249 Tool chain test:  OK, arch='arm', priority 3
 250 Toolchain '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin/arm-unknown-linux-gnueabi-gcc' at priority 3 will be ignored because another toolchain for arch 'arm' has priority 1
 251    - scanning path '/toolchains/gcc-4.9.0-nolibc/sparc-linux'
 252       - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/.'
 253       - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/bin'
 254          - found '/toolchains/gcc-4.9.0-nolibc/sparc-linux/bin/sparc-linux-gcc'
 255       - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/usr/bin'
 256 Tool chain test:  OK, arch='sparc', priority 4
 257    - scanning path '/toolchains/gcc-4.9.0-nolibc/mips-linux'
 258       - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/.'
 259       - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/bin'
 260          - found '/toolchains/gcc-4.9.0-nolibc/mips-linux/bin/mips-linux-gcc'
 261       - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/usr/bin'
 262 Tool chain test:  OK, arch='mips', priority 4
 263    - scanning path '/toolchains/gcc-4.9.0-nolibc/x86_64-linux'
 264       - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/.'
 265       - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin'
 266          - found '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc'
 267          - found '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-x86_64-linux-gcc'
 268       - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/usr/bin'
 269 Tool chain test:  OK, arch='x86_64', priority 4
 270 Tool chain test:  OK, arch='x86_64', priority 4
 271 Toolchain '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-x86_64-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'x86_64' has priority 4
 272    - scanning path '/toolchains/gcc-4.9.0-nolibc/m68k-linux'
 273       - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/.'
 274       - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/bin'
 275          - found '/toolchains/gcc-4.9.0-nolibc/m68k-linux/bin/m68k-linux-gcc'
 276       - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/usr/bin'
 277 Tool chain test:  OK, arch='m68k', priority 4
 278    - scanning path '/toolchains/gcc-4.9.0-nolibc/powerpc-linux'
 279       - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/.'
 280       - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin'
 281          - found '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc'
 282       - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/usr/bin'
 283 Tool chain test:  OK, arch='powerpc', priority 4
 284    - scanning path '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux'
 285       - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/.'
 286       - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin'
 287          - found '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin/bfin-uclinux-gcc'
 288       - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/usr/bin'
 289 Tool chain test:  OK, arch='bfin', priority 6
 290    - scanning path '/toolchains/gcc-4.6.3-nolibc/sparc-linux'
 291       - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/.'
 292       - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin'
 293          - found '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin/sparc-linux-gcc'
 294       - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/usr/bin'
 295 Tool chain test:  OK, arch='sparc', priority 4
 296 Toolchain '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin/sparc-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'sparc' has priority 4
 297    - scanning path '/toolchains/gcc-4.6.3-nolibc/mips-linux'
 298       - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/.'
 299       - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin'
 300          - found '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin/mips-linux-gcc'
 301       - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/usr/bin'
 302 Tool chain test:  OK, arch='mips', priority 4
 303 Toolchain '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin/mips-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'mips' has priority 4
 304    - scanning path '/toolchains/gcc-4.6.3-nolibc/m68k-linux'
 305       - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/.'
 306       - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin'
 307          - found '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin/m68k-linux-gcc'
 308       - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/usr/bin'
 309 Tool chain test:  OK, arch='m68k', priority 4
 310 Toolchain '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin/m68k-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'm68k' has priority 4
 311    - scanning path '/toolchains/gcc-4.6.3-nolibc/powerpc-linux'
 312       - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/.'
 313       - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/bin'
 314          - found '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/bin/powerpc-linux-gcc'
 315       - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/usr/bin'
 316 Tool chain test:  OK, arch='powerpc', priority 4
 317 Tool chain test:  OK, arch='or32', priority 4
 318    - scanning path '/toolchains/gcc-4.2.4-nolibc/avr32-linux'
 319       - looking in '/toolchains/gcc-4.2.4-nolibc/avr32-linux/.'
 320       - looking in '/toolchains/gcc-4.2.4-nolibc/avr32-linux/bin'
 321          - found '/toolchains/gcc-4.2.4-nolibc/avr32-linux/bin/avr32-linux-gcc'
 322       - looking in '/toolchains/gcc-4.2.4-nolibc/avr32-linux/usr/bin'
 323 Tool chain test:  OK, arch='avr32', priority 4
 324    - scanning path '/'
 325       - looking in '/.'
 326       - looking in '/bin'
 327       - looking in '/usr/bin'
 328          - found '/usr/bin/i586-mingw32msvc-gcc'
 329          - found '/usr/bin/c89-gcc'
 330          - found '/usr/bin/x86_64-linux-gnu-gcc'
 331          - found '/usr/bin/gcc'
 332          - found '/usr/bin/c99-gcc'
 333          - found '/usr/bin/arm-linux-gnueabi-gcc'
 334          - found '/usr/bin/aarch64-linux-gnu-gcc'
 335          - found '/usr/bin/winegcc'
 336          - found '/usr/bin/arm-linux-gnueabihf-gcc'
 337 Tool chain test:  OK, arch='i586', priority 11
 338 Tool chain test:  OK, arch='c89', priority 11
 339 Tool chain test:  OK, arch='x86_64', priority 4
 340 Toolchain '/usr/bin/x86_64-linux-gnu-gcc' at priority 4 will be ignored because another toolchain for arch 'x86_64' has priority 4
 341 Tool chain test:  OK, arch='sandbox', priority 11
 342 Tool chain test:  OK, arch='c99', priority 11
 343 Tool chain test:  OK, arch='arm', priority 4
 344 Toolchain '/usr/bin/arm-linux-gnueabi-gcc' at priority 4 will be ignored because another toolchain for arch 'arm' has priority 1
 345 Tool chain test:  OK, arch='aarch64', priority 4
 346 Toolchain '/usr/bin/aarch64-linux-gnu-gcc' at priority 4 will be ignored because another toolchain for arch 'aarch64' has priority 4
 347 Tool chain test:  OK, arch='sandbox', priority 11
 348 Toolchain '/usr/bin/winegcc' at priority 11 will be ignored because another toolchain for arch 'sandbox' has priority 11
 349 Tool chain test:  OK, arch='arm', priority 4
 350 Toolchain '/usr/bin/arm-linux-gnueabihf-gcc' at priority 4 will be ignored because another toolchain for arch 'arm' has priority 1
 351 List of available toolchains (34):
 352 aarch64   : /toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc
 353 alpha     : /toolchains/gcc-4.9.0-nolibc/alpha-linux/bin/alpha-linux-gcc
 354 am33_2.0  : /toolchains/gcc-4.9.0-nolibc/am33_2.0-linux/bin/am33_2.0-linux-gcc
 355 arm       : /opt/arm-eabi-4.6/bin/arm-eabi-gcc
 356 avr32     : /toolchains/gcc-4.2.4-nolibc/avr32-linux/bin/avr32-linux-gcc
 357 bfin      : /toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin/bfin-uclinux-gcc
 358 c89       : /usr/bin/c89-gcc
 359 c99       : /usr/bin/c99-gcc
 360 frv       : /toolchains/gcc-4.9.0-nolibc/frv-linux/bin/frv-linux-gcc
 361 h8300     : /toolchains/gcc-4.9.0-nolibc/h8300-elf/bin/h8300-elf-gcc
 362 hppa      : /toolchains/gcc-4.9.0-nolibc/hppa-linux/bin/hppa-linux-gcc
 363 hppa64    : /toolchains/gcc-4.9.0-nolibc/hppa64-linux/bin/hppa64-linux-gcc
 364 i386      : /toolchains/gcc-4.9.0-nolibc/i386-linux/bin/i386-linux-gcc
 365 i586      : /usr/bin/i586-mingw32msvc-gcc
 366 ia64      : /toolchains/gcc-4.9.0-nolibc/ia64-linux/bin/ia64-linux-gcc
 367 m32r      : /toolchains/gcc-4.9.0-nolibc/m32r-linux/bin/m32r-linux-gcc
 368 m68k      : /toolchains/gcc-4.9.0-nolibc/m68k-linux/bin/m68k-linux-gcc
 369 microblaze: /toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc
 370 mips      : /toolchains/gcc-4.9.0-nolibc/mips-linux/bin/mips-linux-gcc
 371 mips64    : /toolchains/gcc-4.9.0-nolibc/mips64-linux/bin/mips64-linux-gcc
 372 or32      : /toolchains/gcc-4.5.1-nolibc/or32-linux/bin/or32-linux-gcc
 373 powerpc   : /toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc
 374 powerpc64 : /toolchains/gcc-4.9.0-nolibc/powerpc64-linux/bin/powerpc64-linux-gcc
 375 ppc64le   : /toolchains/gcc-4.9.0-nolibc/ppc64le-linux/bin/ppc64le-linux-gcc
 376 s390x     : /toolchains/gcc-4.9.0-nolibc/s390x-linux/bin/s390x-linux-gcc
 377 sandbox   : /usr/bin/gcc
 378 sh4       : /toolchains/gcc-4.6.3-nolibc/sh4-linux/bin/sh4-linux-gcc
 379 sparc     : /toolchains/gcc-4.9.0-nolibc/sparc-linux/bin/sparc-linux-gcc
 380 sparc64   : /toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin/sparc64-linux-gcc
 381 tilegx    : /toolchains/gcc-4.6.2-nolibc/tilegx-linux/bin/tilegx-linux-gcc
 382 x86       : /opt/gcc-4.6.3-nolibc/x86_64-linux/bin/x86_64-linux-gcc
 383 x86_64    : /toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc
 384
 385
 386 You can see that everything is covered, even some strange ones that won't
 387 be used (c88 and c99). This is a feature.
 388
 389
 390 5. Install new toolchains if needed
 391
 392 You can download toolchains and update the [toolchain] section of the
 393 settings file to find them.
 394
 395 To make this easier, buildman can automatically download and install
 396 toolchains from kernel.org. First list the available architectures:
 397
 398 $ ./tools/buildman/buildman --fetch-arch list
 399 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.3/
 400 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.2/
 401 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1/
 402 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.2.4/
 403 Available architectures: alpha am33_2.0 arm avr32 bfin cris crisv32 frv h8300
 404 hppa hppa64 i386 ia64 m32r m68k mips mips64 or32 powerpc powerpc64 s390x sh4
 405 sparc sparc64 tilegx x86_64 xtensa
 406
 407 Then pick one and download it:
 408
 409 $ ./tools/buildman/buildman --fetch-arch or32
 410 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.3/
 411 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.2/
 412 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1/
 413 Downloading: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1//x86_64-gcc-4.5.1-nolibc_or32-linux.tar.xz
 414 Unpacking to: /home/sjg/.buildman-toolchains
 415 Testing
 416       - looking in '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/.'
 417       - looking in '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/bin'
 418          - found '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/bin/or32-linux-gcc'
 419 Tool chain test:  OK
 420
 421 Or download them all from kernel.org and move them to /toolchains directory,
 422
 423 $ for i in aarch64 arm avr32 i386 m68k microblaze mips or32 powerpc sparc
 424   do
 425   ./tools/buildman/buildman --fetch-arch $i
 426   done
 427 $ sudo mkdir -p /toolchains
 428 $ sudo mv ~/.buildman-toolchains/*/* /toolchains/
 429
 430 For those not available from kernel.org, download from the following links.
 431
 432 arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases/
 433     arc_gnu_2015.06_prebuilt_uclibc_le_archs_linux_install.tar.gz
 434 blackfin: http://sourceforge.net/projects/adi-toolchain/files/
 435     blackfin-toolchain-elf-gcc-4.5-2014R1_45-RC2.x86_64.tar.bz2
 436 nds32: http://osdk.andestech.com/packages/
 437     nds32le-linux-glibc-v1.tgz
 438 nios2: http://sourcery.mentor.com/public/gnu_toolchain/nios2-linux-gnu/
 439     sourceryg++-2015.11-27-nios2-linux-gnu-i686-pc-linux-gnu.tar.bz2
 440 sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu/
 441     renesas-4.4-200-sh-linux-gnu-i686-pc-linux-gnu.tar.bz2
 442
 443 Note openrisc kernel.org toolchain is out of date, download latest one from
 444 http://opencores.org/or1k/OpenRISC_GNU_tool_chain#Prebuilt_versions, eg:
 445 ftp://ocuser:ocuser@openrisc.opencores.org/toolchain/gcc-or1k-elf-4.8.1-x86.tar.bz2.
 446
 447 Buildman should now be set up to use your new toolchain.
 448
 449 At the time of writing, U-Boot has these architectures:
 450
 451    arc, arm, avr32, blackfin, m68k, microblaze, mips, nds32, nios2, openrisc
 452    powerpc, sandbox, sh, sparc, x86
 453
 454 Of these, only arc and nds32 are not available at kernel.org..
 455
 456
 457 How to run it
 458 =============
 459
 460 First do a dry run using the -n flag: (replace <branch> with a real, local
 461 branch with a valid upstream)
 462
 463 $ ./tools/buildman/buildman -b <branch> -n
 464
 465 If it can't detect the upstream branch, try checking out the branch, and
 466 doing something like 'git branch --set-upstream-to upstream/master'
 467 or something similar. Buildman will try to guess a suitable upstream branch
 468 if it can't find one (you will see a message like" Guessing upstream as ...).
 469
 470 As an example:
 471
 472 Dry run, so not doing much. But I would do this:
 473
 474 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
 475 Build directory: ../lcd9b
 476     5bb3505 Merge branch 'master' of git://git.denx.de/u-boot-arm
 477     c18f1b4 tegra: Use const for pinmux_config_pingroup/table()
 478     2f043ae tegra: Add display support to funcmux
 479     e349900 tegra: fdt: Add pwm binding and node
 480     424a5f0 tegra: fdt: Add LCD definitions for Tegra
 481     0636ccf tegra: Add support for PWM
 482     a994fe7 tegra: Add SOC support for display/lcd
 483     fcd7350 tegra: Add LCD driver
 484     4d46e9d tegra: Add LCD support to Nvidia boards
 485     991bd48 arm: Add control over cachability of memory regions
 486     54e8019 lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
 487     d92aff7 lcd: Add support for flushing LCD fb from dcache after update
 488     dbd0677 tegra: Align LCD frame buffer to section boundary
 489     0cff9b8 tegra: Support control of cache settings for LCD
 490     9c56900 tegra: fdt: Add LCD definitions for Seaboard
 491     5cc29db lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 492     cac5a23 tegra: Enable display/lcd support on Seaboard
 493     49ff541 wip
 494
 495 Total boards to build for each commit: 1059
 496
 497 This shows that it will build all 1059 boards, using 4 threads (because
 498 we have a 4-core CPU). Each thread will run with -j1, meaning that each
 499 make job will use a single CPU. The list of commits to be built helps you
 500 confirm that things look about right. Notice that buildman has chosen a
 501 'base' directory for you, immediately above your source tree.
 502
 503 Buildman works entirely inside the base directory, here ../lcd9b,
 504 creating a working directory for each thread, and creating output
 505 directories for each commit and board.
 506
 507
 508 Suggested Workflow
 509 ==================
 510
 511 To run the build for real, take off the -n:
 512
 513 $ ./tools/buildman/buildman -b <branch>
 514
 515 Buildman will set up some working directories, and get started. After a
 516 minute or so it will settle down to a steady pace, with a display like this:
 517
 518 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
 519   528   36  124 /19062  1:13:30  : SIMPC8313_SP
 520
 521 This means that it is building 19062 board/commit combinations. So far it
 522 has managed to successfully build 528. Another 36 have built with warnings,
 523 and 124 more didn't build at all. Buildman expects to complete the process
 524 in an hour and 15 minutes. Use this time to buy a faster computer.
 525
 526
 527 To find out how the build went, ask for a summary with -s. You can do this
 528 either before the build completes (presumably in another terminal) or
 529 afterwards. Let's work through an example of how this is used:
 530
 531 $ ./tools/buildman/buildman -b lcd9b -s
 532 ...
 533 01: Merge branch 'master' of git://git.denx.de/u-boot-arm
 534    powerpc:   + galaxy5200_LOWBOOT
 535 02: tegra: Use const for pinmux_config_pingroup/table()
 536 03: tegra: Add display support to funcmux
 537 04: tegra: fdt: Add pwm binding and node
 538 05: tegra: fdt: Add LCD definitions for Tegra
 539 06: tegra: Add support for PWM
 540 07: tegra: Add SOC support for display/lcd
 541 08: tegra: Add LCD driver
 542 09: tegra: Add LCD support to Nvidia boards
 543 10: arm: Add control over cachability of memory regions
 544 11: lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
 545 12: lcd: Add support for flushing LCD fb from dcache after update
 546        arm:   + lubbock
 547 13: tegra: Align LCD frame buffer to section boundary
 548 14: tegra: Support control of cache settings for LCD
 549 15: tegra: fdt: Add LCD definitions for Seaboard
 550 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 551 17: tegra: Enable display/lcd support on Seaboard
 552 18: wip
 553
 554 This shows which commits have succeeded and which have failed. In this case
 555 the build is still in progress so many boards are not built yet (use -u to
 556 see which ones). But still we can see a few failures. The galaxy5200_LOWBOOT
 557 never builds correctly. This could be a problem with our toolchain, or it
 558 could be a bug in the upstream. The good news is that we probably don't need
 559 to blame our commits. The bad news is it isn't tested on that board.
 560
 561 Commit 12 broke lubbock. That's what the '+ lubbock' means. The failure
 562 is never fixed by a later commit, or you would see lubbock again, in green,
 563 without the +.
 564
 565 To see the actual error:
 566
 567 $ ./tools/buildman/buildman -b <branch> -se lubbock
 568 ...
 569 12: lcd: Add support for flushing LCD fb from dcache after update
 570        arm:   + lubbock
 571 +common/libcommon.o: In function `lcd_sync':
 572 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
 573 +arm-none-linux-gnueabi-ld: BFD (Sourcery G++ Lite 2010q1-202) 2.19.51.20090709 assertion fail /scratch/julian/2010q1-release-linux-lite/obj/binutils-src-2010q1-202-arm-none-linux-gnueabi-i686-pc-linux-gnu/bfd/elf32-arm.c:12572
 574 +make: *** [/u-boot/lcd9b/.bm-work/00/build/u-boot] Error 139
 575 13: tegra: Align LCD frame buffer to section boundary
 576 14: tegra: Support control of cache settings for LCD
 577 15: tegra: fdt: Add LCD definitions for Seaboard
 578 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 579 -/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
 580 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:125: undefined reference to `flush_dcache_range'
 581 17: tegra: Enable display/lcd support on Seaboard
 582 18: wip
 583
 584 So the problem is in lcd.c, due to missing cache operations. This information
 585 should be enough to work out what that commit is doing to break these
 586 boards. (In this case pxa did not have cache operations defined).
 587
 588 If you see error lines marked with - that means that the errors were fixed
 589 by that commit. Sometimes commits can be in the wrong order, so that a
 590 breakage is introduced for a few commits and fixed by later commits. This
 591 shows up clearly with buildman. You can then reorder the commits and try
 592 again.
 593
 594 At commit 16, the error moves - you can see that the old error at line 120
 595 is fixed, but there is a new one at line 126. This is probably only because
 596 we added some code and moved the broken line further down the file.
 597
 598 If many boards have the same error, then -e will display the error only
 599 once. This makes the output as concise as possible. To see which boards have
 600 each error, use -l.
 601
 602 Buildman tries to distinguish warnings from errors, and shows warning lines
 603 separately with a 'w' prefix.
 604
 605 The full build output in this case is available in:
 606
 607 ../lcd9b/12_of_18_gd92aff7_lcd--Add-support-for/lubbock/
 608
 609    done: Indicates the build was done, and holds the return code from make.
 610          This is 0 for a good build, typically 2 for a failure.
 611
 612    err:  Output from stderr, if any. Errors and warnings appear here.
 613
 614    log:  Output from stdout. Normally there isn't any since buildman runs
 615          in silent mode for now.
 616
 617    toolchain: Shows information about the toolchain used for the build.
 618
 619    sizes: Shows image size information.
 620
 621 It is possible to get the build output there also. Use the -k option for
 622 this. In that case you will also see some output files, like:
 623
 624    System.map  toolchain  u-boot  u-boot.bin  u-boot.map  autoconf.mk
 625    (also SPL versions u-boot-spl and u-boot-spl.bin if available)
 626
 627
 628 Checking Image Sizes
 629 ====================
 630
 631 A key requirement for U-Boot is that you keep code/data size to a minimum.
 632 Where a new feature increases this noticeably it should normally be put
 633 behind a CONFIG flag so that boards can leave it off and keep the image
 634 size more or less the same with each new release.
 635
 636 To check the impact of your commits on image size, use -S. For example:
 637
 638 $ ./tools/buildman/buildman -b us-x86 -sS
 639 Summary of 10 commits for 1066 boards (4 threads, 1 job per thread)
 640 01: MAKEALL: add support for per architecture toolchains
 641 02: x86: Add function to get top of usable ram
 642        x86: (for 1/3 boards)  text -272.0  rodata +41.0
 643 03: x86: Add basic cache operations
 644 04: x86: Permit bootstage and timer data to be used prior to relocation
 645        x86: (for 1/3 boards)  data +16.0
 646 05: x86: Add an __end symbol to signal the end of the U-Boot binary
 647        x86: (for 1/3 boards)  text +76.0
 648 06: x86: Rearrange the output input to remove BSS
 649        x86: (for 1/3 boards)  bss -2140.0
 650 07: x86: Support relocation of FDT on start-up
 651        x86: +   coreboot-x86
 652 08: x86: Add error checking to x86 relocation code
 653 09: x86: Adjust link device tree include file
 654 10: x86: Enable CONFIG_OF_CONTROL on coreboot
 655
 656
 657 You can see that image size only changed on x86, which is good because this
 658 series is not supposed to change any other board. From commit 7 onwards the
 659 build fails so we don't get code size numbers. The numbers are fractional
 660 because they are an average of all boards for that architecture. The
 661 intention is to allow you to quickly find image size problems introduced by
 662 your commits.
 663
 664 Note that the 'text' region and 'rodata' are split out. You should add the
 665 two together to get the total read-only size (reported as the first column
 666 in the output from binutil's 'size' utility).
 667
 668 A useful option is --step which lets you skip some commits. For example
 669 --step 2 will show the image sizes for only every 2nd commit (so it will
 670 compare the image sizes of the 1st, 3rd, 5th... commits). You can also use
 671 --step 0 which will compare only the first and last commits. This is useful
 672 for an overview of how your entire series affects code size.
 673
 674 You can also use -d to see a detailed size breakdown for each board. This
 675 list is sorted in order from largest growth to largest reduction.
 676
 677 It is possible to go a little further with the -B option (--bloat). This
 678 shows where U-Boot has bloated, breaking the size change down to the function
 679 level. Example output is below:
 680
 681 $ ./tools/buildman/buildman -b us-mem4 -sSdB
 682 ...
 683 19: Roll crc32 into hash infrastructure
 684        arm: (for 10/10 boards)  all -143.4  bss +1.2  data -4.8  rodata -48.2 text -91.6
 685             paz00          :  all +23  bss -4  rodata -29  text +56
 686                u-boot: add: 1/0, grow: 3/-2 bytes: 168/-104 (64)
 687                  function                                   old     new   delta
 688                  hash_command                                80     160     +80
 689                  crc32_wd_buf                                 -      56     +56
 690                  ext4fs_read_file                           540     568     +28
 691                  insert_var_value_sub                       688     692      +4
 692                  run_list_real                             1996    1992      -4
 693                  do_mem_crc                                 168      68    -100
 694             trimslice      :  all -9  bss +16  rodata -29  text +4
 695                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 696                  function                                   old     new   delta
 697                  hash_command                                80     160     +80
 698                  crc32_wd_buf                                 -      56     +56
 699                  ext4fs_iterate_dir                         672     668      -4
 700                  ext4fs_read_file                           568     548     -20
 701                  do_mem_crc                                 168      68    -100
 702             whistler       :  all -9  bss +16  rodata -29  text +4
 703                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 704                  function                                   old     new   delta
 705                  hash_command                                80     160     +80
 706                  crc32_wd_buf                                 -      56     +56
 707                  ext4fs_iterate_dir                         672     668      -4
 708                  ext4fs_read_file                           568     548     -20
 709                  do_mem_crc                                 168      68    -100
 710             seaboard       :  all -9  bss -28  rodata -29  text +48
 711                u-boot: add: 1/0, grow: 3/-2 bytes: 160/-104 (56)
 712                  function                                   old     new   delta
 713                  hash_command                                80     160     +80
 714                  crc32_wd_buf                                 -      56     +56
 715                  ext4fs_read_file                           548     568     +20
 716                  run_list_real                             1996    2000      +4
 717                  do_nandboot                                760     756      -4
 718                  do_mem_crc                                 168      68    -100
 719             colibri_t20    :  all -9  rodata -29  text +20
 720                u-boot: add: 1/0, grow: 2/-3 bytes: 140/-112 (28)
 721                  function                                   old     new   delta
 722                  hash_command                                80     160     +80
 723                  crc32_wd_buf                                 -      56     +56
 724                  read_abs_bbt                               204     208      +4
 725                  do_nandboot                                760     756      -4
 726                  ext4fs_read_file                           576     568      -8
 727                  do_mem_crc                                 168      68    -100
 728             ventana        :  all -37  bss -12  rodata -29  text +4
 729                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 730                  function                                   old     new   delta
 731                  hash_command                                80     160     +80
 732                  crc32_wd_buf                                 -      56     +56
 733                  ext4fs_iterate_dir                         672     668      -4
 734                  ext4fs_read_file                           568     548     -20
 735                  do_mem_crc                                 168      68    -100
 736             harmony        :  all -37  bss -16  rodata -29  text +8
 737                u-boot: add: 1/0, grow: 2/-3 bytes: 140/-124 (16)
 738                  function                                   old     new   delta
 739                  hash_command                                80     160     +80
 740                  crc32_wd_buf                                 -      56     +56
 741                  nand_write_oob_syndrome                    428     432      +4
 742                  ext4fs_iterate_dir                         672     668      -4
 743                  ext4fs_read_file                           568     548     -20
 744                  do_mem_crc                                 168      68    -100
 745             medcom-wide    :  all -417  bss +28  data -16  rodata -93  text -336
 746                u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
 747                  function                                   old     new   delta
 748                  crc32_wd_buf                                 -      56     +56
 749                  do_fat_read_at                            2872    2904     +32
 750                  hash_algo                                   16       -     -16
 751                  do_mem_crc                                 168      68    -100
 752                  hash_command                               420     160    -260
 753             tec            :  all -449  bss -4  data -16  rodata -93  text -336
 754                u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
 755                  function                                   old     new   delta
 756                  crc32_wd_buf                                 -      56     +56
 757                  do_fat_read_at                            2872    2904     +32
 758                  hash_algo                                   16       -     -16
 759                  do_mem_crc                                 168      68    -100
 760                  hash_command                               420     160    -260
 761             plutux         :  all -481  bss +16  data -16  rodata -93  text -388
 762                u-boot: add: 1/-1, grow: 1/-3 bytes: 68/-408 (-340)
 763                  function                                   old     new   delta
 764                  crc32_wd_buf                                 -      56     +56
 765                  do_load_serial_bin                        1688    1700     +12
 766                  hash_algo                                   16       -     -16
 767                  do_fat_read_at                            2904    2872     -32
 768                  do_mem_crc                                 168      68    -100
 769                  hash_command                               420     160    -260
 770    powerpc: (for 5/5 boards)  all +37.4  data -3.2  rodata -41.8  text +82.4
 771             MPC8610HPCD    :  all +55  rodata -29  text +84
 772                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 773                  function                                   old     new   delta
 774                  hash_command                                 -     176    +176
 775                  do_mem_crc                                 184      88     -96
 776             MPC8641HPCN    :  all +55  rodata -29  text +84
 777                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 778                  function                                   old     new   delta
 779                  hash_command                                 -     176    +176
 780                  do_mem_crc                                 184      88     -96
 781             MPC8641HPCN_36BIT:  all +55  rodata -29  text +84
 782                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 783                  function                                   old     new   delta
 784                  hash_command                                 -     176    +176
 785                  do_mem_crc                                 184      88     -96
 786             sbc8641d       :  all +55  rodata -29  text +84
 787                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 788                  function                                   old     new   delta
 789                  hash_command                                 -     176    +176
 790                  do_mem_crc                                 184      88     -96
 791             xpedite517x    :  all -33  data -16  rodata -93  text +76
 792                u-boot: add: 1/-1, grow: 0/-1 bytes: 176/-112 (64)
 793                  function                                   old     new   delta
 794                  hash_command                                 -     176    +176
 795                  hash_algo                                   16       -     -16
 796                  do_mem_crc                                 184      88     -96
 797 ...
 798
 799
 800 This shows that commit 19 has increased text size for arm (although only one
 801 board was built) and by 96 bytes for powerpc. This increase was offset in both
 802 cases by reductions in rodata and data/bss.
 803
 804 Shown below the summary lines are the sizes for each board. Below each board
 805 are the sizes for each function. This information starts with:
 806
 807    add - number of functions added / removed
 808    grow - number of functions which grew / shrunk
 809    bytes - number of bytes of code added to / removed from all functions,
 810             plus the total byte change in brackets
 811
 812 The change seems to be that hash_command() has increased by more than the
 813 do_mem_crc() function has decreased. The function sizes typically add up to
 814 roughly the text area size, but note that every read-only section except
 815 rodata is included in 'text', so the function total does not exactly
 816 correspond.
 817
 818 It is common when refactoring code for the rodata to decrease as the text size
 819 increases, and vice versa.
 820
 821
 822 The .buildman file
 823 ==================
 824
 825 The .buildman file provides information about the available toolchains and
 826 also allows build flags to be passed to 'make'. It consists of several
 827 sections, with the section name in square brackets. Within each section are
 828 a set of (tag, value) pairs.
 829
 830 '[toolchain]' section
 831
 832     This lists the available toolchains. The tag here doesn't matter, but
 833     make sure it is unique. The value is the path to the toolchain. Buildman
 834     will look in that path for a file ending in 'gcc'. It will then execute
 835     it to check that it is a C compiler, passing only the --version flag to
 836     it. If the return code is 0, buildman assumes that it is a valid C
 837     compiler. It uses the first part of the name as the architecture and
 838     strips off the last part when setting the CROSS_COMPILE environment
 839     variable (parts are delimited with a hyphen).
 840
 841     For example powerpc-linux-gcc will be noted as a toolchain for 'powerpc'
 842     and CROSS_COMPILE will be set to powerpc-linux- when using it.
 843
 844 '[toolchain-alias]' section
 845
 846     This converts toolchain architecture names to U-Boot names. For example,
 847     if an x86 toolchains is called i386-linux-gcc it will not normally be
 848     used for architecture 'x86'. Adding 'x86: i386 x86_64' to this section
 849     will tell buildman that the i386 and x86_64 toolchains can be used for
 850     the x86 architecture.
 851
 852 '[make-flags]' section
 853
 854     U-Boot's build system supports a few flags (such as BUILD_TAG) which
 855     affect the build product. These flags can be specified in the buildman
 856     settings file. They can also be useful when building U-Boot against other
 857     open source software.
 858
 859     [make-flags]
 860     at91-boards=ENABLE_AT91_TEST=1
 861     snapper9260=${at91-boards} BUILD_TAG=442
 862     snapper9g45=${at91-boards} BUILD_TAG=443
 863
 864     This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
 865     and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
 866     variable ${target} is available to access the target name (snapper9260
 867     and snapper9g20 in this case). Variables are resolved recursively. Note
 868     that variables can only contain the characters A-Z, a-z, 0-9, hyphen (-)
 869     and underscore (_).
 870
 871     It is expected that any variables added are dealt with in U-Boot's
 872     config.mk file and documented in the README.
 873
 874     Note that you can pass ad-hoc options to the build using environment
 875     variables, for example:
 876
 877        SOME_OPTION=1234 ./tools/buildman/buildman my_board
 878
 879
 880 Quick Sanity Check
 881 ==================
 882
 883 If you have made changes and want to do a quick sanity check of the
 884 currently checked-out source, run buildman without the -b flag. This will
 885 build the selected boards and display build status as it runs (i.e. -v is
 886 enabled automatically). Use -e to see errors/warnings as well.
 887
 888
 889 Building Ranges
 890 ===============
 891
 892 You can build a range of commits by specifying a range instead of a branch
 893 when using the -b flag. For example:
 894
 895     upstream/master..us-buildman
 896
 897 will build commits in us-buildman that are not in upstream/master.
 898
 899
 900 Other options
 901 =============
 902
 903 Buildman has various other command line options. Try --help to see them.
 904
 905 When doing builds, Buildman's return code will reflect the overall result:
 906
 907     0 (success)     No errors or warnings found
 908     128             Errors found
 909     129             Warnings found
 910
 911
 912 How to change from MAKEALL
 913 ==========================
 914
 915 Buildman includes most of the features of MAKEALL and is generally faster
 916 and easier to use. In particular it builds entire branches: if a particular
 917 commit introduces an error in a particular board, buildman can easily show
 918 you this, even if a later commit fixes that error.
 919
 920 The reasons to deprecate MAKEALL are:
 921 - We don't want to maintain two build systems
 922 - Buildman is typically faster
 923 - Buildman has a lot more features
 924
 925 But still, many people will be sad to lose MAKEALL. If you are used to
 926 MAKEALL, here are a few pointers.
 927
 928 First you need to set up your tool chains - see the 'Setting up' section
 929 for details. Once you have your required toolchain(s) detected then you are
 930 ready to go.
 931
 932 To build the current source tree, run buildman without a -b flag:
 933
 934    ./tools/buildman/buildman <list of things to build>
 935
 936 This will build the current source tree for the given boards and display
 937 the results and errors.
 938
 939 However buildman usually works on entire branches, and for that you must
 940 specify a board flag:
 941
 942    ./tools/buildman/buildman -b <branch_name> <list of things to build>
 943
 944 followed by (afterwards, or perhaps concurrently in another terminal):
 945
 946    ./tools/buildman/buildman -b <branch_name> -s <list of things to build>
 947
 948 to see the results of the build. Rather than showing you all the output,
 949 buildman just shows a summary, with red indicating that a commit introduced
 950 an error and green indicating that a commit fixed an error. Use the -e
 951 flag to see the full errors and -l to see which boards caused which errors.
 952
 953 If you really want to see build results as they happen, use -v when doing a
 954 build (and -e to see the errors/warnings too).
 955
 956 You don't need to stick around on that branch while buildman is running. It
 957 checks out its own copy of the source code, so you can change branches,
 958 add commits, etc. without affecting the build in progress.
 959
 960 The <list of things to build> can include board names, architectures or the
 961 like. There are no flags to disambiguate since ambiguities are rare. Using
 962 the examples from MAKEALL:
 963
 964 Examples:
 965   - build all Power Architecture boards:
 966       MAKEALL -a powerpc
 967       MAKEALL --arch powerpc
 968       MAKEALL powerpc
 969           ** buildman -b <branch> powerpc
 970   - build all PowerPC boards manufactured by vendor "esd":
 971       MAKEALL -a powerpc -v esd
 972           ** buildman -b <branch> esd
 973   - build all PowerPC boards manufactured either by "keymile" or "siemens":
 974       MAKEALL -a powerpc -v keymile -v siemens
 975           ** buildman -b <branch> keymile siemens
 976   - build all Freescale boards with MPC83xx CPUs, plus all 4xx boards:
 977       MAKEALL -c mpc83xx -v freescale 4xx
 978           ** buildman -b <branch> mpc83xx freescale 4xx
 979
 980 Buildman automatically tries to use all the CPUs in your machine. If you
 981 are building a lot of boards it will use one thread for every CPU core
 982 it detects in your machine. This is like MAKEALL's BUILD_NBUILDS option.
 983 You can use the -T flag to change the number of threads. If you are only
 984 building a few boards, buildman will automatically run make with the -j
 985 flag to increase the number of concurrent make tasks. It isn't normally
 986 that helpful to fiddle with this option, but if you use the BUILD_NCPUS
 987 option in MAKEALL then -j is the equivalent in buildman.
 988
 989 Buildman puts its output in ../<branch_name> by default but you can change
 990 this with the -o option. Buildman normally does out-of-tree builds: use -i
 991 to disable that if you really want to. But be careful that once you have
 992 used -i you pollute buildman's copies of the source tree, and you will need
 993 to remove the build directory (normally ../<branch_name>) to run buildman
 994 in normal mode (without -i).
 995
 996 Buildman doesn't keep the output result normally, but use the -k option to
 997 do this.
 998
 999 Please read 'Theory of Operation' a few times as it will make a lot of
1000 things clearer.
1001
1002 Some options you might like are:
1003
1004    -B shows which functions are growing/shrinking in which commit - great
1005         for finding code bloat.
1006    -S shows image sizes for each commit (just an overall summary)
1007    -u shows boards that you haven't built yet
1008    --step 0 will build just the upstream commit and the last commit of your
1009         branch. This is often a quick sanity check that your branch doesn't
1010         break anything. But note this does not check bisectability!
1011
1012
1013 TODO
1014 ====
1015
1016 This has mostly be written in my spare time as a response to my difficulties
1017 in testing large series of patches. Apart from tidying up there is quite a
1018 bit of scope for improvement. Things like better error diffs and easier
1019 access to log files. Also it would be nice if buildman could 'hunt' for
1020 problems, perhaps by building a few boards for each arch, or checking
1021 commits for changed files and building only boards which use those files.
1022
1023
1024 Credits
1025 =======
1026
1027 Thanks to Grant Grundler <grundler@chromium.org> for his ideas for improving
1028 the build speed by building all commits for a board instead of the other
1029 way around.
1030
1031
1032 Simon Glass
1033 sjg@chromium.org
1034 Halloween 2012
1035 Updated 12-12-12
1036 Updated 23-02-13