2013-02-13 13:59:02 +01:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:48 +01:00
|
|
|
|
|
|
|
|
[[requirement]]
|
manual: use one-line titles instead of two-line titles (trivial)
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>
2014-05-02 07:47:30 +02:00
|
|
|
== System requirements
|
2012-11-11 04:14:48 +01:00
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
Buildroot is designed to run on Linux systems.
|
2012-11-11 04:14:48 +01:00
|
|
|
|
2014-08-12 22:20:10 +02:00
|
|
|
While Buildroot itself will build most host packages it needs for the
|
|
|
|
|
compilation, certain standard Linux utilities are expected to be
|
|
|
|
|
already installed on the host system. Below you will find an overview of
|
|
|
|
|
the mandatory and optional packages (note that package names may vary
|
|
|
|
|
between distributions).
|
2012-11-11 04:14:48 +01:00
|
|
|
|
|
|
|
|
[[requirement-mandatory]]
|
|
|
|
|
|
manual: use one-line titles instead of two-line titles (trivial)
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>
2014-05-02 07:47:30 +02:00
|
|
|
=== Mandatory packages
|
2012-11-11 04:14:48 +01:00
|
|
|
|
|
|
|
|
* Build tools:
|
|
|
|
|
|
|
|
|
|
** +which+
|
|
|
|
|
** +sed+
|
2012-11-27 12:59:16 +01:00
|
|
|
** +make+ (version 3.81 or any later)
|
2012-11-11 04:14:48 +01:00
|
|
|
** +binutils+
|
|
|
|
|
** +build-essential+ (only for Debian based systems)
|
2018-08-05 12:13:31 +02:00
|
|
|
** +gcc+ (version 4.4 or any later)
|
|
|
|
|
** `g++` (version 4.4 or any later)
|
2012-11-11 04:14:48 +01:00
|
|
|
** +bash+
|
|
|
|
|
** +patch+
|
|
|
|
|
** +gzip+
|
|
|
|
|
** +bzip2+
|
2013-11-11 14:58:12 +01:00
|
|
|
** +perl+ (version 5.8.7 or any later)
|
2012-11-11 04:14:48 +01:00
|
|
|
** +tar+
|
|
|
|
|
** +cpio+
|
2018-12-17 00:27:34 +01:00
|
|
|
** +python+ (version 2.7 or any later)
|
2012-11-11 04:14:48 +01:00
|
|
|
** +unzip+
|
|
|
|
|
** +rsync+
|
support/dependencies: ensure we have 'file' on the host
Recently, the autoconf macros for libtool started using '/usr/bin/file'
to determine the type of library that is generated by the toolchain.
Packages that use this recent version of the libtool autoconf macros
will fail in a rather dramatic way when /usr/bin/file is not present
on the host: the package will still build but no shared library is
generated, which in turn may cause build failures in other packages
that link with it.
For example, libpng's configure determines that it is not possible to
build a shared library on MIPS64 because the expected output from 'file'
is not present. Therefore, only a static libpng.a is built. Later,
bandwithd links with -lpng but it doesn't use the pkg-config's
Private-Libs (because it's not linking statically) and it doesn't have
access to the NEEDED reference from the shared library. Therefore, it
doesn't link with zlib and fails with
pngrutil.c:(.text+0x55c): undefined reference to `inflate'
We cant use host-file because it is itself an autotools package and is
itself using libtool, so this would be a chicken-n-egg problem. Besides,
the libtool script really wants to call /usr/bin/file, so it would not
even find our host-file anyway.
So, just require that '/usr/bin/file' is present on the host.
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Baruch Siach <baruch@tkos.co.il>
Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-12-26 18:58:30 +01:00
|
|
|
** +file+ (must be in +/usr/bin/file+)
|
2017-01-05 20:27:09 +01:00
|
|
|
** +bc+
|
2012-11-11 04:14:48 +01:00
|
|
|
|
|
|
|
|
* Source fetching tools:
|
|
|
|
|
** +wget+
|
|
|
|
|
|
|
|
|
|
[[requirement-optional]]
|
|
|
|
|
|
manual: use one-line titles instead of two-line titles (trivial)
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>
2014-05-02 07:47:30 +02:00
|
|
|
=== Optional packages
|
2012-11-11 04:14:48 +01:00
|
|
|
|
2014-08-12 22:20:10 +02:00
|
|
|
* Configuration interface dependencies:
|
2012-11-11 04:14:48 +01:00
|
|
|
+
|
2014-08-12 22:20:10 +02:00
|
|
|
For these libraries, you need to install both runtime and development
|
|
|
|
|
data, which in many distributions are packaged separately. The
|
|
|
|
|
development packages typically have a _-dev_ or _-devel_ suffix.
|
2012-11-11 04:14:48 +01:00
|
|
|
+
|
2014-08-12 22:20:10 +02:00
|
|
|
** +ncurses5+ to use the 'menuconfig' interface
|
|
|
|
|
** +qt4+ to use the 'xconfig' interface
|
|
|
|
|
** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
|
|
|
|
|
|
|
|
|
|
* Source fetching tools:
|
|
|
|
|
+
|
|
|
|
|
In the official tree, most of the package sources are retrieved using
|
|
|
|
|
+wget+ from _ftp_, _http_ or _https_ locations. A few packages are only
|
|
|
|
|
available through a version control system. Moreover, Buildroot is
|
|
|
|
|
capable of downloading sources via other tools, like +rsync+ or +scp+
|
|
|
|
|
(refer to xref:download-infra[] for more details). If you enable
|
|
|
|
|
packages using any of these methods, you will need to install the
|
|
|
|
|
corresponding tool on the host system:
|
2012-11-11 04:14:48 +01:00
|
|
|
+
|
|
|
|
|
** +bazaar+
|
|
|
|
|
** +cvs+
|
|
|
|
|
** +git+
|
|
|
|
|
** +mercurial+
|
|
|
|
|
** +rsync+
|
|
|
|
|
** +scp+
|
|
|
|
|
** +subversion+
|
|
|
|
|
|
2012-12-29 05:42:32 +01:00
|
|
|
* Java-related packages, if the Java Classpath needs to be built for
|
|
|
|
|
the target system:
|
|
|
|
|
** The +javac+ compiler
|
|
|
|
|
** The +jar+ tool
|
|
|
|
|
|
2012-11-11 04:14:48 +01:00
|
|
|
* Documentation generation tools:
|
2013-10-18 22:31:25 +02:00
|
|
|
** +asciidoc+, version 8.6.3 or higher
|
|
|
|
|
** +w3m+
|
|
|
|
|
** +python+ with the +argparse+ module (automatically present in 2.7+ and 3.2+)
|
|
|
|
|
** +dblatex+ (required for the pdf manual only)
|
2014-06-17 11:33:53 +02:00
|
|
|
|
|
|
|
|
* Graph generation tools:
|
|
|
|
|
** +graphviz+ to use 'graph-depends' and '<pkg>-graph-depends'
|
|
|
|
|
** +python-matplotlib+ to use 'graph-build'
|
