2013-11-11 16:03:29 +01:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
|
|
|
|
|
|
|
|
|
[[debugging-buildroot]]
|
|
|
|
|
|
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
|
|
|
== Debugging Buildroot
|
2013-11-11 16:03:29 +01:00
|
|
|
|
|
|
|
|
It is possible to instrument the steps +Buildroot+ does when building
|
|
|
|
|
packages. Define the variable +BR2_INSTRUMENTATION_SCRIPTS+ to contain
|
|
|
|
|
the path of one or more scripts (or other executables), in a
|
|
|
|
|
space-separated list, you want called before and after each step. The
|
|
|
|
|
scripts are called in sequence, with three parameters:
|
|
|
|
|
|
|
|
|
|
- +start+ or +end+ to denote the start (resp. the end) of a step;
|
2015-05-03 17:42:44 +02:00
|
|
|
- the name of the step about to be started, or which just ended;
|
|
|
|
|
- the name of the package.
|
2013-11-11 16:03:29 +01:00
|
|
|
|
|
|
|
|
For example :
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
make BR2_INSTRUMENTATION_SCRIPTS="/path/to/my/script1 /path/to/my/script2"
|
|
|
|
|
----
|
|
|
|
|
|
2015-05-03 17:42:44 +02:00
|
|
|
The list of steps is:
|
|
|
|
|
|
|
|
|
|
- +extract+
|
|
|
|
|
- +patch+
|
|
|
|
|
- +configure+
|
|
|
|
|
- +build+
|
|
|
|
|
- +install-host+, when a host-package is installed in +$(HOST_DIR)+
|
|
|
|
|
- +install-target+, when a target-package is installed in +$(TARGET_DIR)+
|
|
|
|
|
- +install-staging+, when a target-package is installed in +$(STAGING_DIR)+
|
|
|
|
|
- +install-image+, when a target-package installs files in +$(BINARIES_DIR)+
|
|
|
|
|
|
|
|
|
|
The script has access to the following variables:
|
2013-11-11 16:03:29 +01:00
|
|
|
|
2014-02-04 16:18:52 +01:00
|
|
|
- +BR2_CONFIG+: the path to the Buildroot .config file
|
2013-11-11 16:03:29 +01:00
|
|
|
- +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
|
|
|
|
|
xref:generic-package-reference[]
|
|
|
|
|
- +BUILD_DIR+: the directory where packages are extracted and built
|
|
|
|
|
- +BINARIES_DIR+: the place where all binary files (aka images) are
|
|
|
|
|
stored
|
|
|
|
|
- +BASE_DIR+: the base output directory
|
