summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs/manual: using a branch name as FOO_VERSION does not workYann E. MORIN2018-05-111-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For various reasons, we've always suggested users to avoid using a branch as version string for their packages, because it does not work as a they would expect: - it is not reproducible, because the branch may change between two builds that are done at different times; - it does not even follow the branch, as Buildroot anyway generates a local tarball, which it will reuse on subsequent builds. Furthermore, since we fetch and not pull, any existing local branch is not updated. Yet, until recently, using a branch name would just work (with the above limitations): the git tree was cloned, the branch checked out, and the tarball created. But with the advent of the git caching, using a branch name does not work anymore. Indeed, we now do a git-fetch, and that does not create a local master branch. So we can't check out master, because it does not exist locally. And for other branches, as noticed above, the local branch does not get udpated to the remote one. Furthermore, the local branches are only created by chance, again as a side-effect of trying to fetch the "special refs". So, we can't say that we reliably support the use of a branch name. Update the manual to state that using a branch does not work. Remove the 'stable' example, as it looked like the name of a stable branch; instead, replace it with a version string that ressemble a tag. Fix the layout of the manual by making the version examples an actual bulleted list. Note: the above is only entirely true for git. For Mercurial, CVS and subversion, the status may be mixed, but nonetheless, using branches is still a bad idea, if at least because it is not reproducible, and because Buildroot does not even follow the branch. So, we do not differentiate between the various SCMs, and just flatly state that using a branch name is not supported. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Peter Korsgaard <peter@korsgaard.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* docs/website: update news.html for 2018.05-rc1Thomas Petazzoni2018-05-091-0/+24
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* Update for 2018.05-rc1Thomas Petazzoni2018-05-091-10/+11
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* docs/website: update for 2018.02.2Peter Korsgaard2018-05-042-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* package/pkg-generic: add check that target variant is defined before host ↵Thomas Petazzoni2018-04-301-2/+4
| | | | | | | | | | | variant Update the documentation accordingly. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> [yann.morin.1998@free.fr: slight rephrasing in error message, update manual] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* website: footer.html: really use version 1.7.1 of clipboard.jsPeter Korsgaard2018-04-281-1/+1
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: add favicon.pngPeter Korsgaard2018-04-281-0/+0
| | | | | | | | | | | | | | The website advertises a favicon in PNG format, but we don't actually provide one. From docs/website/header.html: <link rel="shortcut icon" href="images/favicon.png"> So add one. Generated by: convert -geometry 32x32! docs/website/images/logo_small.png \ docs/website/favicon.png Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* website: footer.html: use 1.7.1 release of clipboard.jsPeter Korsgaard2018-04-281-1/+1
| | | | | | | | | | | | | | | | | | | | The clipboard javascript code causes an error: Uncaught TypeError: Illegal constructor at buildroot.js:58 Which is caused by a recent change in upstream clipboard.js: https://github.com/zenorocha/clipboard.js/releases/tag/v2.0.0 Changes constructor from new Clipboard() to new ClipboardJS() The issue was that we were using the master version of clipboard.js instead of a specific release. Fix it by using the 1.7.1 version (latest release before the constructor change) instead. Signed-off-by: Peter Korsgaard <peter@korsgaard.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.11Peter Korsgaard2018-04-121-0/+21
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2018.02.1Peter Korsgaard2018-04-102-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: use SPDX short identifier for licenseRahul Bedarkar2018-04-052-2/+2
| | | | | Signed-off-by: Rahul Bedarkar <rahulbedarkar89@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* help/manual: update help about the new $(LIBFOO_DL_DIR)Maxime Hadjinlian2018-04-021-3/+3
| | | | | | Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add check-package to "Tips and tricks"Ricardo Martincoski2018-04-023-2/+39
| | | | | | | | | | And add two references to it: in "Submitting patches" and in "Adding new packages to Buildroot" sections. Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* support/scripts/graph-depends: use colors instead of coloursThomas Petazzoni2018-04-011-2/+2
| | | | | | | | | | | | | | | | The graph-depends was not very consistent in colors vs. colours: some parts were using colours, some parts were using colors. Let's settle on the US spelling, colors. This change the user-visble option --colours to --colors, but it is unlikely that a lot of users customize the colors through BR2_GRAPH_DEPS_OPTS, so this user interface change is considered reasonable. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Allow adding per-package override rsync exclusionsAdrian Perez de Castro2018-04-011-0/+16
| | | | | | | | | | | | | | | | | | | | | | This allows using <PKG>_SRCDIR_OVERRIDE_RSYNC_EXCLUSIONS in local.mk to skip copying parts of source trees unneeded for building. For example, when developing WebKitGTK+, it's handy to skip copying all the tests and other build directories, which are huge: WEBKITGTK_OVERRIDE_SRCDIR = /home/aperez/WebKit WEBKITGTK_OVERRIDE_SRCDIR_RSYNC_EXCLUSIONS = \ --exclude JSTests --exclude ManualTests \ --exclude PerformanceTests --exclude WebDriverTests \ --exclude WebKitBuild --exclude WebKitLibraries \ --exclude WebKit.xcworkspace --exclude Websites \ --exclude Examples This saves a good chunk of time when rsync is used for the first time to copy the source tree over before building. Signed-off-by: Adrian Perez de Castro <aperez@igalia.com> [Arnout: move documentation to the end of the section] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
* package/pkg-golang: use 'build' instead of 'install'Thomas Petazzoni2018-04-011-1/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | So far, we were using the 'go install' mechanism to build a package and have its binary installed in $$($(2)_WORKSPACE)/bin/linux_$$(GO_GOARCH). This worked fine when building on x86-64 for ARM, but failed when building on x86-64 for x86-64 because the binaries were installed in $$($(2)_WORKSPACE)/bin/. Instead of doing some complicated logic to guess whether Go is going to put our binaries in $$($(2)_WORKSPACE)/bin/ or in $$($(2)_WORKSPACE)/bin/linux_$$(GO_GOARCH), we revert back to using "go build", as it was done before the introduction of the golang package infrastructure. "go build" lets us pass explicitly the destination path of the binary to be generated. There's just one complexity with how to decide on the name of the binary that should be produced, and we have two cases: - <pkg>_BUILD_TARGETS is the default, i.e ".". In this case we assume a single binary is produced by "go build", and we name if after the lower case package name. We allow this to be overridden thanks to <pkg>_BIN_NAME. - <pkg>_BUILD_TARGETS is non-default, and typically contains something like "foo bar" or "cmd/foo cmd/bar". In this case, we assume the binaries to be produced are "foo" and "bar", i.e we take the non-directory part of the build target to name the binaries. Because we're using this -o option, we no longer need to explicitly create the binary directory, it is done by "go build". Fixes: http://autobuild.buildroot.net/results/1f9cd7c48e8c8f41326632a9c0de83915d72c45b/ [Peter: use $(or instead of $(if as suggested by Arnout] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update the documentation about test-pkgThomas Petazzoni2018-04-011-3/+8
| | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* toolchain: merge toolchain-common.in to Config.inRicardo Martincoski2018-04-011-2/+2
| | | | | | | | | | | | | | | | | | toolchain-common.in is a Config.in file with an uncommon name. It is just included by toolchain/Config.in, and toolchain/Config.in is not that long, so instead of renaming the file, merge it to toolchain/Config.in. Move the raw contents from the file to the exact location it is currently included in order to not change the order in the menu. Update the references in the manual as well. Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* docs/manual: add documentation for the golang infrastructureAngelo Compagnucci2018-03-312-0/+110
| | | | | | | | | | This patch adds the documentation for the golang infrastructure. Signed-off-by: Angelo Compagnucci <angelo@amarulasolutions.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
* package/pkg-generic: add the concept of extract dependencyThomas Petazzoni2018-03-251-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Extract dependencies are dependencies that must be ready before the extract step of a package, i.e for tools that are needed to extract packages themselves. Current examples of such tools are host-tar, host-lzip and host-xz. They are currently handled through DEPENDENCIES_HOST_PREREQ. However, this mechanism has a number of drawbacks: - First and foremost, because host-tar/host-lzip/host-xz are not listed in the dependencies of packages, the package infrastructure does not know it should rsync them in the context of per-package SDK. - Second, there is no dependency handling *between* them. I.e, we have no mechanism that says host-tar should be built before host-lzip, while it is in fact the case: if you need to build host-lzip, you need to extract a tarball, so you may need host-tar if your system tarball is not capable enough. For those reasons, it makes sense to add explicit support for "extract dependencies" in the package infrastructure, through the <pkg>_EXTRACT_DEPENDENCIES variable. It is unlikely this variable will ever be used by a package .mk file, but it will be used internally by the package infrastructure. [Peter: fix typo in manual] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: Matt Weber <matthew.weber@rockwellcollins.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: pass PARALLEL_JOBS to NINJA_OPTSJörg Krause2018-03-191-1/+1
| | | | | | | | | Ninja understands the `-j` option which defines how many jobs are run in parallel. Signed-off-by: Jörg Krause <joerg.krause@embedded.rocks> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* support/check-bin-arch: exclude kernel modules for merged /usrYann E. MORIN2018-03-071-2/+2
| | | | | | | | | | | When using a merged /usr, the kernel module path is really /usr/lib/modules, as /lib is a symlink to usr/lib . Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Cc: Peter Korsgaard <peter@korsgaard.com> Reviewed-by: Peter Korsgaard <peter@korsgaard.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* spport/check-bin-arch: accept arbitrary per-package ignore pathsYann E. MORIN2018-03-071-0/+7
| | | | | | | | | | | | | | | Some packages (mostly, out-of-tree) may want to install binary blobs for another architecture, outside the locations we currently exclude, like in /opt or whatever... Add support in check-bin-arch to accept any arbitrary location, that individual package can each request to excude from the check, when they are installed. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2018.02 announcement linkPeter Korsgaard2018-03-041-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2018.022018.02Peter Korsgaard2018-03-042-11/+32
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2018.02-rc3Peter Korsgaard2018-02-272-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add documentation for the "make sdk" targetDaniel Serpell2018-02-251-7/+11
| | | | | Signed-off-by: Daniel Serpell <daniel.serpell@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* website: update package number textPeter Korsgaard2018-02-251-1/+1
| | | | | | | | | | | | We have quite a bit more than "hundreds of packages" nowadays: find package -name \*.mk | wc -l 2285 So adjust the text to say 'several thousand' instead. Signed-off-by: Peter Korsgaard <peter@korsgaard.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* Update for 2018.02-rc2Peter Korsgaard2018-02-152-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: Free Electrons is now BootlinThomas Petazzoni2018-02-142-7/+7
| | | | | | | | Free Electrons has been renamed to Bootlin, so update the Documentation section of our website describing the Buildroot training course to use the new company name and domain name. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* rustc: use RUSTC_{HOST,TARGET}_NAMEEric Le Bihan2018-02-131-2/+2
| | | | | | | | | | | | | | | utils/check-package complains as follows: package/rustc/rustc.mk:10: possible typo: RUST_TARGET_NAME -> *RUSTC* package/rustc/rustc.mk:18: possible typo: RUST_HOST_NAME -> *RUSTC* As RUST_{HOST,TARGET}_NAME are related to the Rust compiler, it sounds sensible to rename them to RUSTC_{HOST,TARGET}_NAME. So update all rust related packages to use the new variables. Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
* docs/website/news.html: update for 2018.02-rc1Peter Korsgaard2018-02-051-0/+24
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2018.02-rc1Peter Korsgaard2018-02-051-11/+11
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document cargo-based packagesEric Le Bihan2018-02-052-0/+112
| | | | | | | | Add instructions for adding a package which uses Cargo as build system. [Peter: fix indentation] Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Makefile, manual, website: Bump copyright yearPeter Korsgaard2018-02-012-2/+2
| | | | | | Happy 2018! Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.10Peter Korsgaard2018-01-312-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update sponsors for FOSDEMArnout Vandecappelle (Essensium/Mind)2018-01-231-9/+9
| | | | | | | | | | Simply a matter of updating the year, since it's again Google and Mind for the FOSDEM2018 developer meeting. Also add the 2017 sponsorship to the "Past sponsors" section. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.11.2Peter Korsgaard2018-01-212-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.9Peter Korsgaard2018-01-012-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.11.1Peter Korsgaard2017-12-312-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document meson-based packagesEric Le Bihan2017-12-282-0/+103
| | | | | | | | | Add instructions for adding a package which uses the Meson build system. Signed-off-by: Jörg Krause <joerg.krause@embedded.rocks> Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Reviewed-by: Yegor Yefremov <yegorslists@googlemail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* website/news.html: add 2017.11 announcement linkPeter Korsgaard2017-12-011-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.112017.11Peter Korsgaard2017-11-302-11/+29
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.08.2Peter Korsgaard2017-11-292-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: update for 2017.02.8Peter Korsgaard2017-11-282-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Revert "pkg-download: remove explicit PKG_VERSION from github helper"Yann E. MORIN2017-11-141-4/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This reverts commit 1e5a8916b2ab4c9c99548fa6fbd4855eee323881. The idea was that the version string can be derived because we know the package name. However, this patch does not account for the fact that $(pkgname) always points to the latest pacakge scanned, which in all other situation we're using it, is the current package, because it is used inside one ot he xxx-inner macros that are $(eval)ualed. So $(pkgname) is evaluated "early" and gets the expected value. However, the github value is not in one of those macros, so it gets evaluated "late", when doing the actual download. So, by that time, $(pkgname) will expand to the last package scanned, which is actuall the manual (without a br2-external tree). That would require that the _SITE variable be assigned with the := assignment operator. This is weird, because that would make it the only variable to require that, but only when using the github helper, which is even less obvious and would cause a lot of trouble... The obvious fixup would seem to be to use $(PKG) instead, because that already contains the upper-case package name that vcan be used as a prefix to variables. However, that does not work either, because we have a check that forbids a trsailing slash in _SITE, check that is done in pacakge/pkg-generic, inside the xxx-inner macro, during the $(eval) call. And at that time, PKG is not yet defined, because it is only defined for an actual recipe. So we can't seem to have a workable solution. So, just revert the patch. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Marcin Nowakowski <marcin.nowakowski@imgtec.com> Cc: Peter Korsgaard <peter@korsgaard.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.11-rc2Peter Korsgaard2017-11-132-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Manual: DEVELOPERS file integrity checkMatt Weber2017-11-081-0/+2
| | | | | Signed-off-by: Matthew Weber <matthew.weber@rockwellcollins.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2017.11-rc1Peter Korsgaard2017-11-062-11/+34
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: update DEVELOPERS modification processJoseph Kogut2017-11-051-3/+3
| | | | | Signed-off-by: Joseph Kogut <joseph.kogut@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
OpenPOWER on IntegriCloud