6fb84874b2
To generate the manual, you need a few tools. If these are not present, pretty cryptic error messages are given. This patch adds a simple check for these dependencies, before attempting to build the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
82 lines
2.1 KiB
Plaintext
82 lines
2.1 KiB
Plaintext
// -*- 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;
|
|
* +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
|
|
- A few tools are required to build the documentation (see:
|
|
xref:requirement-optional[]).
|
|
|
|
.Reseting Buildroot for a new target:
|
|
|
|
To delete all build products as well as the configuration:
|
|
|
|
--------------------
|
|
$ make distclean
|
|
--------------------
|
|
|
|
.Notes
|
|
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[].
|