2013-02-13 13:59:02 +01:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:42 +01:00
|
|
|
|
2012-02-18 00:30:58 +01:00
|
|
|
[[makedev-syntax]]
|
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
|
|
|
== Makedev syntax documentation
|
2012-02-18 00:30:58 +01:00
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
The makedev syntax is used in several places in Buildroot to
|
|
|
|
|
define changes to be made for permissions, or which device files to
|
|
|
|
|
create and how to create them, in order to avoid calls to mknod.
|
2012-02-18 00:30:58 +01:00
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
This syntax is derived from the makedev utility, and more complete
|
2012-02-18 00:30:58 +01:00
|
|
|
documentation can be found in the +package/makedevs/README+ file.
|
|
|
|
|
|
2014-11-15 17:29:18 +01:00
|
|
|
It takes the form of a space separated list of fields, one file per
|
|
|
|
|
line; the fields are:
|
2012-02-18 00:30:58 +01:00
|
|
|
|
|
|
|
|
|===========================================================
|
|
|
|
|
|name |type |mode |uid |gid |major |minor |start |inc |count
|
|
|
|
|
|===========================================================
|
|
|
|
|
|
2014-11-15 17:29:18 +01:00
|
|
|
There are a few non-trivial blocks:
|
2012-02-18 00:30:58 +01:00
|
|
|
|
|
|
|
|
- +name+ is the path to the file you want to create/modify
|
2012-11-27 12:59:16 +01:00
|
|
|
- +type+ is the type of the file, being one of:
|
2012-02-18 00:30:58 +01:00
|
|
|
* f: a regular file
|
|
|
|
|
* d: a directory
|
|
|
|
|
* c: a character device file
|
|
|
|
|
* b: a block device file
|
|
|
|
|
* p: a named pipe
|
2012-11-16 05:54:19 +01:00
|
|
|
- +mode+, +uid+ and +gid+ are the usual permissions settings
|
2012-11-27 12:59:17 +01:00
|
|
|
- +major+ and +minor+ are here for device files - set to - for other
|
|
|
|
|
files
|
2012-11-16 05:54:19 +01:00
|
|
|
- +start+, +inc+ and +count+ are for when you want to create a batch
|
2012-02-18 00:30:58 +01:00
|
|
|
of files, and can be reduced to a loop, beginning at +start+,
|
|
|
|
|
incrementing its counter by +inc+ until it reaches +count+
|
|
|
|
|
|
2012-11-16 05:54:19 +01:00
|
|
|
Let's say you want to change the permissions of a given file; using
|
2012-02-18 00:30:58 +01:00
|
|
|
this syntax, you will need to put:
|
2014-11-15 17:29:18 +01:00
|
|
|
|
|
|
|
|
----
|
|
|
|
|
/usr/bin/foobar f 644 0 0 - - - - -
|
|
|
|
|
----
|
2012-02-18 00:30:58 +01:00
|
|
|
|
|
|
|
|
On the other hand, if you want to create the device file +/dev/hda+
|
|
|
|
|
and the corresponding 15 files for the partitions, you will need for
|
|
|
|
|
+/dev/hda+:
|
|
|
|
|
|
2014-11-15 17:29:18 +01:00
|
|
|
----
|
|
|
|
|
/dev/hda b 640 0 0 3 0 0 0 -
|
|
|
|
|
----
|
2012-02-18 00:30:58 +01:00
|
|
|
|
|
|
|
|
and then for device files corresponding to the partitions of
|
|
|
|
|
+/dev/hda+, +/dev/hdaX+, +X+ ranging from 1 to 15:
|
|
|
|
|
|
2014-11-15 17:29:18 +01:00
|
|
|
----
|
|
|
|
|
/dev/hda b 640 0 0 3 1 1 1 15
|
|
|
|
|
----
|
2012-02-18 00:30:58 +01:00
|
|
|
|
