From patchwork Sun May 13 10:38:12 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Samuel Martin X-Patchwork-Id: 158815 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ozlabs.org (Postfix) with ESMTP id EA07EB700A for ; Sun, 13 May 2012 20:40:24 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 7857B85383; Sun, 13 May 2012 10:40:21 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 9cABeQo-UnJR; Sun, 13 May 2012 10:40:12 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by whitealder.osuosl.org (Postfix) with ESMTP id 4CA858AA70; Sun, 13 May 2012 10:40:00 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id ABC0A8F75B for ; Sun, 13 May 2012 10:39:31 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 8D92481BAB for ; Sun, 13 May 2012 10:39:31 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id asA-O1Mfmery for ; Sun, 13 May 2012 10:39:25 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wg0-f53.google.com (mail-wg0-f53.google.com [74.125.82.53]) by whitealder.osuosl.org (Postfix) with ESMTPS id 00EE181C2D for ; Sun, 13 May 2012 10:39:24 +0000 (UTC) Received: by mail-wg0-f53.google.com with SMTP id fm10so3721346wgb.10 for ; Sun, 13 May 2012 03:39:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=7m90VHpUJseGW8tIW8v39M8UYzCE9L2AzuB5LyHCyYU=; b=DJcUxKYpoKfujEyDnxYk2tUeVPLibTMwT/COR3dXjvmqdwHigpm4AHxTu6k3Rlv+vn YX4Dgis+cgD3tmfN9pqMq0BoEc0vU6gatjuO+oN6cl39YX6tbgqS7LlzvO+dRsBsaa8y PKyWwB086RkGqF8oi/6CU0SVcw25fxePAvhEm1Afhy6r3tMMmFT/XstM/z2c71iCSHc3 aX2hn9rL2P1CAuFPwLTniSjSg7gh4ZVUxwvL0YyUHopwhUJwfqW5SELWQGPdC+T+HeHq aKqq2PzJnoDOeg6hUC9QFfk6X9QvDILwsKrrK3TGeyox5A4MIoxlMCHe8onz9lnZ+F7o F8tA== Received: by 10.180.104.168 with SMTP id gf8mr10624563wib.12.1336905564404; Sun, 13 May 2012 03:39:24 -0700 (PDT) Received: from localhost.localdomain (ivr94-4-82-229-165-48.fbx.proxad.net. [82.229.165.48]) by mx.google.com with ESMTPS id r2sm41271946wif.7.2012.05.13.03.39.22 (version=SSLv3 cipher=OTHER); Sun, 13 May 2012 03:39:23 -0700 (PDT) From: Samuel Martin To: buildroot@busybox.net Date: Sun, 13 May 2012 12:38:12 +0200 Message-Id: <1336905501-9757-3-git-send-email-s.martin49@gmail.com> X-Mailer: git-send-email 1.7.10.2 In-Reply-To: <1336905501-9757-1-git-send-email-s.martin49@gmail.com> References: <4FAEEFA8.2070005@mind.be> <1336905501-9757-1-git-send-email-s.martin49@gmail.com> Subject: [Buildroot] [PATCH v2 02/11] manual: rework introduction.txt and add embedded-basics.txt X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net From: Samuel MARTIN Split and rephrasing of introduction.txt. Cross-toolchain and pro-Buildroot explainations moved from introduction.txt into embedded-basics.txt. Signed-off-by: Samuel Martin create mode 100644 docs/manual/embedded-basics.txt diff --git a/docs/manual/embedded-basics.txt b/docs/manual/embedded-basics.txt new file mode 100644 index 0000000..bf14d7c --- /dev/null +++ b/docs/manual/embedded-basics.txt @@ -0,0 +1,67 @@ +Embedded system basics & Reasons to use Buildroot +------------------------------------------------- + +Cross-compilation & cross-toolchain +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A compilation toolchain is the set of tools that allows you to compile +code for your system. It consists of a compiler (in our case, +gcc+), +binary utils like assembler and linker (in our case, +binutils+) and a +C standard library (for example +http://www.gnu.org/software/libc/libc.html[GNU Libc], +http://www.uclibc.org/[uClibc] or +http://www.fefe.de/dietlibc/[dietlibc]). The system installed on your +development station certainly already has a compilation toolchain that +you can use to compile an application that runs on your system. If +you're using a PC, your compilation toolchain runs on an x86 processor +and generates code for an x86 processor. Under most Linux systems, the +compilation toolchain uses the GNU libc (glibc) as the C standard +library. This compilation toolchain is called the "host compilation +toolchain". The machine on which it is running, and on which you're +working, is called the "host system". The compilation toolchain is +provided by your distribution, and Buildroot has nothing to do with it +(other than using it to build a cross-compilation toolchain and other +tools that are run on the development host). + +As said above, the compilation toolchain that comes with your system +runs on and generates code for the processor in your host system. As +your embedded system has a different processor, you need a +cross-compilation toolchain - a compilation toolchain that runs on +your host system but generates code for your target system (and target +processor). For example, if your host system uses x86 and your target +system uses ARM, the regular compilation toolchain on your host runs on +x86 and generates code for x86, while the cross-compilation toolchain +runs on x86 and generates code for ARM. + +[[pros-buildroot]] + +Why choose Buildroot +~~~~~~~~~~~~~~~~~~~~ + +Even if your embedded system uses an x86 processor, you might be +interested in Buildroot for two reasons: + +* The compilation toolchain on your host certainly uses the GNU Libc + which is a complete but huge C standard library. Instead of using + GNU Libc on your target system, you can use uClibc which is a tiny C + standard library. If you want to use this C library, then you need a + compilation toolchain to generate binaries linked with it. Buildroot + can do that for you. + +* Buildroot automates the building of a root filesystem with all + needed tools like busybox. That makes it much easier than doing it + by hand. + +You might wonder why such a tool is needed when you can compile +gcc+, ++binutils+, +uClibc+ and all the other tools by hand. Of course doing +so is possible but, dealing with all of the configure options and +problems of every +gcc+ or +binutils+ version is very time-consuming +and uninteresting. Buildroot automates this process through the use +of Makefiles and has a collection of patches for each +gcc+ and ++binutils+ version to make them work on most architectures. + +Moreover, Buildroot provides an infrastructure for reproducing the +build process of your kernel, cross-toolchain, and embedded root +filesystem. Being able to reproduce the build process will be useful +when a component needs to be patched or updated or when another person +is supposed to take over the project. diff --git a/docs/manual/going-further.txt b/docs/manual/going-further.txt index 6f3cd6e..67162a6 100644 --- a/docs/manual/going-further.txt +++ b/docs/manual/going-further.txt @@ -1,6 +1,8 @@ Going further in Buildroot's innards ==================================== +include::embedded-basics.txt[] + include::how-buildroot-works.txt[] include::advanced.txt[] diff --git a/docs/manual/introduction.txt b/docs/manual/introduction.txt index 476ce25..e330674 100644 --- a/docs/manual/introduction.txt +++ b/docs/manual/introduction.txt @@ -1,69 +1,21 @@ About Buildroot =============== -Buildroot is a set of Makefiles and patches that allows you to easily -generate a cross-compilation toolchain, a root filesystem and a Linux -kernel image for your target. Buildroot can be used for one, two or -all of these options, independently. - -Buildroot is useful mainly for people working with embedded systems. +Buildroot provides a full featured environment for cross-development. +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 combinaison of these options, +independently. + +Buildroot is useful mainly for people working with embedded systems +for a number of good reasons (see xref:pros-buildroot[]). 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. -A compilation toolchain is the set of tools that allows you to compile -code for your system. It consists of a compiler (in our case, +gcc+), -binary utils like assembler and linker (in our case, +binutils+) and a -C standard library (for example -http://www.gnu.org/software/libc/libc.html[GNU Libc], -http://www.uclibc.org/[uClibc] or -http://www.fefe.de/dietlibc/[dietlibc]). The system installed on your -development station certainly already has a compilation toolchain that -you can use to compile an application that runs on your system. If -you're using a PC, your compilation toolchain runs on an x86 processor -and generates code for an x86 processor. Under most Linux systems, the -compilation toolchain uses the GNU libc (glibc) as the C standard -library. This compilation toolchain is called the "host compilation -toolchain". The machine on which it is running, and on which you're -working, is called the "host system". The compilation toolchain is -provided by your distribution, and Buildroot has nothing to do with it -(other than using it to build a cross-compilation toolchain and other -tools that are run on the development host). - -As said above, the compilation toolchain that comes with your system -runs on and generates code for the processor in your host system. As -your embedded system has a different processor, you need a -cross-compilation toolchain - a compilation toolchain that runs on -your host system but generates code for your target system (and target -processor). For example, if your host system uses x86 and your target -system uses ARM, the regular compilation toolchain on your host runs on -x86 and generates code for x86, while the cross-compilation toolchain -runs on x86 and generates code for ARM. - -Even if your embedded system uses an x86 processor, you might be -interested in Buildroot for two reasons: - -* The compilation toolchain on your host certainly uses the GNU Libc - which is a complete but huge C standard library. Instead of using - GNU Libc on your target system, you can use uClibc which is a tiny C - standard library. If you want to use this C library, then you need a - compilation toolchain to generate binaries linked with it. Buildroot - can do that for you. - -* Buildroot automates the building of a root filesystem with all - needed tools like busybox. That makes it much easier than doing it - by hand. - -You might wonder why such a tool is needed when you can compile +gcc+, -+binutils+, +uClibc+ and all the other tools by hand. Of course doing -so is possible but, dealing with all of the configure options and -problems of every +gcc+ or +binutils+ version is very time-consuming -and uninteresting. Buildroot automates this process through the use -of Makefiles and has a collection of patches for each +gcc+ and -+binutils+ version to make them work on most architectures. +Buildroot supports numerous processors and their variants; it also +comes with default configuration for several boards available +off-the-shelf. Besides, a number of third-party projects are based on +or develop their BSP footnote:[BSP: Board Software Package] or +SDK footnote:[SDK: Standard Development Kit] on top of Buildroot. -Moreover, Buildroot provides an infrastructure for reproducing the -build process of your kernel, cross-toolchain, and embedded root -filesystem. Being able to reproduce the build process will be useful -when a component needs to be patched or updated or when another person -is supposed to take over the project.