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