buildroot/docs/manual/adding-packages-tips.txt, branch 2017.02.1

docs/manual: Modify GitHub FOO_SITE explanation

2015-07-28T21:37:39+00:00

GitHub has changed its layout, there is no longer any green nor grey button, it's a link with a tiny icon that indicates if it's uploaded by the maintainer or not. In order to not confuse anyone, adding an image should make it clear. Signed-off-by: Maxime Hadjinlian Reviewed-by: Lionel Orry Signed-off-by: Thomas Petazzoni

manual: don't use a comment at the end of the version variable assignment

2015-04-27T21:31:28+00:00

The comment at the end of the version string assigment could lead to a download failure so don't use it as a example. Signed-off-by: Fabio Porcedda Reported-by: Yann E. MORIN Signed-off-by: Thomas Petazzoni

docs/manual: cleanup github helper docs

2014-11-11T20:49:37+00:00

Explicitly state that the github helper should not be used when there is a release tarball. Properly render the list by separating it from the previous paragraph. [Peter: fix typo as pointed out by Maxime] Signed-off-by: "Yann E. MORIN" Cc: Maxime Hadjinlian Acked-by: Samuel Martin Signed-off-by: Peter Korsgaard

manual: Add note about uses of github helper

2014-10-16T17:05:40+00:00

Add a little comment regarding the uses of the github helper for the releases. [Arnout: extend the comment a little] Signed-off-by: Maxime Hadjinlian Signed-off-by: Arnout Vandecappelle (Essensium/Mind) Cc: Samuel Martin Acked-by: Samuel Martin Signed-off-by: Thomas Petazzoni

replace github with GitHub

2014-06-04T21:14:08+00:00

The correct capitalisation pattern is "GitHub"; fix manual and makefile commentary. Signed-off-by: Simon Dawson Signed-off-by: Peter Korsgaard

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/adding-packages-tips.txt: reword part about package name

2014-03-23T19:54:34+00:00

Signed-off-by: Jerzy Grzegorek Acked-by: "Yann E. MORIN" Signed-off-by: Peter Korsgaard

docs: document the new github helper function

2013-12-06T21:37:34+00:00

[Thomas: splitted from Mischa original commit] Signed-off-by: Mischa Jonker Signed-off-by: Thomas Petazzoni Acked-by: Thomas De Schampheleire Signed-off-by: Peter Korsgaard

manual: github commits should be specified in full

2013-11-02T15:16:47+00:00

Signed-off-by: Thomas De Schampheleire Acked-by: Samuel Martin Signed-off-by: Thomas Petazzoni

manual: github: merge tag/commit ID examples

2013-06-07T08:48:45+00:00

And reword as suggested by Samuel. Signed-off-by: Peter Korsgaard