]> rtime.felk.cvut.cz Git - coffee/buildroot.git/commit
manual: use one-line titles instead of two-line titles (trivial)
authorThomas De Schampheleire <patrickdepinguin@gmail.com>
Fri, 2 May 2014 05:47:30 +0000 (07:47 +0200)
committerPeter Korsgaard <peter@korsgaard.com>
Fri, 2 May 2014 08:27:59 +0000 (10:27 +0200)
commit86a415df8a26c0a13af964097ea0a46060a33cb1
tree059ff62c8216351cdfab062621587842c0e154e9
parent4e5515382de952664398e1b8378b662d07f762e5
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>
56 files changed:
docs/manual/adding-packages-autotools.txt
docs/manual/adding-packages-cmake.txt
docs/manual/adding-packages-conclusion.txt
docs/manual/adding-packages-directory.txt
docs/manual/adding-packages-generic.txt
docs/manual/adding-packages-gettext.txt
docs/manual/adding-packages-hooks.txt
docs/manual/adding-packages-luarocks.txt
docs/manual/adding-packages-perl.txt
docs/manual/adding-packages-python.txt
docs/manual/adding-packages-tips.txt
docs/manual/adding-packages-virtual.txt
docs/manual/adding-packages.txt
docs/manual/advanced.txt
docs/manual/appendix.txt
docs/manual/beyond-buildroot.txt
docs/manual/ccache-support.txt
docs/manual/common-usage.txt
docs/manual/configure.txt
docs/manual/contribute.txt
docs/manual/customize-busybox-config.txt
docs/manual/customize-kernel-config.txt
docs/manual/customize-outside-br.txt
docs/manual/customize-packages.txt
docs/manual/customize-rootfs.txt
docs/manual/customize-store.txt
docs/manual/customize-toolchain.txt
docs/manual/customize-uclibc-config.txt
docs/manual/customize.txt
docs/manual/debugging-buildroot.txt
docs/manual/developer-guide.txt
docs/manual/download-infra.txt
docs/manual/download-location.txt
docs/manual/eclipse-integration.txt
docs/manual/faq-troubleshooting.txt
docs/manual/get-involved.txt
docs/manual/getting.txt
docs/manual/going-further.txt
docs/manual/how-buildroot-works.txt
docs/manual/introduction.txt
docs/manual/known-issues.txt
docs/manual/legal-notice.txt
docs/manual/make-tips.txt
docs/manual/makedev-syntax.txt
docs/manual/makeusers-syntax.txt
docs/manual/manual.txt
docs/manual/package-make-target.txt
docs/manual/patch-policy.txt
docs/manual/prerequisite.txt
docs/manual/rebuilding-packages.txt
docs/manual/starting-up.txt
docs/manual/using-buildroot-development.txt
docs/manual/using-buildroot-toolchain.txt
docs/manual/using.txt
docs/manual/working-with.txt
docs/manual/writing-rules.txt