summaryrefslogtreecommitdiffstats
path: root/docs/manual/makedev-syntax.txt
Commit message (Collapse)AuthorAgeFilesLines
* makedevs: add capability supportPhilippe Reynes2016-06-301-0/+30
| | | | | | | | | | | | Add the support of capability to makedevs as extended attribute. Now, it's possible to add a line "|xattr <capability>" after a file description to also add a capability to this file. It's possible to add severals capabilities with severals lines. [Peter: extend doc, reword Config.in, extend error message, use HOST_MAKEDEVS_CFLAGS/LDFLAGS for all flags] Signed-off-by: Philippe Reynes <philippe.reynes@sagemcom.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: Fixed syntax error in makedev-syntax example.Alan Yaniger2016-05-231-1/+1
| | | | | | | | | In the makedev syntax documentation, one of the examples lacks the "mode" value. This patch fixes that example. Signed-off-by: Alan Yaniger <alan@tkos.co.il> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: makedev syntax accepts usernames and group namesYann E. MORIN2016-02-011-8/+12
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: makedevs only accepts numerical valuesYann E. MORIN2015-08-291-4/+7
| | | | | | | | | | | | | | | | | | | | | | | | | Because of a limitation in how makedevs resolves names [0], usernames and groupnames would be resolved with UIDs and GIDs from the host, not the target. Fixing makedevs would involve us rewriting a /etc/passwd and /etc/group parser (not too complex, still not trivial). Document that the user and group fields should only be numbers, not names. Also, the manual is currently misleading, as an example indeed uses names for the user and group fields. Fix that and expand the explanations. The mode field should also be numbers, not a rwx combo. Slight typographical eye-candy about major/minor fields. [0] it uses getpwnma(3) and getgrnam(3) to resolve names to IDs, and those only resolve names on the host (i.e. there is no way to specify a chroot-like feature) Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: documentation for recursive makedevs syntaxAngelo Compagnucci2015-04-111-1/+9
| | | | | | | | | | | This patch adds the documentation for the new makedevs recursive syntax. [Thomas: s/folder/directory/ as suggested by Yann.] Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Rework makedevs syntaxMaxime Hadjinlian2014-11-221-11/+13
| | | | | | | | | | State that it should be a space separated list and fix the example. Also reduce the number of dash used to 4. [Thomas: replace tab by space, as noted by Yann.] Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: use one-line titles instead of two-line titles (trivial)Thomas De Schampheleire2014-05-021-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* manual: cleanup and update editor tagsSamuel Martin2013-02-171-1/+2
| | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: various fixesArnout Vandecappelle (Essensium/Mind)2012-11-271-1/+2
| | | | | | | | | | Various consistency and correctness improvements. Also removing some sentences that are not or no longer relevant. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: trivial fixesArnout Vandecappelle (Essensium/Mind)2012-11-271-1/+1
| | | | | Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: minor tweaksSimon Dawson2012-11-161-9/+8
| | | | | | | | | Minor grammatical and spelling tweaks to the manual content. Signed-off-by: Simon Dawson <spdawson@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: rework the whole documentation stubSamuel Martin2012-11-151-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The new skeleton of the manual as it has been thought: 1. About Buildroot: Presentation of Buildroot 2. Starting up: Everything to quickly and easily start working with Buildroot 3. Working with Buildroot Basics to make your work fitting your needs 4. Troubleshooting 5. Going further in Buildroot's innards Explaination of how buildroot is organised, how it works, etc 6. Developer Guidelines 7. Getting involved 8. Contibuting to Buildroot 9. Legal notice 10. Appendix It is easy to distinguish two parts in this plan: - Sections 1 to 4 mainly address people starting with Buildroot - Sections 5 to 10 are more focused on how to develop Buildroot itself Most of the existing sections have just been moved in the hierarchy, few were split and dispatch in, what i think was the relevant section, and numerous others have been created. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Add documentation for makedevMaxime Ripard2012-02-191-0/+54
Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
OpenPOWER on IntegriCloud