2012-11-11 04:14:42 +01:00
|
|
|
// -*- mode:doc; -*-
|
2013-02-13 13:59:02 +01:00
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:42 +01: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
|
|
|
=== Location of downloaded packages
|
2011-10-10 10:46:39 +02:00
|
|
|
|
2012-12-29 05:42:33 +01:00
|
|
|
The various tarballs that are downloaded by Buildroot are all stored
|
|
|
|
|
in +BR2_DL_DIR+, which by default is the +dl+ directory. If you want
|
2011-10-10 10:46:39 +02:00
|
|
|
to keep a complete version of Buildroot which is known to be working
|
2012-11-27 12:59:17 +01:00
|
|
|
with the associated tarballs, you can make a copy of this directory.
|
2012-12-29 05:42:33 +01:00
|
|
|
This will allow you to regenerate the toolchain and the target
|
|
|
|
|
filesystem with exactly the same versions.
|
2011-10-10 10:46:39 +02:00
|
|
|
|
|
|
|
|
If you maintain several Buildroot trees, it might be better to have a
|
2012-12-29 05:42:33 +01:00
|
|
|
shared download location. This can be achieved by pointing the
|
2014-02-04 16:18:51 +01:00
|
|
|
+BR2_DL_DIR+ environment variable to a directory. If this is
|
2012-12-29 05:42:33 +01:00
|
|
|
set, then the value of +BR2_DL_DIR+ in the Buildroot configuration is
|
|
|
|
|
overridden. The following line should be added to +<~/.bashrc>+.
|
2011-10-10 10:46:39 +02:00
|
|
|
|
|
|
|
|
-----------------
|
2014-02-04 16:18:51 +01:00
|
|
|
$ export BR2_DL_DIR <shared download location>
|
2011-10-10 10:46:39 +02:00
|
|
|
-----------------
|
2012-11-27 12:59:17 +01:00
|
|
|
|
|
|
|
|
The download location can also be set in the +.config+ file, with the
|
2014-02-04 16:18:51 +01:00
|
|
|
+BR2_DL_DIR+ option. Unlike most options in the .config file, this value
|
|
|
|
|
is overridden by the +BR2_DL_DIR+ environment variable.
|
