2014-04-05 17:21:44 +02:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
|
|
|
|
|
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
|
|
|
=== Infrastructure for virtual packages
|
2014-04-05 17:21:44 +02:00
|
|
|
|
2014-04-05 17:21:46 +02:00
|
|
|
[[virtual-package-tutorial]]
|
2014-04-05 17:21:44 +02:00
|
|
|
|
|
|
|
|
In Buildroot, a virtual package is a package whose functionalities are
|
|
|
|
|
provided by one or more packages, referred to as 'providers'. The virtual
|
|
|
|
|
package management is an extensible mechanism allowing the user to choose
|
|
|
|
|
the provider used in the rootfs.
|
|
|
|
|
|
|
|
|
|
For example, 'OpenGL ES' is an API for 2D and 3D graphics on embedded systems.
|
|
|
|
|
The implementation of this API is different for the 'Allwinner Tech Sunxi' and
|
|
|
|
|
the 'Texas Instruments OMAP35xx' plaftorms. So +libgles+ will be a virtual
|
|
|
|
|
package and +sunxi-mali+ and +ti-gfx+ will be the providers.
|
|
|
|
|
|
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
|
|
|
==== +virtual-package+ tutorial
|
2014-04-05 17:21:46 +02:00
|
|
|
|
2014-04-05 17:21:44 +02:00
|
|
|
In the following example, we will explain how to add a new virtual package
|
|
|
|
|
('something-virtual') and a provider for it ('some-provider').
|
|
|
|
|
|
|
|
|
|
First, let's create the virtual package.
|
|
|
|
|
|
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
|
|
|
==== Virtual package's +Config.in+ file
|
2014-04-05 17:21:44 +02:00
|
|
|
|
|
|
|
|
The +Config.in+ file of virtual package 'something-virtual' should contain:
|
|
|
|
|
|
|
|
|
|
---------------------------
|
|
|
|
|
01: config BR2_PACKAGE_HAS_SOMETHING_VIRTUAL
|
|
|
|
|
02: bool
|
|
|
|
|
03:
|
|
|
|
|
04: config BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL
|
|
|
|
|
05: depends on BR2_PACKAGE_HAS_SOMETHING_VIRTUAL
|
|
|
|
|
06: string
|
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
|
|
In this file, we declare two options, +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+ and
|
|
|
|
|
+BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+, whose values will be used by the
|
|
|
|
|
providers.
|
|
|
|
|
|
2014-05-15 19:37:04 +02:00
|
|
|
==== Virtual package's +.mk+ file
|
2014-04-05 17:21:44 +02:00
|
|
|
|
2014-04-05 17:21:46 +02:00
|
|
|
The +.mk+ for the virtual package should just evaluate the +virtual-package+ macro:
|
2014-04-05 17:21:44 +02:00
|
|
|
|
|
|
|
|
---------------------------
|
|
|
|
|
01: ################################################################################
|
|
|
|
|
02: #
|
|
|
|
|
03: # something-virtual
|
|
|
|
|
04: #
|
|
|
|
|
05: ################################################################################
|
|
|
|
|
06:
|
2014-04-05 17:21:46 +02:00
|
|
|
07: $(eval $(virtual-package))
|
2014-04-05 17:21:44 +02:00
|
|
|
---------------------------
|
|
|
|
|
|
2014-04-05 17:21:46 +02:00
|
|
|
The ability to have target and host packages is also available, with the
|
|
|
|
|
+host-virtual-package+ macro.
|
2014-04-05 17:21:44 +02:00
|
|
|
|
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
|
|
|
==== Provider's +Config.in+ file
|
2014-04-05 17:21:44 +02:00
|
|
|
|
|
|
|
|
When adding a package as a provider, only the +Config.in+ file requires some
|
2014-05-15 19:37:04 +02:00
|
|
|
modifications.
|
2014-04-05 17:21:44 +02:00
|
|
|
|
|
|
|
|
The +Config.in+ file of the package 'some-provider', which provides the
|
|
|
|
|
functionalities of 'something-virtual', should contain:
|
|
|
|
|
|
|
|
|
|
---------------------------
|
|
|
|
|
01: config BR2_PACKAGE_SOME_PROVIDER
|
|
|
|
|
02: bool "some-provider"
|
|
|
|
|
03: select BR2_PACKAGE_HAS_SOMETHING_VIRTUAL
|
|
|
|
|
04: help
|
|
|
|
|
05: This is a comment that explains what some-provider is.
|
|
|
|
|
06:
|
|
|
|
|
07: http://foosoftware.org/some-provider/
|
|
|
|
|
08:
|
|
|
|
|
09: if BR2_PACKAGE_SOME_PROVIDER
|
|
|
|
|
10: config BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL
|
|
|
|
|
11: default "some-provider"
|
|
|
|
|
12: endif
|
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
|
|
On line 3, we select +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+, and on line 11, we
|
|
|
|
|
set the value of +BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+ to the name of the
|
|
|
|
|
provider, but only if it is selected.
|
|
|
|
|
|
2014-05-15 19:37:04 +02:00
|
|
|
==== Provider's +.mk+ file
|
|
|
|
|
|
|
|
|
|
The +.mk+ file should also declare an additional variable
|
|
|
|
|
+SOME_PROVIDER_PROVIDES+ to contain the names of all the virtual
|
|
|
|
|
packages it is an implementation of:
|
|
|
|
|
|
|
|
|
|
---------------------------
|
|
|
|
|
01: SOME_PROVIDER_PROVIDES = something-virtual
|
|
|
|
|
---------------------------
|
|
|
|
|
|
2014-04-05 17:21:44 +02:00
|
|
|
Of course, do not forget to add the proper build and runtime dependencies for
|
|
|
|
|
this package!
|
2014-04-05 17:21:47 +02:00
|
|
|
|
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
|
|
|
==== Notes on depending on a virtual package
|
2014-04-05 17:21:47 +02:00
|
|
|
|
|
|
|
|
When adding a package that requires a certain +FEATURE+ provided by a virtual
|
|
|
|
|
package, you have to use +depends on BR2_PACKAGE_HAS_FEATURE+, like so:
|
|
|
|
|
|
|
|
|
|
---------------------------
|
|
|
|
|
config BR2_PACKAGE_HAS_FEATURE
|
|
|
|
|
bool
|
|
|
|
|
|
|
|
|
|
config BR2_PACKAGE_FOO
|
|
|
|
|
bool "foo"
|
|
|
|
|
depends on BR2_PACKAGE_HAS_FEATURE
|
|
|
|
|
---------------------------
|
|
|
|
|
|
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
|
|
|
==== Notes on depending on a specific provider
|
2014-04-05 17:21:47 +02:00
|
|
|
|
|
|
|
|
If your package really requires a specific provider, then you'll have to
|
|
|
|
|
make your package +depends on+ this provider; you can _not_ +select+ a
|
|
|
|
|
provider.
|
|
|
|
|
|
|
|
|
|
Let's take an example with two providers for a +FEATURE+:
|
|
|
|
|
|
|
|
|
|
---------------------------
|
|
|
|
|
config BR2_PACKAGE_HAS_FEATURE
|
|
|
|
|
bool
|
|
|
|
|
|
|
|
|
|
config BR2_PACKAGE_FOO
|
|
|
|
|
bool "foo"
|
|
|
|
|
select BR2_PACKAGE_HAS_FEATURE
|
|
|
|
|
|
|
|
|
|
config BR2_PACKAGE_BAR
|
|
|
|
|
bool "bar"
|
|
|
|
|
select BR2_PACKAGE_HAS_FEATURE
|
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
|
|
And you are adding a package that needs +FEATURE+ as provided by +foo+,
|
|
|
|
|
but not as provided by +bar+.
|
|
|
|
|
|
|
|
|
|
If you were to use +select BR2_PACKAGE_FOO+, then the user would still
|
|
|
|
|
be able to select +BR2_PACKAGE_BAR+ in the menuconfig. This would create
|
|
|
|
|
a configuration inconsistency, whereby two providers of the same +FEATURE+
|
|
|
|
|
would be enabled at once, one explicitly set by the user, the other
|
|
|
|
|
implicitly by your +select+.
|
|
|
|
|
|
|
|
|
|
Instead, you have to use +depends on BR2_PACKAGE_FOO+, which avoids any
|
|
|
|
|
implicit configuration inconsistency.
|
