buildroot/docs/manual/appendix.txt, branch 2016.02

manual: high-level restructuring

2014-08-17T19:09:52+00:00

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 Signed-off-by: Thomas Petazzoni

docs/manual: add the virtual packages list

2014-06-08T15:11:47+00:00

Add the list of virtual packages as an appendix to the manual. Also reference this list from appropriate locations elsewhere in the manual: - in section 7.2.2. "Config.in file", after the existing explanations on dependencies on target and toolchain options, on a linux kernel, and on udev /dev management, - in section 7.2.10. "Infrastructure for virtual packages", in the provider Config.in and .mk explanations, to have the list of existing symbols to select (in Config.in) and packages to provide (in .mk). Signed-off-by: "Yann E. MORIN" Cc: Samuel Martin Acked-by: Samuel Martin Signed-off-by: Thomas Petazzoni

manual: use one-line titles instead of two-line titles (trivial)

2014-05-02T08:27:59+00:00

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 Signed-off-by: Peter Korsgaard

manual: clarify handling of deprecated features

2014-01-21T20:56:46+00:00

Signed-off-by: Thomas De Schampheleire Signed-off-by: Peter Korsgaard

manual: rename section name of package lists

2013-10-14T10:50:11+00:00

The original titles did no longer correspond with the actual menu names. Additionally, choose a name that better reflects the fact that this is a list. Signed-off-by: Thomas De Schampheleire Acked-by: "Samuel Martin" Signed-off-by: Peter Korsgaard

manual: add a make target 'manual-update-lists'

2013-05-04T10:39:27+00:00

The generated lists are automatically updated when building the manual. [Peter: fix typos] Signed-off-by: Samuel Martin [yann.morin.1998@free.fr: indentation, remove temp dir, intro to host utils] Signed-off-by: "Yann E. MORIN" Signed-off-by: Peter Korsgaard

manual: cleanup appendix.txt

2013-05-04T10:34:29+00:00

Signed-off-by: Samuel Martin [yann.morin.1998@free.fr: one more stuff->feature fixup] Signed-off-by: "Yann E. MORIN" Signed-off-by: Peter Korsgaard

packages: add ability for packages to create users

2013-04-25T20:56:42+00:00

Packages that install daemons may need those daemons to run as a non-root, or an otherwise non-system (eg. 'daemon'), user. Add infrastructure for packages to create users, by declaring the FOO_USERS variable that contain a makedev-syntax-like description of the user(s) to add. Signed-off-by: "Yann E. MORIN" Cc: Samuel Martin Cc: Cam Hutchison Cc: Thomas Petazzoni Acked-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Peter Korsgaard

manual: cleanup and update editor tags

2013-02-17T21:50:04+00:00

Signed-off-by: Samuel Martin Acked-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Peter Korsgaard

manual: add pkg-list.txt (generated list of available packages)

2012-11-15T22:59:55+00:00

Signed-off-by: Samuel Martin Signed-off-by: Peter Korsgaard