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
|
|
|
|
|
|
|
|
Buildroot needs some software to be already installed on the host
|
2012-11-16 05:54:19 +01:00
|
|
|
system; here are the lists of the mandatory and optional packages
|
2012-11-11 04:14:48 +01:00
|
|
|
(package names may vary between distributions).
|
|
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
Take care to _install both runtime and development data_, especially
|
2012-11-11 04:14:48 +01:00
|
|
|
for the libraries that may be packaged in 2 distinct packages.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[[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)
|
|
|
|
|
** +gcc+ (version 2.95 or any later)
|
|
|
|
|
** `g++` (version 2.95 or any later)
|
|
|
|
|
** +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+
|
|
|
|
|
** +python+ (version 2.6 or 2.7)
|
|
|
|
|
** +unzip+
|
|
|
|
|
** +rsync+
|
|
|
|
|
|
|
|
|
|
* 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
|
|
|
|
|
|
|
|
* Source fetching tools:
|
|
|
|
|
+
|
|
|
|
|
In the official tree, most of the package sources are retrieved
|
2012-11-16 05:54:19 +01:00
|
|
|
using +wget+; a few are only available through their +git+, +mercurial+,
|
2013-09-11 14:12:05 +02:00
|
|
|
+svn+ or +cvs+ repository.
|
2012-11-11 04:14:48 +01:00
|
|
|
+
|
|
|
|
|
All other source fetching methods are implemented and may be used in a
|
2012-11-11 04:14:55 +01:00
|
|
|
development context (further details: refer to xref:download-infra[]).
|
2012-11-11 04:14:48 +01:00
|
|
|
+
|
|
|
|
|
** +bazaar+
|
|
|
|
|
** +cvs+
|
|
|
|
|
** +git+
|
|
|
|
|
** +mercurial+
|
|
|
|
|
** +rsync+
|
|
|
|
|
** +scp+
|
|
|
|
|
** +subversion+
|
|
|
|
|
|
|
|
|
|
* Configuration interface dependencies (requires development libraries):
|
2012-11-27 12:59:17 +01:00
|
|
|
** +ncurses5+ to use the 'menuconfig' interface
|
2012-11-11 04:14:48 +01:00
|
|
|
** +qt4+ to use the 'xconfig' interface
|
|
|
|
|
** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
|
|
|
|
|
|
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'
|
