aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Update for 2017.08-rc12017.08-rc1Gravatar Thomas Petazzoni2017-08-022-11/+34
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core/legal-info: use hash file from version sub-dirGravatar Yann E. MORIN2017-07-291-1/+3
| | | | | | | | | | | | | | | | | | | | | | When we have multiple versions for a package, and the licensing terms depend on the version actually selected (e.g. like Qt5), storing the hashes for those license files in the .hash file is broken: the infra will ensure that all hashes for a file do match, which would not be the case here. We fix that by first looking for a hash file in the version sub-dir first, and if that does not exist, then we use the main hash file. Drop the useless intermediate variable 'ret'. Update the documentation accordingly. Reported-by: Joshua Henderson <joshua.henderson@microchip.com> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Joshua Henderson <joshua.henderson@microchip.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: update for 2017.05.2Gravatar Peter Korsgaard2017-07-272-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.5Gravatar Peter Korsgaard2017-07-272-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* package/linux-tools: change method for including linux-tool sub-makefilesGravatar Markus Mayer2017-07-191-2/+2
| | | | | | | | | | | | | | | | | | Make inclusion ordering of all linux-tool-*.mk sub-makefiles explicit instead of relying on alphabetical sort order. This is done by renaming the Linux tools sub-makefiles to the format linux-tool-*.mk.in. This causes the top-level Makefile to ignore the Linux tools sub-makefiles. Until now, the main Makefile included all linux-tool-*.mk files, as well as linux-tools.mk, and it relied on alphabetical sorting to include them in the proper order (linux-tool-*.mk before linux-tools.mk). Signed-off-by: Markus Mayer <mmayer@broadcom.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> [Thomas: improve comment in the code as suggested by Yann.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website/support: clarify the bugtracker is for bugs onlyGravatar Luca Ceresoli2017-07-151-1/+1
| | | | | | | | The bugtracker is intended to be used for bug reports only, so clarify it's not meant to be used for "any problem". Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: patches are not applied for SITE_METHOD = localGravatar Arnout Vandecappelle2017-07-092-1/+5
| | | | | | | | | | | | | | | | We had several remarks on the mailing list of users that were surprised that patches were not applied for packages whose SITE_METHOD is local. So document this. Note that for OVERRIDE_SRCDIR itself it is already documented: When Buildroot finds that for a given package, an <pkg>_OVERRIDE_SRCDIR has been defined, it will no longer attempt to download, extract and patch the package. Instead, it will directly use the source code available in in the specified directory. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: remove references to host/usr pathsGravatar Arnout Vandecappelle2017-07-053-3/+3
| | | | | Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update gettext detailsGravatar Thomas Petazzoni2017-07-051-41/+42
| | | | | | | | | | The way gettext is handled in Buildroot has significantly changed, with changes visible to packages. This commit updates the relevant section of the manual to document how packages should now interact with the gettext support. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
* docs/website: update for 2017.05.1Gravatar Peter Korsgaard2017-07-042-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.4Gravatar Peter Korsgaard2017-07-042-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: add documentation about DL_DIRGravatar Maxime Hadjinlian2017-07-041-1/+4
| | | | | | | | And at the same time don't encourage use of BR2_DL_DIR Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: Yann E. MORIN <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document hashes for license filesGravatar Yann E. MORIN2017-07-031-2/+13
| | | | | | | | | | [Peter: use sha256 in example] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Luca Ceresoli <luca@lucaceresoli.net> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Rahul Bedarkar <rahulbedarkar89@gmail.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update details about hashesGravatar Thomas Petazzoni2017-07-031-7/+16
| | | | | | | | | | | | | | | | | | | | | This commit updates the manual about hashes, fixing a number of issues: - Adding the .hash file should no longer be optional: it *must* be added. Therefore the wording "You can add ..." is changed to "When possible, you must add ...". - We are now checking hashes for Git downloaded packages, so fix this as well, and indicate more clearly which download methods have hash checking. - We no longer want to have auto-generated patches be downloaded through <pkg>_PATCH because such patches are not stable over time, and their hash can change. For example, downloading patches from github.com should no longer be done. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: fix test-pkg missing.config file nameGravatar Peter Seiderer2017-07-021-1/+1
| | | | | Signed-off-by: Peter Seiderer <ps.report@gmx.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: update old references to support/scriptsGravatar Arnout Vandecappelle2017-07-013-6/+6
| | | | | | | | | | | | | There were still some references to the old location of the scripts in the manual. Replace them by utils/. While we're at it, remove the redundant ./ at the beginning of some of the example commands. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Cc: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: rename to 'utils'Gravatar Thomas Petazzoni2017-07-013-6/+6
| | | | | | | | | | | After some discussion, we found out that "tools" has the four first letters identical to the "toolchain" subfolder, which makes it a bit unpractical with tab-completion. So, this commit renames "tools" to "utils", which is more tab-completion-friendly. This has been discussed with Arnout and Yann. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: new tool to filter the output of makeGravatar Yann E. MORIN2017-07-011-2/+3
| | | | | | | | | | | | | | | | | Add brmake, a small script that redirects the build output log to a file, keeping just Buildroot's own messages, with the date+time added at the start of the line. We need to unbuffer the output of make so that, when the script is interrupted (SIGINT, ^C), there is no lingering output not yet digested by the logger loop. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: move get-developers out of support/scripts/Gravatar Yann E. MORIN2017-07-011-1/+1
| | | | | | | | | | Move it to the top-level tools/ directory, so that it is easier to find for users. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* tools: move test-pkg out of support/scriptsGravatar Yann E. MORIN2017-07-011-6/+6
| | | | | | | | | | Move it to the top-level tools/ directory, so that it is easier to find for users. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: known issues no longer validGravatar Waldemar Brodkorb2017-07-011-20/+0
| | | | | Signed-off-by: Waldemar Brodkorb <wbx@openadk.org> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: drop mention of removed external toolchainsGravatar Baruch Siach2017-06-201-8/+6
| | | | | | | | | The CodeSourcery x86 and sh, the ADI Blackfin, and the Xilinx Mircoblaze external toolchain profiles have all been removed. Update the manual. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: update external toolchain advantages listGravatar Baruch Siach2017-06-201-2/+0
| | | | | | | | | Buildroot can build non-uClibc toolchains internally for quite some time now. Update the manual text. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: update for 2017.02.3Gravatar Peter Korsgaard2017-06-022-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2017.05 announcement linkGravatar Peter Korsgaard2017-06-011-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.052017.05Gravatar Peter Korsgaard2017-05-312-2/+55
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.05-rc32017.05-rc3Gravatar Peter Korsgaard2017-05-302-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.05-rc22017.05-rc2Gravatar Peter Korsgaard2017-05-172-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.05-rc12017.05-rc1Gravatar Peter Korsgaard2017-05-082-11/+35
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.2Gravatar Peter Korsgaard2017-05-022-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: PEP8 coding style for Python scriptsGravatar Ricardo Martincoski2017-04-271-0/+5
| | | | | | | | | | | | | | | | 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 <arnout@mind.be> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* support/test-pkg: run legal-infoGravatar Yann E. MORIN2017-04-171-2/+3
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: contribute: fix license string for Buildroot licenseGravatar Rahul Bedarkar2017-04-151-1/+1
| | | | | | | | | | | 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 <rahulbedarkar89@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: size of tab in package descriptionGravatar Ricardo Martincoski2017-04-082-5/+9
| | | | | | | | | | | | | | | | | | | | | | 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 <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Romain Naour <romain.naour@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/test-pkg: print number of toolchains and progressGravatar Yann E. MORIN2017-04-061-11/+11
| | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document the test-pkg scriptGravatar Yann E. MORIN2017-04-062-0/+96
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: update for 2017.02.1Gravatar Peter Korsgaard2017-04-052-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: refer to SPDX License ListGravatar Rahul Bedarkar2017-04-016-86/+11
| | | | | | | | | | | | | 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 <rahulbedarkar89@gmail.com> [Thomas: take into account suggestions from Arnout.] Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core: enhance printvarsGravatar Yann E. MORIN2017-03-291-0/+54
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document MPL licensesGravatar Rahul Bedarkar2017-03-161-0/+6
| | | | | | | | | Many packages are provided under MPL v1.1 and v2.0. Document it under License abbreviations section. Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Rahul Bedarkar <rahul.bedarkar@imgtec.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document ISC licenseGravatar Rahul Bedarkar2017-03-161-0/+3
| | | | | | | | | Many packages are provided under ISC license. Document it under License abbreviations section. Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Signed-off-by: Rahul Bedarkar <rahul.bedarkar@imgtec.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: mention that 2017.02 is a LTS releaseGravatar Peter Korsgaard2017-03-101-0/+3
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2017.02 announcement linkGravatar Peter Korsgaard2017-03-101-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2016.11.3 releaseGravatar Peter Korsgaard2017-03-101-0/+21
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* luarocks-package: lowercase the upstream name for LuaRocksGravatar Arnout Vandecappelle2017-03-051-2/+3
| | | | | | | | | | LuaRocks has a policy that the rockspec and rock filenames are lower case. However, the upstream name may contain uppercase characters. We have several packages like that in Buildroot. To simplify the package .mk files, apply the lowercase from within the infra. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* luarocks-package: introduce PKG_NAME_UPSTREAMGravatar Arnout Vandecappelle2017-03-021-22/+32
| | | | | | | | | | | | | | | | | Since we now require Lua package names to start with "lua", it is likely that the Buildroot name is different from the upstream LuaRocks name. Add a feature to the luarocks-package infra that makes it easier to handle this situation: the package can explicitly specify the upstream name in PKG_NAME_UPSTREAM, and that name will be used in PKG_ROCKSPEC, PKG_SOURCE and PKG_SUBDIR. Add an explanation of this feature to the manual. To make the example relevant, it is changed to lua-foo, where the upstream name is plain foo. To avoid confusion with the dependency on a native library, that dependency is renamed to bar. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: luarocks: improve tutorial exampleGravatar Arnout Vandecappelle2017-03-021-1/+1
| | | | | | | | The license file in a luarocks package is always inside the subdir, so the example should reflect this. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: improve website speedGravatar Angelo Compagnucci2017-03-011-0/+62
| | | | | | | | | | | | | Currently the buildroot website is not leveraging common techniques to have a better loading speed (browser caching, gzip compression, deflating). This commit provides an .htaccess files with all the needed to enable mentioned features. This .htaccess only works if the webserver has deflate, expires and headers modules enabled. Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Update for 2017.022017.02Gravatar Peter Korsgaard2017-02-282-11/+29
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.02-rc32017.02-rc3Gravatar Peter Korsgaard2017-02-262-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>