2013-02-13 20:59:02 +08:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 11:14:42 +08:00
|
|
|
|
|
|
|
|
[[getting-buildroot]]
|
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 13:47:30 +08:00
|
|
|
== Getting Buildroot
|
2011-10-10 16:46:39 +08:00
|
|
|
|
2014-08-13 04:20:12 +08:00
|
|
|
Buildroot releases are made every 3 months, in February, May, August and
|
|
|
|
|
November. Release numbers are in the format YYYY.MM, so for example
|
|
|
|
|
2013.02, 2014.08.
|
2011-10-10 16:46:39 +08:00
|
|
|
|
2014-08-13 04:20:12 +08:00
|
|
|
Release tarballs are available at http://buildroot.org/downloads/[].
|
2011-10-10 16:46:39 +08:00
|
|
|
|
2015-11-19 06:51:35 +08:00
|
|
|
For your convenience, a https://www.vagrantup.com/[Vagrantfile] is
|
|
|
|
|
available in `support/misc/Vagrantfile` in the Buildroot source tree
|
|
|
|
|
to quickly set up a virtual machine with the needed dependencies to
|
|
|
|
|
get started.
|
|
|
|
|
|
|
|
|
|
If you want to setup an isolated buildroot environment on Linux or Mac
|
|
|
|
|
Os X, paste this line onto your terminal:
|
|
|
|
|
|
|
|
|
|
--------------------
|
2016-02-07 20:40:45 +08:00
|
|
|
curl -O https://buildroot.org/downloads/Vagrantfile; vagrant up
|
2015-11-19 06:51:35 +08:00
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
If you are on Windows, paste this into your powershell:
|
|
|
|
|
|
|
|
|
|
--------------------
|
2016-02-07 20:40:45 +08:00
|
|
|
(new-object System.Net.WebClient).DownloadFile(
|
|
|
|
|
"https://buildroot.org/downloads/Vagrantfile","Vagrantfile");
|
|
|
|
|
vagrant up
|
2015-11-19 06:51:35 +08:00
|
|
|
--------------------
|
|
|
|
|
|
2014-08-13 04:20:12 +08:00
|
|
|
If you want to follow development, you can use the daily snapshots or
|
|
|
|
|
make a clone of the Git repository. Refer to the
|
|
|
|
|
http://buildroot.org/download[Download page] of the Buildroot website
|
|
|
|
|
for more details.
|
