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