2012-11-11 04:14:43 +01:00
|
|
|
// -*- mode:doc; -*-
|
2013-02-13 13:59:02 +01:00
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:43 +01:00
|
|
|
|
manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.
This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix
Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.
In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-08-12 22:20:06 +02:00
|
|
|
== About Buildroot
|
2011-10-10 10:46:39 +02:00
|
|
|
|
2012-12-29 05:42:28 +01:00
|
|
|
Buildroot is a tool that simplifies and automates the process of
|
|
|
|
|
building a complete Linux system for an embedded system, using
|
|
|
|
|
cross-compilation.
|
|
|
|
|
|
|
|
|
|
In order to achieve this, Buildroot is able to generate a
|
|
|
|
|
cross-compilation toolchain, a root filesystem, a Linux kernel image
|
|
|
|
|
and a bootloader for your target. Buildroot can be used for any
|
|
|
|
|
combination of these options, independently (you can for example use
|
|
|
|
|
an existing cross-compilation toolchain, and build only your root
|
|
|
|
|
filesystem with Buildroot).
|
2011-10-10 10:46:39 +02:00
|
|
|
|
|
|
|
|
Buildroot is useful mainly for people working with embedded systems.
|
|
|
|
|
Embedded systems often use processors that are not the regular x86
|
|
|
|
|
processors everyone is used to having in his PC. They can be PowerPC
|
|
|
|
|
processors, MIPS processors, ARM processors, etc.
|
|
|
|
|
|
2012-11-11 04:14:43 +01:00
|
|
|
Buildroot supports numerous processors and their variants; it also
|
2012-11-16 05:54:19 +01:00
|
|
|
comes with default configurations for several boards available
|
|
|
|
|
off-the-shelf. Besides this, a number of third-party projects are based on,
|
2012-11-27 12:59:16 +01:00
|
|
|
or develop their BSP footnote:[BSP: Board Support Package] or
|
|
|
|
|
SDK footnote:[SDK: Software Development Kit] on top of Buildroot.
|
