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