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.
214 3. Make sure you have the require Python pre-requisites
216 Buildman uses multiprocessing, Queue, shutil, StringIO, ConfigParser and
217 urllib2. These should normally be available, but if you get an error like
218 this then you will need to obtain those modules:
220 ImportError: No module named multiprocessing
223 4. Check the available toolchains
225 Run this check to make sure that you have a toolchain for every architecture.
227 $ ./tools/buildman/buildman --list-tool-chains
228 Scanning for tool chains
229 - scanning prefix '/opt/gcc-4.6.3-nolibc/x86_64-linux/bin/x86_64-linux-'
230 Tool chain test: OK, arch='x86', priority 1
231 - scanning prefix '/opt/arm-eabi-4.6/bin/arm-eabi-'
232 Tool chain test: OK, arch='arm', priority 1
233 - scanning path '/toolchains/gcc-4.9.0-nolibc/i386-linux'
234 - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/.'
235 - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/bin'
236 - found '/toolchains/gcc-4.9.0-nolibc/i386-linux/bin/i386-linux-gcc'
237 - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/usr/bin'
238 Tool chain test: OK, arch='i386', priority 4
239 - scanning path '/toolchains/gcc-4.9.0-nolibc/aarch64-linux'
240 - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/.'
241 - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin'
242 - found '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc'
243 - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/usr/bin'
244 Tool chain test: OK, arch='aarch64', priority 4
245 - scanning path '/toolchains/gcc-4.9.0-nolibc/microblaze-linux'
246 - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/.'
247 - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin'
248 - found '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc'
249 - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/usr/bin'
250 Tool chain test: OK, arch='microblaze', priority 4
251 - scanning path '/toolchains/gcc-4.9.0-nolibc/mips64-linux'
252 - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/.'
253 - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/bin'
254 - found '/toolchains/gcc-4.9.0-nolibc/mips64-linux/bin/mips64-linux-gcc'
255 - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/usr/bin'
256 Tool chain test: OK, arch='mips64', priority 4
257 - scanning path '/toolchains/gcc-4.9.0-nolibc/sparc64-linux'
258 - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/.'
259 - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin'
260 - found '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin/sparc64-linux-gcc'
261 - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/usr/bin'
262 Tool chain test: OK, arch='sparc64', priority 4
263 - scanning path '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi'
264 - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/.'
265 - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin'
266 - found '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin/arm-unknown-linux-gnueabi-gcc'
267 - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/usr/bin'
268 Tool chain test: OK, arch='arm', priority 3
269 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
270 - scanning path '/toolchains/gcc-4.9.0-nolibc/sparc-linux'
271 - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/.'
272 - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/bin'
273 - found '/toolchains/gcc-4.9.0-nolibc/sparc-linux/bin/sparc-linux-gcc'
274 - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/usr/bin'
275 Tool chain test: OK, arch='sparc', priority 4
276 - scanning path '/toolchains/gcc-4.9.0-nolibc/mips-linux'
277 - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/.'
278 - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/bin'
279 - found '/toolchains/gcc-4.9.0-nolibc/mips-linux/bin/mips-linux-gcc'
280 - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/usr/bin'
281 Tool chain test: OK, arch='mips', priority 4
282 - scanning path '/toolchains/gcc-4.9.0-nolibc/x86_64-linux'
283 - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/.'
284 - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin'
285 - found '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc'
286 - found '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-x86_64-linux-gcc'
287 - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/usr/bin'
288 Tool chain test: OK, arch='x86_64', priority 4
289 Tool chain test: OK, arch='x86_64', priority 4
290 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
291 - scanning path '/toolchains/gcc-4.9.0-nolibc/m68k-linux'
292 - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/.'
293 - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/bin'
294 - found '/toolchains/gcc-4.9.0-nolibc/m68k-linux/bin/m68k-linux-gcc'
295 - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/usr/bin'
296 Tool chain test: OK, arch='m68k', priority 4
297 - scanning path '/toolchains/gcc-4.9.0-nolibc/powerpc-linux'
298 - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/.'
299 - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin'
300 - found '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc'
301 - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/usr/bin'
302 Tool chain test: OK, arch='powerpc', priority 4
303 - scanning path '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux'
304 - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/.'
305 - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin'
306 - found '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin/bfin-uclinux-gcc'
307 - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/usr/bin'
308 Tool chain test: OK, arch='bfin', priority 6
309 - scanning path '/toolchains/gcc-4.6.3-nolibc/sparc-linux'
310 - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/.'
311 - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin'
312 - found '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin/sparc-linux-gcc'
313 - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/usr/bin'
314 Tool chain test: OK, arch='sparc', priority 4
315 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
316 - scanning path '/toolchains/gcc-4.6.3-nolibc/mips-linux'
317 - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/.'
318 - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin'
319 - found '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin/mips-linux-gcc'
320 - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/usr/bin'
321 Tool chain test: OK, arch='mips', priority 4
322 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
323 - scanning path '/toolchains/gcc-4.6.3-nolibc/m68k-linux'
324 - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/.'
325 - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin'
326 - found '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin/m68k-linux-gcc'
327 - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/usr/bin'
328 Tool chain test: OK, arch='m68k', priority 4
329 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
330 - scanning path '/toolchains/gcc-4.6.3-nolibc/powerpc-linux'
331 - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/.'
332 - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/bin'
333 - found '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/bin/powerpc-linux-gcc'
334 - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/usr/bin'
335 Tool chain test: OK, arch='powerpc', priority 4
336 Tool chain test: OK, arch='or32', priority 4
337 - scanning path '/toolchains/gcc-4.2.4-nolibc/avr32-linux'
338 - looking in '/toolchains/gcc-4.2.4-nolibc/avr32-linux/.'
339 - looking in '/toolchains/gcc-4.2.4-nolibc/avr32-linux/bin'
340 - found '/toolchains/gcc-4.2.4-nolibc/avr32-linux/bin/avr32-linux-gcc'
341 - looking in '/toolchains/gcc-4.2.4-nolibc/avr32-linux/usr/bin'
342 Tool chain test: OK, arch='avr32', priority 4
346 - looking in '/usr/bin'
347 - found '/usr/bin/i586-mingw32msvc-gcc'
348 - found '/usr/bin/c89-gcc'
349 - found '/usr/bin/x86_64-linux-gnu-gcc'
350 - found '/usr/bin/gcc'
351 - found '/usr/bin/c99-gcc'
352 - found '/usr/bin/arm-linux-gnueabi-gcc'
353 - found '/usr/bin/aarch64-linux-gnu-gcc'
354 - found '/usr/bin/winegcc'
355 - found '/usr/bin/arm-linux-gnueabihf-gcc'
356 Tool chain test: OK, arch='i586', priority 11
357 Tool chain test: OK, arch='c89', priority 11
358 Tool chain test: OK, arch='x86_64', priority 4
359 Toolchain '/usr/bin/x86_64-linux-gnu-gcc' at priority 4 will be ignored because another toolchain for arch 'x86_64' has priority 4
360 Tool chain test: OK, arch='sandbox', priority 11
361 Tool chain test: OK, arch='c99', priority 11
362 Tool chain test: OK, arch='arm', priority 4
363 Toolchain '/usr/bin/arm-linux-gnueabi-gcc' at priority 4 will be ignored because another toolchain for arch 'arm' has priority 1
364 Tool chain test: OK, arch='aarch64', priority 4
365 Toolchain '/usr/bin/aarch64-linux-gnu-gcc' at priority 4 will be ignored because another toolchain for arch 'aarch64' has priority 4
366 Tool chain test: OK, arch='sandbox', priority 11
367 Toolchain '/usr/bin/winegcc' at priority 11 will be ignored because another toolchain for arch 'sandbox' has priority 11
368 Tool chain test: OK, arch='arm', priority 4
369 Toolchain '/usr/bin/arm-linux-gnueabihf-gcc' at priority 4 will be ignored because another toolchain for arch 'arm' has priority 1
370 List of available toolchains (34):
371 aarch64 : /toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc
372 alpha : /toolchains/gcc-4.9.0-nolibc/alpha-linux/bin/alpha-linux-gcc
373 am33_2.0 : /toolchains/gcc-4.9.0-nolibc/am33_2.0-linux/bin/am33_2.0-linux-gcc
374 arm : /opt/arm-eabi-4.6/bin/arm-eabi-gcc
375 avr32 : /toolchains/gcc-4.2.4-nolibc/avr32-linux/bin/avr32-linux-gcc
376 bfin : /toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin/bfin-uclinux-gcc
377 c89 : /usr/bin/c89-gcc
378 c99 : /usr/bin/c99-gcc
379 frv : /toolchains/gcc-4.9.0-nolibc/frv-linux/bin/frv-linux-gcc
380 h8300 : /toolchains/gcc-4.9.0-nolibc/h8300-elf/bin/h8300-elf-gcc
381 hppa : /toolchains/gcc-4.9.0-nolibc/hppa-linux/bin/hppa-linux-gcc
382 hppa64 : /toolchains/gcc-4.9.0-nolibc/hppa64-linux/bin/hppa64-linux-gcc
383 i386 : /toolchains/gcc-4.9.0-nolibc/i386-linux/bin/i386-linux-gcc
384 i586 : /usr/bin/i586-mingw32msvc-gcc
385 ia64 : /toolchains/gcc-4.9.0-nolibc/ia64-linux/bin/ia64-linux-gcc
386 m32r : /toolchains/gcc-4.9.0-nolibc/m32r-linux/bin/m32r-linux-gcc
387 m68k : /toolchains/gcc-4.9.0-nolibc/m68k-linux/bin/m68k-linux-gcc
388 microblaze: /toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc
389 mips : /toolchains/gcc-4.9.0-nolibc/mips-linux/bin/mips-linux-gcc
390 mips64 : /toolchains/gcc-4.9.0-nolibc/mips64-linux/bin/mips64-linux-gcc
391 or32 : /toolchains/gcc-4.5.1-nolibc/or32-linux/bin/or32-linux-gcc
392 powerpc : /toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc
393 powerpc64 : /toolchains/gcc-4.9.0-nolibc/powerpc64-linux/bin/powerpc64-linux-gcc
394 ppc64le : /toolchains/gcc-4.9.0-nolibc/ppc64le-linux/bin/ppc64le-linux-gcc
395 s390x : /toolchains/gcc-4.9.0-nolibc/s390x-linux/bin/s390x-linux-gcc
396 sandbox : /usr/bin/gcc
397 sh4 : /toolchains/gcc-4.6.3-nolibc/sh4-linux/bin/sh4-linux-gcc
398 sparc : /toolchains/gcc-4.9.0-nolibc/sparc-linux/bin/sparc-linux-gcc
399 sparc64 : /toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin/sparc64-linux-gcc
400 tilegx : /toolchains/gcc-4.6.2-nolibc/tilegx-linux/bin/tilegx-linux-gcc
401 x86 : /opt/gcc-4.6.3-nolibc/x86_64-linux/bin/x86_64-linux-gcc
402 x86_64 : /toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc
405 You can see that everything is covered, even some strange ones that won't
406 be used (c88 and c99). This is a feature.
409 5. Install new toolchains if needed
411 You can download toolchains and update the [toolchain] section of the
412 settings file to find them.
414 To make this easier, buildman can automatically download and install
415 toolchains from kernel.org. First list the available architectures:
417 $ ./tools/buildman/buildman --fetch-arch list
418 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.3/
419 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.2/
420 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1/
421 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.2.4/
422 Available architectures: alpha am33_2.0 arm avr32 bfin cris crisv32 frv h8300
423 hppa hppa64 i386 ia64 m32r m68k mips mips64 or32 powerpc powerpc64 s390x sh4
424 sparc sparc64 tilegx x86_64 xtensa
426 Then pick one and download it:
428 $ ./tools/buildman/buildman --fetch-arch or32
429 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.3/
430 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.2/
431 Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1/
432 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
433 Unpacking to: /home/sjg/.buildman-toolchains
435 - looking in '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/.'
436 - looking in '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/bin'
437 - found '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/bin/or32-linux-gcc'
440 Or download them all from kernel.org and move them to /toolchains directory,
442 $ ./tools/buildman/buildman --fetch-arch all
443 $ sudo mkdir -p /toolchains
444 $ sudo mv ~/.buildman-toolchains/*/* /toolchains/
446 For those not available from kernel.org, download from the following links.
448 arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases/
449 arc_gnu_2015.06_prebuilt_uclibc_le_archs_linux_install.tar.gz
450 blackfin: http://sourceforge.net/projects/adi-toolchain/files/
451 blackfin-toolchain-elf-gcc-4.5-2014R1_45-RC2.x86_64.tar.bz2
452 nds32: http://osdk.andestech.com/packages/
453 nds32le-linux-glibc-v1.tgz
454 nios2: http://sourcery.mentor.com/public/gnu_toolchain/nios2-linux-gnu/
455 sourceryg++-2015.11-27-nios2-linux-gnu-i686-pc-linux-gnu.tar.bz2
456 sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu/
457 renesas-4.4-200-sh-linux-gnu-i686-pc-linux-gnu.tar.bz2
459 Note openrisc kernel.org toolchain is out of date. Download the latest one from
460 http://opencores.org/or1k/OpenRISC_GNU_tool_chain#Prebuilt_versions - eg:
461 ftp://ocuser:ocuser@openrisc.opencores.org/toolchain/gcc-or1k-elf-4.8.1-x86.tar.bz2.
463 Buildman should now be set up to use your new toolchain.
465 At the time of writing, U-Boot has these architectures:
467 arc, arm, avr32, blackfin, m68k, microblaze, mips, nds32, nios2, openrisc
468 powerpc, sandbox, sh, sparc, x86
470 Of these, only arc and nds32 are not available at kernel.org..
476 First do a dry run using the -n flag: (replace <branch> with a real, local
477 branch with a valid upstream)
479 $ ./tools/buildman/buildman -b <branch> -n
481 If it can't detect the upstream branch, try checking out the branch, and
482 doing something like 'git branch --set-upstream-to upstream/master'
483 or something similar. Buildman will try to guess a suitable upstream branch
484 if it can't find one (you will see a message like" Guessing upstream as ...).
488 Dry run, so not doing much. But I would do this:
490 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
491 Build directory: ../lcd9b
492 5bb3505 Merge branch 'master' of git://git.denx.de/u-boot-arm
493 c18f1b4 tegra: Use const for pinmux_config_pingroup/table()
494 2f043ae tegra: Add display support to funcmux
495 e349900 tegra: fdt: Add pwm binding and node
496 424a5f0 tegra: fdt: Add LCD definitions for Tegra
497 0636ccf tegra: Add support for PWM
498 a994fe7 tegra: Add SOC support for display/lcd
499 fcd7350 tegra: Add LCD driver
500 4d46e9d tegra: Add LCD support to Nvidia boards
501 991bd48 arm: Add control over cachability of memory regions
502 54e8019 lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
503 d92aff7 lcd: Add support for flushing LCD fb from dcache after update
504 dbd0677 tegra: Align LCD frame buffer to section boundary
505 0cff9b8 tegra: Support control of cache settings for LCD
506 9c56900 tegra: fdt: Add LCD definitions for Seaboard
507 5cc29db lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
508 cac5a23 tegra: Enable display/lcd support on Seaboard
511 Total boards to build for each commit: 1059
513 This shows that it will build all 1059 boards, using 4 threads (because
514 we have a 4-core CPU). Each thread will run with -j1, meaning that each
515 make job will use a single CPU. The list of commits to be built helps you
516 confirm that things look about right. Notice that buildman has chosen a
517 'base' directory for you, immediately above your source tree.
519 Buildman works entirely inside the base directory, here ../lcd9b,
520 creating a working directory for each thread, and creating output
521 directories for each commit and board.
527 To run the build for real, take off the -n:
529 $ ./tools/buildman/buildman -b <branch>
531 Buildman will set up some working directories, and get started. After a
532 minute or so it will settle down to a steady pace, with a display like this:
534 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
535 528 36 124 /19062 1:13:30 : SIMPC8313_SP
537 This means that it is building 19062 board/commit combinations. So far it
538 has managed to successfully build 528. Another 36 have built with warnings,
539 and 124 more didn't build at all. Buildman expects to complete the process
540 in around an hour and a quarter. Use this time to buy a faster computer.
543 To find out how the build went, ask for a summary with -s. You can do this
544 either before the build completes (presumably in another terminal) or
545 afterwards. Let's work through an example of how this is used:
547 $ ./tools/buildman/buildman -b lcd9b -s
549 01: Merge branch 'master' of git://git.denx.de/u-boot-arm
550 powerpc: + galaxy5200_LOWBOOT
551 02: tegra: Use const for pinmux_config_pingroup/table()
552 03: tegra: Add display support to funcmux
553 04: tegra: fdt: Add pwm binding and node
554 05: tegra: fdt: Add LCD definitions for Tegra
555 06: tegra: Add support for PWM
556 07: tegra: Add SOC support for display/lcd
557 08: tegra: Add LCD driver
558 09: tegra: Add LCD support to Nvidia boards
559 10: arm: Add control over cachability of memory regions
560 11: lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
561 12: lcd: Add support for flushing LCD fb from dcache after update
563 13: tegra: Align LCD frame buffer to section boundary
564 14: tegra: Support control of cache settings for LCD
565 15: tegra: fdt: Add LCD definitions for Seaboard
566 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
567 17: tegra: Enable display/lcd support on Seaboard
570 This shows which commits have succeeded and which have failed. In this case
571 the build is still in progress so many boards are not built yet (use -u to
572 see which ones). But still we can see a few failures. The galaxy5200_LOWBOOT
573 never builds correctly. This could be a problem with our toolchain, or it
574 could be a bug in the upstream. The good news is that we probably don't need
575 to blame our commits. The bad news is that our commits are not tested on that
578 Commit 12 broke lubbock. That's what the '+ lubbock' means. The failure
579 is never fixed by a later commit, or you would see lubbock again, in green,
582 To see the actual error:
584 $ ./tools/buildman/buildman -b <branch> -se lubbock
586 12: lcd: Add support for flushing LCD fb from dcache after update
588 +common/libcommon.o: In function `lcd_sync':
589 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
590 +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
591 +make: *** [/u-boot/lcd9b/.bm-work/00/build/u-boot] Error 139
592 13: tegra: Align LCD frame buffer to section boundary
593 14: tegra: Support control of cache settings for LCD
594 15: tegra: fdt: Add LCD definitions for Seaboard
595 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
596 -/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
597 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:125: undefined reference to `flush_dcache_range'
598 17: tegra: Enable display/lcd support on Seaboard
601 So the problem is in lcd.c, due to missing cache operations. This information
602 should be enough to work out what that commit is doing to break these
603 boards. (In this case pxa did not have cache operations defined).
605 If you see error lines marked with '-', that means that the errors were fixed
606 by that commit. Sometimes commits can be in the wrong order, so that a
607 breakage is introduced for a few commits and fixed by later commits. This
608 shows up clearly with buildman. You can then reorder the commits and try
611 At commit 16, the error moves: you can see that the old error at line 120
612 is fixed, but there is a new one at line 126. This is probably only because
613 we added some code and moved the broken line further down the file.
615 If many boards have the same error, then -e will display the error only
616 once. This makes the output as concise as possible. To see which boards have
617 each error, use -l. So it is safe to omit the board name - you will not get
618 lots of repeated output for every board.
620 Buildman tries to distinguish warnings from errors, and shows warning lines
621 separately with a 'w' prefix.
623 The full build output in this case is available in:
625 ../lcd9b/12_of_18_gd92aff7_lcd--Add-support-for/lubbock/
627 done: Indicates the build was done, and holds the return code from make.
628 This is 0 for a good build, typically 2 for a failure.
630 err: Output from stderr, if any. Errors and warnings appear here.
632 log: Output from stdout. Normally there isn't any since buildman runs
633 in silent mode. Use -V to force a verbose build (this passes V=1
636 toolchain: Shows information about the toolchain used for the build.
638 sizes: Shows image size information.
640 It is possible to get the build binary output there also. Use the -k option
641 for this. In that case you will also see some output files, like:
643 System.map toolchain u-boot u-boot.bin u-boot.map autoconf.mk
644 (also SPL versions u-boot-spl and u-boot-spl.bin if available)
650 A key requirement for U-Boot is that you keep code/data size to a minimum.
651 Where a new feature increases this noticeably it should normally be put
652 behind a CONFIG flag so that boards can leave it disabled and keep the image
653 size more or less the same with each new release.
655 To check the impact of your commits on image size, use -S. For example:
657 $ ./tools/buildman/buildman -b us-x86 -sS
658 Summary of 10 commits for 1066 boards (4 threads, 1 job per thread)
659 01: MAKEALL: add support for per architecture toolchains
660 02: x86: Add function to get top of usable ram
661 x86: (for 1/3 boards) text -272.0 rodata +41.0
662 03: x86: Add basic cache operations
663 04: x86: Permit bootstage and timer data to be used prior to relocation
664 x86: (for 1/3 boards) data +16.0
665 05: x86: Add an __end symbol to signal the end of the U-Boot binary
666 x86: (for 1/3 boards) text +76.0
667 06: x86: Rearrange the output input to remove BSS
668 x86: (for 1/3 boards) bss -2140.0
669 07: x86: Support relocation of FDT on start-up
671 08: x86: Add error checking to x86 relocation code
672 09: x86: Adjust link device tree include file
673 10: x86: Enable CONFIG_OF_CONTROL on coreboot
676 You can see that image size only changed on x86, which is good because this
677 series is not supposed to change any other board. From commit 7 onwards the
678 build fails so we don't get code size numbers. The numbers are fractional
679 because they are an average of all boards for that architecture. The
680 intention is to allow you to quickly find image size problems introduced by
683 Note that the 'text' region and 'rodata' are split out. You should add the
684 two together to get the total read-only size (reported as the first column
685 in the output from binutil's 'size' utility).
687 A useful option is --step which lets you skip some commits. For example
688 --step 2 will show the image sizes for only every 2nd commit (so it will
689 compare the image sizes of the 1st, 3rd, 5th... commits). You can also use
690 --step 0 which will compare only the first and last commits. This is useful
691 for an overview of how your entire series affects code size. It will build
692 only the upstream commit and your final branch commit.
694 You can also use -d to see a detailed size breakdown for each board. This
695 list is sorted in order from largest growth to largest reduction.
697 It is even possible to go a little further with the -B option (--bloat). This
698 shows where U-Boot has bloated, breaking the size change down to the function
699 level. Example output is below:
701 $ ./tools/buildman/buildman -b us-mem4 -sSdB
703 19: Roll crc32 into hash infrastructure
704 arm: (for 10/10 boards) all -143.4 bss +1.2 data -4.8 rodata -48.2 text -91.6
705 paz00 : all +23 bss -4 rodata -29 text +56
706 u-boot: add: 1/0, grow: 3/-2 bytes: 168/-104 (64)
707 function old new delta
708 hash_command 80 160 +80
709 crc32_wd_buf - 56 +56
710 ext4fs_read_file 540 568 +28
711 insert_var_value_sub 688 692 +4
712 run_list_real 1996 1992 -4
713 do_mem_crc 168 68 -100
714 trimslice : all -9 bss +16 rodata -29 text +4
715 u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
716 function old new delta
717 hash_command 80 160 +80
718 crc32_wd_buf - 56 +56
719 ext4fs_iterate_dir 672 668 -4
720 ext4fs_read_file 568 548 -20
721 do_mem_crc 168 68 -100
722 whistler : all -9 bss +16 rodata -29 text +4
723 u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
724 function old new delta
725 hash_command 80 160 +80
726 crc32_wd_buf - 56 +56
727 ext4fs_iterate_dir 672 668 -4
728 ext4fs_read_file 568 548 -20
729 do_mem_crc 168 68 -100
730 seaboard : all -9 bss -28 rodata -29 text +48
731 u-boot: add: 1/0, grow: 3/-2 bytes: 160/-104 (56)
732 function old new delta
733 hash_command 80 160 +80
734 crc32_wd_buf - 56 +56
735 ext4fs_read_file 548 568 +20
736 run_list_real 1996 2000 +4
737 do_nandboot 760 756 -4
738 do_mem_crc 168 68 -100
739 colibri_t20 : all -9 rodata -29 text +20
740 u-boot: add: 1/0, grow: 2/-3 bytes: 140/-112 (28)
741 function old new delta
742 hash_command 80 160 +80
743 crc32_wd_buf - 56 +56
744 read_abs_bbt 204 208 +4
745 do_nandboot 760 756 -4
746 ext4fs_read_file 576 568 -8
747 do_mem_crc 168 68 -100
748 ventana : all -37 bss -12 rodata -29 text +4
749 u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
750 function old new delta
751 hash_command 80 160 +80
752 crc32_wd_buf - 56 +56
753 ext4fs_iterate_dir 672 668 -4
754 ext4fs_read_file 568 548 -20
755 do_mem_crc 168 68 -100
756 harmony : all -37 bss -16 rodata -29 text +8
757 u-boot: add: 1/0, grow: 2/-3 bytes: 140/-124 (16)
758 function old new delta
759 hash_command 80 160 +80
760 crc32_wd_buf - 56 +56
761 nand_write_oob_syndrome 428 432 +4
762 ext4fs_iterate_dir 672 668 -4
763 ext4fs_read_file 568 548 -20
764 do_mem_crc 168 68 -100
765 medcom-wide : all -417 bss +28 data -16 rodata -93 text -336
766 u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
767 function old new delta
768 crc32_wd_buf - 56 +56
769 do_fat_read_at 2872 2904 +32
771 do_mem_crc 168 68 -100
772 hash_command 420 160 -260
773 tec : all -449 bss -4 data -16 rodata -93 text -336
774 u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
775 function old new delta
776 crc32_wd_buf - 56 +56
777 do_fat_read_at 2872 2904 +32
779 do_mem_crc 168 68 -100
780 hash_command 420 160 -260
781 plutux : all -481 bss +16 data -16 rodata -93 text -388
782 u-boot: add: 1/-1, grow: 1/-3 bytes: 68/-408 (-340)
783 function old new delta
784 crc32_wd_buf - 56 +56
785 do_load_serial_bin 1688 1700 +12
787 do_fat_read_at 2904 2872 -32
788 do_mem_crc 168 68 -100
789 hash_command 420 160 -260
790 powerpc: (for 5/5 boards) all +37.4 data -3.2 rodata -41.8 text +82.4
791 MPC8610HPCD : all +55 rodata -29 text +84
792 u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
793 function old new delta
794 hash_command - 176 +176
795 do_mem_crc 184 88 -96
796 MPC8641HPCN : all +55 rodata -29 text +84
797 u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
798 function old new delta
799 hash_command - 176 +176
800 do_mem_crc 184 88 -96
801 MPC8641HPCN_36BIT: all +55 rodata -29 text +84
802 u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
803 function old new delta
804 hash_command - 176 +176
805 do_mem_crc 184 88 -96
806 sbc8641d : all +55 rodata -29 text +84
807 u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
808 function old new delta
809 hash_command - 176 +176
810 do_mem_crc 184 88 -96
811 xpedite517x : all -33 data -16 rodata -93 text +76
812 u-boot: add: 1/-1, grow: 0/-1 bytes: 176/-112 (64)
813 function old new delta
814 hash_command - 176 +176
816 do_mem_crc 184 88 -96
820 This shows that commit 19 has reduced codesize for arm slightly and increased
821 it for powerpc. This increase was offset in by reductions in rodata and
824 Shown below the summary lines are the sizes for each board. Below each board
825 are the sizes for each function. This information starts with:
827 add - number of functions added / removed
828 grow - number of functions which grew / shrunk
829 bytes - number of bytes of code added to / removed from all functions,
830 plus the total byte change in brackets
832 The change seems to be that hash_command() has increased by more than the
833 do_mem_crc() function has decreased. The function sizes typically add up to
834 roughly the text area size, but note that every read-only section except
835 rodata is included in 'text', so the function total does not exactly
838 It is common when refactoring code for the rodata to decrease as the text size
839 increases, and vice versa.
845 The .buildman file provides information about the available toolchains and
846 also allows build flags to be passed to 'make'. It consists of several
847 sections, with the section name in square brackets. Within each section are
848 a set of (tag, value) pairs.
850 '[toolchain]' section
852 This lists the available toolchains. The tag here doesn't matter, but
853 make sure it is unique. The value is the path to the toolchain. Buildman
854 will look in that path for a file ending in 'gcc'. It will then execute
855 it to check that it is a C compiler, passing only the --version flag to
856 it. If the return code is 0, buildman assumes that it is a valid C
857 compiler. It uses the first part of the name as the architecture and
858 strips off the last part when setting the CROSS_COMPILE environment
859 variable (parts are delimited with a hyphen).
861 For example powerpc-linux-gcc will be noted as a toolchain for 'powerpc'
862 and CROSS_COMPILE will be set to powerpc-linux- when using it.
864 '[toolchain-alias]' section
866 This converts toolchain architecture names to U-Boot names. For example,
867 if an x86 toolchains is called i386-linux-gcc it will not normally be
868 used for architecture 'x86'. Adding 'x86: i386 x86_64' to this section
869 will tell buildman that the i386 and x86_64 toolchains can be used for
870 the x86 architecture.
872 '[make-flags]' section
874 U-Boot's build system supports a few flags (such as BUILD_TAG) which
875 affect the build product. These flags can be specified in the buildman
876 settings file. They can also be useful when building U-Boot against other
877 open source software.
880 at91-boards=ENABLE_AT91_TEST=1
881 snapper9260=${at91-boards} BUILD_TAG=442
882 snapper9g45=${at91-boards} BUILD_TAG=443
884 This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
885 and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
886 variable ${target} is available to access the target name (snapper9260
887 and snapper9g20 in this case). Variables are resolved recursively. Note
888 that variables can only contain the characters A-Z, a-z, 0-9, hyphen (-)
891 It is expected that any variables added are dealt with in U-Boot's
892 config.mk file and documented in the README.
894 Note that you can pass ad-hoc options to the build using environment
895 variables, for example:
897 SOME_OPTION=1234 ./tools/buildman/buildman my_board
903 If you have made changes and want to do a quick sanity check of the
904 currently checked-out source, run buildman without the -b flag. This will
905 build the selected boards and display build status as it runs (i.e. -v is
906 enabled automatically). Use -e to see errors/warnings as well.
912 You can build a range of commits by specifying a range instead of a branch
913 when using the -b flag. For example:
915 upstream/master..us-buildman
917 will build commits in us-buildman that are not in upstream/master.
923 By default, buildman executes 'make mrproper' prior to building the first
924 commit for each board. This causes everything to be built from scratch. If you
925 trust the build system's incremental build capabilities, you can pass the -I
926 flag to skip the 'make mproper' invocation, which will reduce the amount of
927 work 'make' does, and hence speed up the build. This flag will speed up any
928 buildman invocation, since it reduces the amount of work done on any build.
930 One possible application of buildman is as part of a continual edit, build,
931 edit, build, ... cycle; repeatedly applying buildman to the same change or
932 series of changes while making small incremental modifications to the source
933 each time. This provides quick feedback regarding the correctness of recent
934 modifications. In this scenario, buildman's default choice of build directory
935 causes more build work to be performed than strictly necessary.
937 By default, each buildman thread uses a single directory for all builds. When a
938 thread builds multiple boards, the configuration built in this directory will
939 cycle through various different configurations, one per board built by the
940 thread. Variations in the configuration will force a rebuild of affected source
941 files when a thread switches between boards. Ideally, such buildman-induced
942 rebuilds would not happen, thus allowing the build to operate as efficiently as
943 the build system and source changes allow. buildman's -P flag may be used to
944 enable this; -P causes each board to be built in a separate (board-specific)
945 directory, thus avoiding any buildman-induced configuration changes in any
948 U-Boot's build system embeds information such as a build timestamp into the
949 final binary. This information varies each time U-Boot is built. This causes
950 various files to be rebuilt even if no source changes are made, which in turn
951 requires that the final U-Boot binary be re-linked. This unnecessary work can
952 be avoided by turning off the timestamp feature. This can be achieved by
953 setting the SOURCE_DATE_EPOCH environment variable to 0.
955 Combining all of these options together yields the command-line shown below.
956 This will provide the quickest possible feedback regarding the current content
957 of the source tree, thus allowing rapid tested evolution of the code.
959 SOURCE_DATE_EPOCH=0 ./tools/buildman/buildman -I -P tegra
965 Buildman has various other command line options. Try --help to see them.
967 When doing builds, Buildman's return code will reflect the overall result:
969 0 (success) No errors or warnings found
974 How to change from MAKEALL
975 ==========================
977 Buildman includes most of the features of MAKEALL and is generally faster
978 and easier to use. In particular it builds entire branches: if a particular
979 commit introduces an error in a particular board, buildman can easily show
980 you this, even if a later commit fixes that error.
982 The reasons to deprecate MAKEALL are:
983 - We don't want to maintain two build systems
984 - Buildman is typically faster
985 - Buildman has a lot more features
987 But still, many people will be sad to lose MAKEALL. If you are used to
988 MAKEALL, here are a few pointers.
990 First you need to set up your tool chains - see the 'Setting up' section
991 for details. Once you have your required toolchain(s) detected then you are
994 To build the current source tree, run buildman without a -b flag:
996 ./tools/buildman/buildman <list of things to build>
998 This will build the current source tree for the given boards and display
999 the results and errors.
1001 However buildman usually works on entire branches, and for that you must
1002 specify a board flag:
1004 ./tools/buildman/buildman -b <branch_name> <list of things to build>
1006 followed by (afterwards, or perhaps concurrently in another terminal):
1008 ./tools/buildman/buildman -b <branch_name> -s <list of things to build>
1010 to see the results of the build. Rather than showing you all the output,
1011 buildman just shows a summary, with red indicating that a commit introduced
1012 an error and green indicating that a commit fixed an error. Use the -e
1013 flag to see the full errors and -l to see which boards caused which errors.
1015 If you really want to see build results as they happen, use -v when doing a
1016 build (and -e to see the errors/warnings too).
1018 You don't need to stick around on that branch while buildman is running. It
1019 checks out its own copy of the source code, so you can change branches,
1020 add commits, etc. without affecting the build in progress.
1022 The <list of things to build> can include board names, architectures or the
1023 like. There are no flags to disambiguate since ambiguities are rare. Using
1024 the examples from MAKEALL:
1027 - build all Power Architecture boards:
1029 MAKEALL --arch powerpc
1031 ** buildman -b <branch> powerpc
1032 - build all PowerPC boards manufactured by vendor "esd":
1033 MAKEALL -a powerpc -v esd
1034 ** buildman -b <branch> esd
1035 - build all PowerPC boards manufactured either by "keymile" or "siemens":
1036 MAKEALL -a powerpc -v keymile -v siemens
1037 ** buildman -b <branch> keymile siemens
1038 - build all Freescale boards with MPC83xx CPUs, plus all 4xx boards:
1039 MAKEALL -c mpc83xx -v freescale 4xx
1040 ** buildman -b <branch> mpc83xx freescale 4xx
1042 Buildman automatically tries to use all the CPUs in your machine. If you
1043 are building a lot of boards it will use one thread for every CPU core
1044 it detects in your machine. This is like MAKEALL's BUILD_NBUILDS option.
1045 You can use the -T flag to change the number of threads. If you are only
1046 building a few boards, buildman will automatically run make with the -j
1047 flag to increase the number of concurrent make tasks. It isn't normally
1048 that helpful to fiddle with this option, but if you use the BUILD_NCPUS
1049 option in MAKEALL then -j is the equivalent in buildman.
1051 Buildman puts its output in ../<branch_name> by default but you can change
1052 this with the -o option. Buildman normally does out-of-tree builds: use -i
1053 to disable that if you really want to. But be careful that once you have
1054 used -i you pollute buildman's copies of the source tree, and you will need
1055 to remove the build directory (normally ../<branch_name>) to run buildman
1056 in normal mode (without -i).
1058 Buildman doesn't keep the output result normally, but use the -k option to
1061 Please read 'Theory of Operation' a few times as it will make a lot of
1064 Some options you might like are:
1066 -B shows which functions are growing/shrinking in which commit - great
1067 for finding code bloat.
1068 -S shows image sizes for each commit (just an overall summary)
1069 -u shows boards that you haven't built yet
1070 --step 0 will build just the upstream commit and the last commit of your
1071 branch. This is often a quick sanity check that your branch doesn't
1072 break anything. But note this does not check bisectability!
1078 This has mostly be written in my spare time as a response to my difficulties
1079 in testing large series of patches. Apart from tidying up there is quite a
1080 bit of scope for improvement. Things like better error diffs and easier
1081 access to log files. Also it would be nice if buildman could 'hunt' for
1082 problems, perhaps by building a few boards for each arch, or checking
1083 commits for changed files and building only boards which use those files.
1085 A specific problem to fix is that Ctrl-C does not exit buildman cleanly when
1086 multiple builder threads are active.
1091 Thanks to Grant Grundler <grundler@chromium.org> for his ideas for improving
1092 the build speed by building all commits for a board instead of the other
projects / people / ms / u-boot.git / blob