buildroot/docs/manual, branch 2017.05

docs/manual: PEP8 coding style for Python scripts

2017-04-27T19:37:50+00:00

The advantages of using a pre-existing coding style instead of creating our own are: - documenting on the manual takes a single sentence; - there are automatic tools to help during development/review. So document that PEP8 recommendation should be followed. Cc: Arnout Vandecappelle Cc: Maxime Hadjinlian Cc: Samuel Martin Cc: Thomas De Schampheleire Signed-off-by: Ricardo Martincoski Signed-off-by: Peter Korsgaard

support/test-pkg: run legal-info

2017-04-17T13:54:33+00:00

Signed-off-by: "Yann E. MORIN" Signed-off-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Thomas Petazzoni

docs/manual: contribute: fix license string for Buildroot license

2017-04-15T08:24:22+00:00

As per section 12.2 "Complying with the Buildroot license", Buildroot is released under GPL version 2 or (at your option) any later version. But SPDX license string for Buildroot license in section 21.5 "Submitting patches" refers to only GPL version 2. Fix this inconsistency by using correct SPDX identifier. Signed-off-by: Rahul Bedarkar Signed-off-by: Thomas Petazzoni

docs/manual: size of tab in package description

2017-04-08T14:15:36+00:00

Explicitly state that one tab counts for 8 columns in package description, leaving 62 characters to the text itself. Update the text and the example in the two places where the Config.in format is described. Also mention a newline is expected between the help text itself and the upstream URL. This blob can help developers to understand the expected formatting. Also, it can be referenced by reviewers. http://patchwork.ozlabs.org/patch/611289/ http://patchwork.ozlabs.org/patch/606866/ http://patchwork.ozlabs.org/patch/459960/ Signed-off-by: Ricardo Martincoski Cc: Arnout Vandecappelle Cc: Thomas Petazzoni Cc: Romain Naour Signed-off-by: Thomas Petazzoni

support/test-pkg: print number of toolchains and progress

2017-04-06T19:51:29+00:00

Signed-off-by: "Yann E. MORIN" Cc: Thomas De Schampheleire Signed-off-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Thomas Petazzoni

docs/manual: document the test-pkg script

2017-04-06T19:50:59+00:00

Signed-off-by: "Yann E. MORIN" Signed-off-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Thomas Petazzoni

docs/manual: refer to SPDX License List

2017-04-01T13:11:18+00:00

We want to use SPDX short identifier for license string as much as possible. So refer to SPDX license list and use SPDX short identifier for license strings in documentation. Also remove License abbreviations that we have. Signed-off-by: Rahul Bedarkar [Thomas: take into account suggestions from Arnout.] Acked-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Thomas Petazzoni

core: enhance printvars

2017-03-29T19:55:14+00:00

Currently, the output of printvars copntains the name of the variable, its expanded value and its un-expanded value. However, most of the time, we need the actual, expanded value, so it can be re-used from a (non-Buildroot) infrastructure script, like a post-build script, or a build-farm driver (e.g. a Jenkins job...) Add two options that a user may set to change the output of printvars: - QUOTED_VARS, if set, will quote the value - RAW_VARS, if set, will print the unexpanded value The new output by default only prints the expanded value now. So that it can be used as such: $ make -s printvars VARS=BUSYBOX_VERSION BUSYBOX_VERSION=1.26.2 $ make -s printvars VARS=BUSYBOX_RDEPENDENCIES QUOTED_VARS=YES BUSYBOX_RDEPENDENCIES='ncurses util-linux' $ make -s printvars VARS=BUSYBOX_FINAL_PATCH_DEPENDENCIES RAW_VARS=YES BUSYBOX_FINAL_PATCH_DEPENDENCIES=$(sort $(BUSYBOX_PATCH_DEPENDENCIES)) And it is even possible to directly evaluate it in a shell script: eval $(make -s printvars VARS=BUSYBOX_VERSION QUOTED_VARS=YES) Backward compatibility of the output is not maintained. It is believed that scripts that depended on the previous output were very fragile to begin with, because they had to filter the non-formatted output (splitting on spaces or braces was not really possible, because values could contain either). Document printvars and its options in the manual; list it in the output of 'make help'. Signed-off-by: "Yann E. MORIN" Cc: Thomas De Schampheleire Cc: Arnout Vandecappelle Reviewed-by: Arnout Vandecappelle (Essensium/Mind) Signed-off-by: Thomas Petazzoni

docs/manual: document MPL licenses

2017-03-16T15:58:04+00:00

Many packages are provided under MPL v1.1 and v2.0. Document it under License abbreviations section. Cc: Thomas De Schampheleire Signed-off-by: Rahul Bedarkar Signed-off-by: Peter Korsgaard

docs/manual: document ISC license

2017-03-16T15:57:41+00:00

Many packages are provided under ISC license. Document it under License abbreviations section. Cc: Thomas De Schampheleire Signed-off-by: Rahul Bedarkar Signed-off-by: Peter Korsgaard