2013-02-13 13:59:02 +01:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:42 +01:00
|
|
|
|
2012-08-18 23:58:55 +02:00
|
|
|
[[adding-packages]]
|
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
|
|
|
== Adding new packages to Buildroot
|
2011-10-10 10:46:39 +02:00
|
|
|
|
|
|
|
|
This section covers how new packages (userspace libraries or
|
|
|
|
|
applications) can be integrated into Buildroot. It also shows how
|
|
|
|
|
existing packages are integrated, which is needed for fixing issues or
|
|
|
|
|
tuning their configuration.
|
|
|
|
|
|
2018-04-02 00:31:56 +02:00
|
|
|
When you add a new package, be sure to test it in various conditions
|
|
|
|
|
(see xref:testing-package[]) and also check it for coding style (see
|
|
|
|
|
xref:check-package[]).
|
2017-04-06 20:18:41 +02:00
|
|
|
|
2011-10-10 10:46:39 +02:00
|
|
|
include::adding-packages-directory.txt[]
|
|
|
|
|
|
2012-07-06 00:06:46 +02:00
|
|
|
include::adding-packages-generic.txt[]
|
2011-10-10 10:46:39 +02:00
|
|
|
|
2012-07-06 00:06:46 +02:00
|
|
|
include::adding-packages-autotools.txt[]
|
2011-10-10 10:46:39 +02:00
|
|
|
|
2012-07-06 00:06:46 +02:00
|
|
|
include::adding-packages-cmake.txt[]
|
2011-10-10 10:46:39 +02:00
|
|
|
|
2013-12-11 21:26:36 +01:00
|
|
|
include::adding-packages-python.txt[]
|
|
|
|
|
|
2014-01-11 16:42:11 +01:00
|
|
|
include::adding-packages-luarocks.txt[]
|
|
|
|
|
|
2014-02-23 15:17:19 +01:00
|
|
|
include::adding-packages-perl.txt[]
|
|
|
|
|
|
2014-04-05 17:21:44 +02:00
|
|
|
include::adding-packages-virtual.txt[]
|
|
|
|
|
|
2014-08-03 17:32:41 +02:00
|
|
|
include::adding-packages-kconfig.txt[]
|
|
|
|
|
|
2015-01-12 10:32:07 +01:00
|
|
|
include::adding-packages-rebar.txt[]
|
|
|
|
|
|
2016-10-30 17:02:14 +01:00
|
|
|
include::adding-packages-waf.txt[]
|
|
|
|
|
|
2017-10-29 14:10:52 +01:00
|
|
|
include::adding-packages-meson.txt[]
|
|
|
|
|
|
2018-02-04 19:07:48 +01:00
|
|
|
include::adding-packages-cargo.txt[]
|
|
|
|
|
|
2018-03-31 15:27:31 +02:00
|
|
|
include::adding-packages-golang.txt[]
|
|
|
|
|
|
2020-02-17 22:23:24 +01:00
|
|
|
include::adding-packages-qmake.txt[]
|
|
|
|
|
|
2015-07-12 02:21:32 +02:00
|
|
|
include::adding-packages-kernel-module.txt[]
|
|
|
|
|
|
2014-10-03 19:01:59 +02:00
|
|
|
include::adding-packages-asciidoc.txt[]
|
|
|
|
|
|
2015-07-14 19:35:15 +02:00
|
|
|
include::adding-packages-linux-kernel-spec-infra.txt[]
|
|
|
|
|
|
2013-11-07 11:41:23 +01:00
|
|
|
include::adding-packages-hooks.txt[]
|
|
|
|
|
|
2011-10-10 10:46:39 +02:00
|
|
|
include::adding-packages-gettext.txt[]
|
|
|
|
|
|
2012-11-11 04:14:57 +01:00
|
|
|
include::adding-packages-tips.txt[]
|
|
|
|
|
|
2011-10-10 10:46:39 +02:00
|
|
|
include::adding-packages-conclusion.txt[]
|
