buildroot/docs/manual/patch-policy.txt, branch 2017.08

docs/manual: fix patch naming convention

2016-08-09T13:45:32+00:00

Otherwise conflicts with the naming convention from previous section. Signed-off-by: Gary Bisson Signed-off-by: Thomas Petazzoni

docs/manual: add section about patch licensing

2016-03-01T11:46:58+00:00

Use the same text that is used in COPYING. Signed-off-by: Luca Ceresoli Cc: "Yann E. MORIN" Cc: Arnout Vandecappelle (Essensium/Mind) Cc: Peter Korsgaard Cc: Thomas Petazzoni Cc: Steve Calfee Acked-by: Thomas Petazzoni Signed-off-by: Peter Korsgaard

docs/manual: slightly clarify patch licensing

2016-02-25T10:33:00+00:00

Adding a patch is a modification to Buildroot. Thus this sentence might be interpreted as "Patches are released under the Buildroot license". Being a legal matter, the last thing we want is to be ambiguous. Reword the sentence to avoid any misunderstandings. Signed-off-by: Luca Ceresoli Cc: Thomas Petazzoni Acked-by: "Yann E. MORIN" Acked-by: "Yann E. MORIN" Acked-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Peter Korsgaard

manual: clarify policy when updating a package patch

2015-12-16T22:44:03+00:00

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) Cc: Renaud AUBIN Signed-off-by: Thomas Petazzoni

docs/manual: document the new patch naming convention

2014-12-07T20:32:01+00:00

To ease generating patches, we now use a naming convention that is in line with what git-format-patch does, that is: - do not prefix patches with the package name - prefix patches with a 4-digit mber - start numbering at 0001 Signed-off-by: "Yann E. MORIN" Cc: Peter Korsgaard Cc: Thomas Petazzoni Cc: Thomas De Schampheleire Cc: Arnout Vandecappelle Cc: Samuel Martin Signed-off-by: Thomas Petazzoni

manual/user guide/customization: rename section 'Customizing packages'

2014-09-21T17:41:12+00:00

This small patch renames the section 'Customizing packages' to 'Adding project-specific patches'. Additionally, a minor change is done to the introduction of this section. To better reflect the contents, the source file is renamed. Signed-off-by: Thomas De Schampheleire Signed-off-by: Thomas Petazzoni

manual: use one-line titles instead of two-line titles (trivial)

2014-05-02T08:27:59+00:00

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 Signed-off-by: Peter Korsgaard

manual: update for multiple global patch dirs

2013-12-25T16:31:55+00:00

Updating the documentation to reflect that multiple directories can now be specified for BR2_GLOBAL_PATCH_DIR. Along with giving an example use case of how to use multiple global patch directories. [Thomas: fix minor typo mentionned by Thomas De Schampheleire.] Signed-off-by: Ryan Barnett Cc: Thomas De Schampheleire Cc: Arnout Vandecappelle Reviewed-by: Thomas De Schampheleire Signed-off-by: Thomas Petazzoni

Trivial documentation fix for Signed-off-by

2013-09-16T13:43:00+00:00

Make consistent the capitalization and punctuation of Signed-of-by examples. Signed-off-by: Ralph Siemsen Acked-by: "Samuel Martin" Signed-off-by: Peter Korsgaard

docs/patch-policy.txt: fix missing word

2013-09-16T07:00:15+00:00

Signed-off-by: Peter Korsgaard