86a415df8a
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>
37 lines
1004 B
Plaintext
37 lines
1004 B
Plaintext
// -*- mode:doc; -*-
|
|
// vim: set syntax=asciidoc:
|
|
|
|
= Appendix
|
|
|
|
include::makedev-syntax.txt[]
|
|
include::makeusers-syntax.txt[]
|
|
|
|
|
|
// Automatically generated lists:
|
|
|
|
[[package-list]]
|
|
== List of target packages available in Buildroot
|
|
|
|
include::package-list.txt[]
|
|
|
|
[[host-package-list]]
|
|
== List of host utilities available in Buildroot
|
|
|
|
The following packages are all available in the menu +Host utilities+.
|
|
|
|
include::host-package-list.txt[]
|
|
|
|
[[deprecated-list]]
|
|
== Deprecated features
|
|
|
|
The following features are marked as _deprecated_ in Buildroot due to
|
|
them being either too old or unmaintained. They will be removed at
|
|
some point, so stop using them.
|
|
Each deprecated symbol in kconfig depends on a symbol
|
|
+BR2_DEPRECATED_SINCE_xxxx_xx+, which provides an indication of when
|
|
the feature can be removed: features will not be removed within the
|
|
year following deprecation. For example, a symbol depending on
|
|
+BR2_DEPRECATED_SINCE_2013_05+ can be removed from 2014.05 onwards.
|
|
|
|
include::deprecated-list.txt[]
|