aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/writing-rules.txt
diff options
context:
space:
mode:
authorGravatar Thomas De Schampheleire <patrickdepinguin@gmail.com>2014-05-02 07:47:30 +0200
committerGravatar Peter Korsgaard <peter@korsgaard.com>2014-05-02 10:27:59 +0200
commit86a415df8a26c0a13af964097ea0a46060a33cb1 (patch)
tree059ff62c8216351cdfab062621587842c0e154e9 /docs/manual/writing-rules.txt
parent4e5515382de952664398e1b8378b662d07f762e5 (diff)
downloadbuildroot-86a415df8a26c0a13af964097ea0a46060a33cb1.tar.gz
buildroot-86a415df8a26c0a13af964097ea0a46060a33cb1.tar.bz2
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>
Diffstat (limited to 'docs/manual/writing-rules.txt')
-rw-r--r--docs/manual/writing-rules.txt12
1 files changed, 4 insertions, 8 deletions
diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt
index 376dbfd611..757e1c6c20 100644
--- a/docs/manual/writing-rules.txt
+++ b/docs/manual/writing-rules.txt
@@ -1,8 +1,7 @@
// -*- mode:doc; -*-
// vim: set syntax=asciidoc:
-Coding style
-------------
+== Coding style
Overall, these coding style rules are here to help you to add new files in
Buildroot or refactor existing ones.
@@ -17,8 +16,7 @@ file,
[[writing-rules-config-in]]
-+Config.in+ file
-~~~~~~~~~~~~~~~~
+=== +Config.in+ file
+Config.in+ files contain entries for almost anything configurable in
Buildroot.
@@ -49,8 +47,7 @@ http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[].
[[writing-rules-mk]]
-The +.mk+ file
-~~~~~~~~~~~~~~
+=== The +.mk+ file
* Header: The file starts with a header. It contains the module name,
preferably in lowercase, enclosed between separators made of 80 hashes. A
@@ -135,8 +132,7 @@ LIBFOO_POST_INSTALL_TARGET_HOOKS += LIBFOO_REMOVE_DATA
endif
---------------------
-The documentation
-~~~~~~~~~~~~~~~~~
+=== The documentation
The documentation uses the
http://www.methods.co.nz/asciidoc/[asciidoc] format.