aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Update for 2016.02-rc32016.02-rc3Gravatar Peter Korsgaard2016-02-272-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: slightly clarify patch licensingGravatar Luca Ceresoli2016-02-251-2/+2
| | | | | | | | | | | | | | | 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 <luca@lucaceresoli.net> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual/contribute.txt: add formatting patches sectionGravatar Arnout Vandecappelle2016-02-241-0/+74
| | | | | | | | | | | | | | | | | Thomas P. has sent a few big feedback mails recently that explain how a patch should be formatted. Indeed, this was not explained much in the manual, so add a section that explains how patches should be formatted. This is based heavily on the feedback that Thomas P. gave. Also, specific examples for new packages and version bumps are added. This will allow us to refer to https://buildroot.org/manual.html#submitting-patches in the future instead of composing long mails. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Yegor Yefremov <yegorslists@googlemail.com> [Thomas: rewrap to our normal formatting practice.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual/contribute.txt: add section for preparing patch seriesGravatar Arnout Vandecappelle2016-02-241-4/+7
| | | | | | | | | | | In subsequent patches, we will add more explanation about how to prepare patches, so it will be worthwhile to have a separate section for the series preparation. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Reviewed-by: Yegor Yefremov <yegorslists@googlemail.com> [Thomas: rewrap to our normal formatting practice.] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add info about AGPLv3 licenseGravatar Yegor Yefremov2016-02-211-0/+3
| | | | | | Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2016.02-rc22016.02-rc2Gravatar Peter Korsgaard2016-02-182-9/+31
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* website/news.html: add 2016.02-rc1 announcement linkGravatar Peter Korsgaard2016-02-171-1/+3
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2016.02-rc12016.02-rc1Gravatar Peter Korsgaard2016-02-102-11/+34
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: update graph-depends documentation about --stop-onGravatar Thomas Petazzoni2016-02-081-3/+4
| | | | | | | | | | This commit updates the graph-depends documentation to take into account the new 'host' keyword that can be passed to the --stop-on and --exclude options. 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@free-electrons.com>
* docs/website: update sponsors page with recent meetingsGravatar Thomas Petazzoni2016-02-081-10/+10
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: misc improvements to Vagrant usage documentationGravatar Angelo Compagnucci2016-02-081-2/+4
| | | | | | | | | * Changing back wget to curl cause wget it's not available on mac os x. * Braking up too long windows one liner. Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/scripts: add size-stats-compare scriptGravatar Thomas De Schampheleire2016-02-071-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Leverage the CSV files produces by size-stats (make graph-size) to allow for a comparison of rootfs size between two different buildroot compilations. The script takes the file-size CSV files of two compilations as input, and produces a textual report of the differences per package. Using the -d/--detail flag, the report will show the file size changes instead of package size changes. The -t/--threshold option allows to ignore file size differences smaller or equal than the given threshold (in bytes). Example output is: Size difference per package (bytes), threshold = 0 -------------------------------------------------------------------------------- -8192 busybox 228572 added dmalloc 301584 added jq -------------------------------------------------------------------------------- 521964 TOTAL or with detailed view: Size difference per file (bytes), threshold = 0 -------------------------------------------------------------------------------- -8192 bin/busybox 18152 added usr/bin/jq 39252 added usr/bin/dmalloc 46968 added usr/lib/libdmalloc.so 47288 added usr/lib/libdmallocxx.so 47316 added usr/lib/libdmallocth.so 47748 added usr/lib/libdmallocthcxx.so 283432 added usr/lib/libjq.so.1.0.4 -------------------------------------------------------------------------------- 521964 TOTAL Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* arch: remove BR2_ARCH_HAS_ATOMICS optionGravatar Thomas Petazzoni2016-02-061-5/+0
| | | | | | | | Now that BR2_ARCH_HAS_ATOMICS is no longer used anywhere, we can remove it from arch/Config.in*, as well as from the documentation. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
* docs/manual: document usage of BR2_TOOLCHAIN_HAS_SYNC_xGravatar Thomas Petazzoni2016-02-061-0/+14
| | | | | | | | | | This commit updates the documentation to detail when and how to use the BR2_TOOLCHAIN_HAS_SYNC_x dependency. Note that we chose to not add a comment about this dependency, because it is mainly tied to architecture capabilities (except in very specific cases, which would be way too complicated to explain in a Config.in comment). Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* support/misc: Adding Vagrant file for provisioningGravatar Angelo Compagnucci2016-02-041-0/+18
| | | | | | | | | | | This patch adds a Vagrant file to buildroot. With this file you can provision a complete buildroot developing environment in minutes on all major platforms (Linux/Mac/Windows). [Peter: bump to 2GB RAM, hardcode Buildroot release, add unzip, drop website update and tweak manual text as suggested by Yann] Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* website: add reference to submitting-patches to Contribute tabGravatar Arnout Vandecappelle2016-02-011-1/+2
| | | | | | | | | In the hope of improving the quality of patches send by newcomers, add a reference to the submitting-patches section of the manual to the Contribute tab of the website. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: minor fixes in the graph-size documentationGravatar Thomas De Schampheleire2016-02-011-4/+4
| | | | | | | | | Fix some typos and references to a size-stats 'target' (the script is called 'size-stats' but the make target is 'graph-size'). Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: makedev syntax accepts usernames and group namesGravatar Yann E. MORIN2016-02-012-19/+23
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* support/download: alternative access methods to CVSGravatar Joao Mano2016-01-201-1/+6
| | | | | | | | | | | | | Allows user to specify other access methods than :pserver:anonymous@ on CVS repositories. This shall be defined in the <pkg>_SITE variable. [Thomas: - as suggested by Yann, quote the variable expansion - as suggested by Yann, use a regexp match - tweak commit log] Signed-off-by: Joao Mano <joao@datacom.ind.br> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add ordering of kconfig options' attributesGravatar Yann E. MORIN2016-01-191-0/+9
| | | | | | | | | | | | | | | We want to ensure all packages follow the same coding style, so we add a blurb about the order of kconfig options' attributes: - first, the type and the prompt - the default value if needed - then dependencies of the 'depends on' category - followed by dependencies of the 'select' form - with eventually the help text Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: slightly compactify a paragraphGravatar Yann E. MORIN2016-01-191-6/+5
| | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: fixing mixing content errorGravatar Angelo Compagnucci2016-01-131-1/+1
| | | | | | | | | Firefox recently activated mixing content mode protection (http elements in an https page). This patch changes the external slides service to https. Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Config.in: add symbols for BR2_HOST_GCC_AT_LEAST_X_YGravatar Arnout Vandecappelle2015-12-311-0/+7
| | | | | | | | | | | | | | Some host packages need a recent gcc version. Add symbols to Config.in to specify the HOSTCC version. The values are passed through the environment, and this environment is generated in a new support script. Also update the documentation to mention the new symbols. [Thomas: simplify by using only make logic instead of an external shell script.] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: fixing pre block indentationGravatar Angelo Compagnucci2015-12-291-3/+3
| | | | | | | | Pre block should not be indented, this patch fixes wrong indentation. Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document the new kconfig-package variableGravatar Yann E. MORIN2015-12-221-0/+10
| | | | | | | | | | | | | | The previous patch introduced the new FOO_KCONFIG_DEFCONFIG variable to specify a defconfig rule rather than a (def)config file. Add this to the manual. Also document the pre-existing FOO_KCONFIG_FILE for which the explanations were missing altogether. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Sam Bobroff <sam.bobroff@au1.ibm.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: clarify policy when updating a package patchGravatar Arnout Vandecappelle2015-12-161-0/+4
| | | | | | Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Cc: Renaud AUBIN <root@renaud.io> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: website: update for 2015.11.1Gravatar Peter Korsgaard2015-12-052-9/+28
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website/news.html: add 2015.11 announcement linkGravatar Peter Korsgaard2015-12-011-1/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.112015.11Gravatar Peter Korsgaard2015-11-302-10/+29
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: fix invalid links to the mailing list pageGravatar Thomas Petazzoni2015-11-281-7/+7
| | | | | | | As noticed by Peter Korsgaard, all the links to links.html are broken, they should point to support.html instead. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/website: fix invalid linkGravatar Thomas Petazzoni2015-11-281-1/+1
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: images: re-add github imageGravatar Peter Korsgaard2015-11-261-0/+0
| | | | | | | This got removed with the addition of the new website, but it is used by the manual so it no longer builds. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.11-rc32015.11-rc3Gravatar Peter Korsgaard2015-11-262-9/+32
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* news.html: fix typo in 2015.05-rc3 linkGravatar Peter Korsgaard2015-11-261-1/+1
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/website: New websiteGravatar Angelo Compagnucci2015-11-2343-3164/+4012
| | | | | | | | | | | | | | This patch introduces a new buildroot website based on a modern flat layout inspired by material design. Each page of the old website is converted to the new css/layout, the big bump is in main page which is completely rewritten. Content of the old website is copied more or less verbatim, planning to add more content in the future. Signed-off-by: Angelo Compagnucci <angelo.compagnucci@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2015.11-rc22015.11-rc2Gravatar Peter Korsgaard2015-11-192-5/+18
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: fix bash export syntax in example codeGravatar Luca Ceresoli2015-11-111-1/+1
| | | | | | | | To export a variable in .bashrc we shouldn't put a '$' at the beginning of the line, and there must be a '=' between key and value. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* website/news: update with release date and announcement e-mail linkGravatar Thomas Petazzoni2015-11-081-2/+4
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Update for 2015.11-rc12015.11-rc1Gravatar Thomas Petazzoni2015-11-072-7/+20
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: fix typo in $(FOO_PKGDIR) documentationGravatar Arnout Vandecappelle2015-11-051-1/+1
| | | | | Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: document $(FOO_PKGDIR)Gravatar Yann E. MORIN2015-11-051-0/+5
| | | | | | | | | | | | In the manual, add a note that packages can use $(FOO_PKGDIR) to get the path to the directory containg the .mk and Config.in files, if they need it to e.g. copy files from there, like startup scripts, systemd units or any other resource. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: do not override BR2_EXTERNALGravatar Yann E. MORIN2015-11-031-3/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, we forcibly override BR2_EXTERNAL when building the manual, so as to avoid referring to packages therein from the manual. However, when generating the lists of packages, we limit ourselves to scanning for packages in (Buildroot's) TOPDIR and never search in BR2_EXTERNAL. So, we do not really need to override BR2_EXTERNAL when generating the manual to achieve the same result. Furthermore, we're only looking for packages that are defined in the sub-menu "Target packages", and never anywhere else, and especially not in the sub-menu "User-provided options". Finally, we're soon to completely eliminate use of BR2_EXTERNAL in Kconfig altogether, so that would no longer have any impact anyway. So, just leave BR2_EXTERNAL alone when generating the manual. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Peter Korsgaard <jacmet@uclibc.org> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* core/pkg-generic: allow packages to exclude files when extractingGravatar Yann E. MORIN2015-11-031-0/+4
| | | | | | | | | | | | | | | | | Currently, packages that need to exclude parts of the archives when extracting (e.g. to gain space), like gcc or toolchain-external, have to provide custom extract commands, just for the sake of adding a bunch of --exclude directives when calling tar. Add a new variable that packages may set, to provide a space-separated list of patterns to exclude. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Vicente Olivert Riera <Vincent.Riera@imgtec.com> Reviewed-by: Romain Naour <romain.naour@openwide.fr> Reviewed-by: Vicente Olivert Riera <Vincent.Riera@imgtec.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Revert "manual: Add notes about GitHub and hashes"Gravatar Samuel Martin2015-10-181-10/+2
| | | | | | | | | | | | | | | | This note is no longer needed, so remove it. Tarballs generated by GitHub are always the same, so hashes can be checked. This reverts commit 9474cc2594c8643301164500ce6eb62546da2b8f. [Thomas: fix other remaining references to not using hashes for github, as noticed by Maxime Hadjinlian.] Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* ccache: allow for BR2_CCACHE_DIR environment overrideGravatar Gustavo Zacarias2015-10-171-0/+3
| | | | | | | | | | | | | Allow the BR2_CCACHE_DIR .config option to be overriden by the BR2_CCACHE_DIR env variable. This is useful for big projects where in some cases the developers home directory might be a NFS mount (slow) and real production builds aren't. Update documentation accordingly as well. Signed-off-by: Gustavo Zacarias <gustavo.zacarias@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: add section about size graphingGravatar Thomas Petazzoni2015-10-171-0/+41
| | | | | | | | Document the new graph-size target and its possibilities. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* ccache: support changing the output directoryGravatar Arnout Vandecappelle2015-10-041-0/+20
| | | | | | | | | | | | | | | | | | | | When building in a different output directory than the original build, there will currently be a lot of ccache misses because in many cases there is some -I/... absolute path in the compilation. Ccache has an option CCACHE_BASEDIR to substitute absolute paths with relative paths, so they wil be the same in the hash (and in the output). Since there are some disadvantages to this path rewriting, it is made optional as BR2_CCACHE_USE_BASEDIR. It defaults to y because the usefulness of ccache is severely reduced without this option. In addition to CCACHE_BASEDIR, we also substitute away the occurences of $(HOST_DIR) in the calculation of the compiler hash. This is done regardless of the setting of BR2_CCACHE_USE_BASEDIR because it's quite harmless. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: document new actual source package variablesGravatar Luca Ceresoli2015-10-041-0/+19
| | | | | | | Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* system: clarify /dev management using devtmpfs + {mdev, eudev}Gravatar Luca Ceresoli2015-10-041-27/+30
| | | | | | | | | | | | | | | | | The "Dynamic using mdev" and "Dynamic using eudev" /dev management methods are using devtmpfs, just like "Dynamic using devtmpfs only", on top of which they add either mdev or eudev. But their names might suggest they use mdev only or eudev only. Clarify their descriptions by adding "devtmpfs +" to make it unambiguous. [Thomas: rewrap the paragraphs in the manual. It makes the diff a lot less readable, but we actually want the result to be wrapped.] Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs/manual: FOO_SITE must not have a trailing slashGravatar Luca Ceresoli2015-10-021-2/+4
| | | | | | | | | This has been the best practice since a long time, but it was not clearly stated in the manual. Now it is mandatory, so mention it explicitly. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>