aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/make-tips.txt
blob: e87bbf798eaad90674e16adc519633cdd857e803 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// -*- mode:doc; -*-
// vim: set syntax=asciidoc:

[[make-tips]]
'make' tips
-----------

This is a collection of tips that help you make the most of Buildroot.

.Configuration searches:

The +make *config+ commands offer a search tool. Read the help message in
the different frontend menus to know how to use it:

* in _menuconfig_, the search tool is called by pressing +/+;
* in _xconfig_, the search tool is called by pressing +Ctrl+ + +f+.

The result of the search shows the help message of the matching items.

.Display all commands executed by make:

--------------------
 $ make V=1 <target>
--------------------

.Display all available targets:

--------------------
 $ make help
--------------------

.Not all targets are always available,

some settings in the +.config+ file may hide some targets:

* +linux-menuconfig+ and +linux-savedefconfig+ only work when
  +linux+ is enabled;
* +uclibc-menuconfig+ is only available when the
  Buildroot internal toolchain backend is used;
* +ctng-menuconfig+ is only available when the
  crosstool-NG backend is used;
* +barebox-menuconfig+ and +barebox-savedefconfig+ only work when the
  +barebox+ bootloader is enabled.

.Cleaning:

Explicit cleaning is required when any of the architecture or toolchain
configuration options are changed.

To delete all build products (including build directories, host, staging
and target trees, the images and the toolchain):

--------------------
 $ make clean
--------------------

.Generating the manual:

The present manual sources are located in the 'docs/manual' directory.
To generate the manual:

---------------------------------
 $ make manual-clean
 $ make manual
---------------------------------

The manual outputs will be generated in 'output/docs/manual'.

.Notes
- +asciidoc+ is required to build the documentation (see:
  xref:requirement-optional[]).
- There is a known issue that you can't build it under Debian Squeeze.

To delete all build products as well as the configuration:

--------------------
 $ make distclean
--------------------

Note that if +ccache+ is enabled, running +make clean+ or +distclean+ does
not empty the compiler cache used by Buildroot. To delete it, refer
to xref:ccache[].