summaryrefslogtreecommitdiffstats
path: root/docs/manual/configure.txt
Commit message (Collapse)AuthorAgeFilesLines
* manual/user guide: rework 'Configuration of other components' chapterThomas De Schampheleire2014-08-211-9/+0
| | | | | | | | | | | | | | | | This patch reworks the chapter 'Configuration of other components' as follows: - remove separate customize-xxx-config.txt files in favor of one shared file configure-other-componenents.txt - use labeled list instead of separate sections, as the information in each section is limited. - simplify instructions for busybox/uclibc thanks to the kconfig-package infrastructure - rewrite instructions for Linux - add instructions for Barebox Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide: move tip on configuration searchesThomas De Schampheleire2014-08-211-3/+18
| | | | | | | | | | This patch moves the tip on searching in the configuration editors into the section 'Buildroot configuration', which is more logical. The wording of that section is slightly adapted to fit this new part. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/user guide: high-level restructuringThomas De Schampheleire2014-08-211-1/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch performs some additional restructuring of the manual, specifically in the User Guide. In detail: - Rename 'Daily use' to 'General Buildroot usage' - Move chapters 'make tips', 'Eclipse integration', and 'Advanced usage' as sections under the 'General Buildroot usage' chapter. - Rename 'Details on Buildroot configuration' into 'Buildroot configuration' - Rework the 'Customization' section as follows: - Move the short section on debugging the external toolchain wrapper into the rest of the explanation on external toolchains. - Remove the now redundant section on toolchains, as this is already explained in much more detail in the 'Buildroot configuration' chapter. - Move the sections on busybox/uclibc/kernel configuration from chapter 'Customization' into a separate chapter 'Configuration of other components'. - Rename the remaining part of the original 'Customization' chapter into 'Project-specific customization' and fold it together with the next chapter 'Storing the configuration' - Remove the chapter 'Going further in Buildroot innards' thanks to: - Moving the chapter 'How Buildroot works' to the Developer guide. - Moving the 'Advanced Buildroot usage' section to the 'General Buildroot usage' chapter. - Remove the chapter 'Hacking Buildroot' by: - Adding a reference to adding packages to the 'Project-specific customizations' chapter - Leaving out the explicit reference to creating board support, as this is part of the previous chapter already, so an extra reference is redundant. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* replace references to Busybox with BusyBoxSimon Dawson2014-06-011-8/+8
| | | | | | | | | The correct capitalised form appears to be "BusyBox" rather than "Busybox"; fix all references to the latter form. (Most such references occur in the manual and in commentary in package makefiles.) Signed-off-by: Simon Dawson <spdawson@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: fix spelling mistakesSimon Dawson2014-06-011-3/+3
| | | | | Signed-off-by: Simon Dawson <spdawson@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/configure.txt: fix C++ escapingThomas De Schampheleire2014-05-021-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For asciidoc, a string like '+these are some words+' will be displayed in monospace font. Such sequences are identified by searching for a matching pair of + signs in the same block. The string 'C++' also contains such + signs. In most cases, this does not pose a problem and no escaping is necessary. However, if 'C++' occurs twice in the same block, the + signs will be matched to each other, and asciidoc formats all text between them as monospaced text. In this case, escaping of one of these 'C++' occurances is necessary to get the right formatting. In one place of the manual, there is a sentence that causes such a problem: "you only have to tell whether your toolchain supports C++ or not and whether it has built-in RPC support. If your external toolchain uses the 'uClibc' library, then you have to tell Buildroot if it supports largefile, IPv6, RPC, wide-char, locale, program invocation, threads and C++." Commit 082dec8ce440236b1477e568f0965f05ad241adb was based on a patch fixing this problem in one place of the manual, but was incorrectly changed while committing. This patch reverts the incorrect changes in that commit, and solves the problem correctly. Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: use one-line titles instead of two-line titles (trivial)Thomas De Schampheleire2014-05-021-12/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Asciidoc supports two syntaxes for section titles: two-line titles (title plus underline consisting of a particular symbol), and one-line titles (title prefixed with a specific number of = signs). The two-line title underlines are: Level 0 (top level): ====================== Level 1: ---------------------- Level 2: ~~~~~~~~~~~~~~~~~~~~~~ Level 3: ^^^^^^^^^^^^^^^^^^^^^^ Level 4 (bottom level): ++++++++++++++++++++++ and the one-line title prefixes: = Document Title (level 0) = == Section title (level 1) == === Section title (level 2) === ==== Section title (level 3) ==== ===== Section title (level 4) ===== The buildroot manual is currenly using the two-line titles, but this has multiple disadvantages: - asciidoc also uses some of the underline symbols for other purposes (like preformatted code, example blocks, ...), which makes it difficult to do mass replacements, such as a planned follow-up patch that needs to move all sections one level down. - it is difficult to remember which level a given underline symbol (=-~^+) corresponds to, while counting = signs is easy. This patch changes all two-level titles to one-level titles in the manual. The bulk of the change was done with the following Python script, except for the level 1 titles (-----) as these underlines are also used for literal code blocks. This patch only changes the titles, no other changes. In adding-packages-directory.txt, I did add missing newlines between some titles and their content. ---------------------------------------------------------------------------- #!/usr/bin/env python import sys import mmap import re for input in sys.argv[1:]: f = open(input, 'r+') f.flush() s = mmap.mmap(f.fileno(), 0) # Level 0 (top level): ====================== = # Level 1: ---------------------- == # Level 2: ~~~~~~~~~~~~~~~~~~~~~~ === # Level 3: ^^^^^^^^^^^^^^^^^^^^^^ ==== # Level 4 (bottom level): ++++++++++++++++++++++ ===== def replace_title(s, symbol, replacement): pattern = re.compile(r'(.+\n)\%s{2,}\n' % symbol, re.MULTILINE) return pattern.sub(r'%s \1' % replacement, s) new = s new = replace_title(new, '=', '=') new = replace_title(new, '+', '=====') new = replace_title(new, '^', '====') new = replace_title(new, '~', '===') #new = replace_title(new, '-', '==') s.seek(0) s.write(new) s.resize(s.tell()) s.close() f.close() ---------------------------------------------------------------------------- Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: fix typo in abbreviation 'i.e.'Jerzy Grzegorek2014-03-291-6/+6
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/configure.txt: fix typoJerzy Grzegorek2014-03-291-2/+2
| | | | | | | [Thomas: fix to actually use the correct syntax.] Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/configure.txt: reword part about internal toolchain backendJerzy Grzegorek2014-03-291-1/+1
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Merge branch 'next'Peter Korsgaard2014-02-281-9/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: Makefile package/dmraid/Config.in package/gdb/Config.in.host package/linux-headers/linux-headers.mk package/python/python.mk package/python3/python3.mk package/rt-tests/Config.in package/sdl/sdl.mk package/systemd/systemd-01-fix-getty-unit.patch package/systemd/systemd-02-fix-page-size.patch package/systemd/systemd-03-uclibc-fix.patch package/udev/Config.in package/udisks/Config.in package/vlc/vlc.mk system/Config.in Quite some merge conflicts, hopefully I didn't screw up anything. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * manual: update /dev management section.eric.le.bihan.dev@free.fr2014-02-121-9/+11
| | | | | | | | | | | | | | | | | | | | This patch updates the /dev management section in the manual with information about eudev, which replaces udev. Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: rephrase paragraph about unsupported external toolchainsThomas Petazzoni2014-02-231-17/+7
| | | | | | | | | | | | | | | | | | | | | | | | The ELDK now relies on Yocto, so it no longer has the funky non-standard way of doing multilib. Also, we didn't mention that Yocto toolchains/SDK are not suitable for usage with Buildroot. Therefore, this commit rewords this part of the documentation to explain that Yocto/OpenEmbedded SDKs cannot be used as external toolchains in Buildroot, and why. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: mention that custom toolchains is also useful for BR toolchainsThomas Petazzoni2014-02-231-8/+8
| | | | | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: update external toolchain examplesThomas Petazzoni2014-02-231-4/+3
| | | | | | | | | | | | | | | | | | Replace ADI by Analog Devices, which is clearer for most people, and remove the Xilinx external toolchains since we have deprecated them. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: update informations about C library in internal backendThomas Petazzoni2014-02-231-19/+11
|/ | | | | | | | | | | | Now that we have eglibc and glibc support in the internal backend, and no longer marked as experimental, a little bit of rewording is needed. It is no longer necessary to indicate that uClibc was historically supported as the only C library, and that the glibc support is experimental. We also update the rest of the description to be less uClibc specific. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: systemd does not require glibShawn Landden2013-12-091-1/+1
| | | | | | Signed-off-by: Shawn Landden <shawn@churchofgit.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: update manual after Crosstool-NG backend removalThomas Petazzoni2013-10-061-56/+4
| | | | | | [Peter: remove a few more ctng references in customize-store.txt] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update to mention eglibc support in Buildroot toolchain backendThomas Petazzoni2013-07-041-26/+26
| | | | | | [Peter: minor tweak] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: fix cross-refsSamuel Martin2013-02-281-0/+3
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: cleanup and update editor tagsSamuel Martin2013-02-171-1/+2
| | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: add details on toolchain configurationThomas Petazzoni2012-12-291-0/+277
| | | | | | | | | | | | | | | | | | | | | | This commit adds a new section Working with Buildroot -> Details in configuration -> Cross-compilation toolchain that gives a lot of details about our three toolchain backends. It takes some elements that were previously later in the manual in "Embedded basics" and in "External toolchain" and combines them with more details about internal backend and Crosstool-NG backend. The "Embedded basics" section becomes empty and is therefore removed. A few elements have been lost in the process, but they were considered to not be really useful, especially located so far in the manual. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: add a new 'Details on Buildroot configuration' sectionThomas Petazzoni2012-12-291-0/+151
As discussed with Samuel Martin, there are a few questions about some Buildroot configuration aspects that come very often on the IRC channel and on the mailing-list. Topics such as the /dev management and init systems are often raised. Therefore, this patch adds a new section that provides details about the Buildroot configuration possibilities. It does not aim at replacing the help text of each configuration option, but rather to complement them by providing more background. Having those informations in the manual will also make it easier for us to point newcomers to the right place in the documentation when they have questions. Note that this section will replace the "Embedded basics" section that comes way too late in the manual. This is done in a followup commit. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
OpenPOWER on IntegriCloud