2012-11-11 04:14:54 +01:00
|
|
|
// -*- mode:doc; -*-
|
2013-02-13 13:59:02 +01:00
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
[[pkg-build-steps]]
|
|
|
|
|
|
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
|
|
|
=== Package-specific _make_ targets
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
Running +make <package>+ builds and installs that particular package
|
|
|
|
|
and its dependencies.
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
For packages relying on the Buildroot infrastructure, there are
|
2012-11-11 04:14:54 +01:00
|
|
|
numerous special make targets that can be called independently like
|
|
|
|
|
this:
|
|
|
|
|
|
|
|
|
|
------------
|
|
|
|
|
make <package>-<target>
|
|
|
|
|
------------
|
|
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
The package build targets are (in the order they are executed):
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
[width="90%",cols="^1,4",options="header"]
|
|
|
|
|
|===================================================
|
|
|
|
|
| command/target | Description
|
|
|
|
|
|
|
|
|
|
| +source+ | Fetch the source (download the tarball, clone
|
|
|
|
|
the source repository, etc)
|
|
|
|
|
|
|
|
|
|
| +depends+ | Build and install all dependencies required to
|
|
|
|
|
build the package
|
|
|
|
|
|
|
|
|
|
| +extract+ | Put the source in the package build directory
|
|
|
|
|
(extract the tarball, copy the source, etc)
|
|
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +patch+ | Apply the patches, if any
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +configure+ | Run the configure commands, if any
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +build+ | Run the compilation commands
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
| +install-staging+ |
|
|
|
|
|
*target package:* Run the installation of the package in the
|
2012-11-27 12:59:17 +01:00
|
|
|
staging directory, if necessary
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
| +install-target+ |
|
|
|
|
|
*target package:* Run the installation of the package in the
|
2012-11-27 12:59:17 +01:00
|
|
|
target directory, if necessary
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
| +install+ |
|
2012-11-27 12:59:17 +01:00
|
|
|
*target package:* Run the 2 previous installation commands
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
*host package:* Run the installation of the package in the host
|
|
|
|
|
directory
|
|
|
|
|
|
|
|
|
|
|===================================================
|
|
|
|
|
|
|
|
|
|
Additionally, there are some other useful make targets:
|
|
|
|
|
|
|
|
|
|
[width="90%",cols="^1,4",options="header"]
|
|
|
|
|
|===================================================
|
|
|
|
|
| command/target | Description
|
|
|
|
|
|
|
|
|
|
| +show-depends+ | Displays the dependencies required to build the
|
|
|
|
|
package
|
|
|
|
|
|
2014-02-23 16:04:39 +01:00
|
|
|
| +graph-depends+ | Generate a dependency graph of the package, in the
|
|
|
|
|
context of the current Buildroot configuration. See
|
|
|
|
|
xref:graph-depends[this section] for more details about dependency
|
|
|
|
|
graphs.
|
|
|
|
|
|
2012-11-11 04:14:54 +01:00
|
|
|
| +dirclean+ | Remove the whole package build directory
|
|
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +rebuild+ | Re-run the compilation commands - this only makes
|
|
|
|
|
sense when using the +OVERRIDE_SRCDIR+ feature or when you modified a file
|
|
|
|
|
directly in the build directory
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +reconfigure+ | Re-run the configure commands, then rebuild - this only
|
|
|
|
|
makes sense when using the +OVERRIDE_SRCDIR+ feature or when you modified a
|
|
|
|
|
file directly in the build directory
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
|===================================================
|
