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> |
||
---|---|---|
.. | ||
adding-packages-autotools.txt | ||
adding-packages-cmake.txt | ||
adding-packages-conclusion.txt | ||
adding-packages-directory.txt | ||
adding-packages-generic.txt | ||
adding-packages-gettext.txt | ||
adding-packages-hooks.txt | ||
adding-packages-luarocks.txt | ||
adding-packages-perl.txt | ||
adding-packages-python.txt | ||
adding-packages-tips.txt | ||
adding-packages-virtual.txt | ||
adding-packages.txt | ||
advanced.txt | ||
appendix.txt | ||
beyond-buildroot.txt | ||
ccache-support.txt | ||
common-usage.txt | ||
configure.txt | ||
contribute.txt | ||
customize-busybox-config.txt | ||
customize-kernel-config.txt | ||
customize-outside-br.txt | ||
customize-packages.txt | ||
customize-rootfs.txt | ||
customize-store.txt | ||
customize-toolchain.txt | ||
customize-uclibc-config.txt | ||
customize.txt | ||
debugging-buildroot.txt | ||
developer-guide.txt | ||
download-infra.txt | ||
download-location.txt | ||
eclipse-integration.txt | ||
faq-troubleshooting.txt | ||
get-involved.txt | ||
getting.txt | ||
going-further.txt | ||
how-buildroot-works.txt | ||
introduction.txt | ||
known-issues.txt | ||
legal-notice.txt | ||
make-tips.txt | ||
makedev-syntax.txt | ||
makeusers-syntax.txt | ||
manual.mk | ||
manual.txt | ||
package-make-target.txt | ||
patch-policy.txt | ||
prerequisite.txt | ||
rebuilding-packages.txt | ||
starting-up.txt | ||
using-buildroot-development.txt | ||
using-buildroot-toolchain.txt | ||
using.txt | ||
working-with.txt | ||
writing-rules.txt |