aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* manual: Clarify wrapper and debugGravatar Maxime Hadjinlian2014-02-031-3/+4
| | | | | | | | | Try to clarify how the wrapper passes arguments and why. This is mainly because the output you can see when you build, does not reflect what is invoked by the wrapper. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* web: announce meeting, and add Mind as sponsorGravatar Thomas Petazzoni2014-01-302-0/+24
| | | | | | | [Peter: s/Hangout/Hangouts/, line wrap] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: remove suggestion of aligning = signs in .mk filesGravatar Thomas De Schampheleire2014-01-221-7/+1
| | | | | | | | It is not buildroot convention to align the = signs in .mk files, so this shouldn't be suggested in the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: clarify handling of deprecated featuresGravatar Thomas De Schampheleire2014-01-211-1/+7
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* website: add pointers to the PGP signatures for releasesGravatar Yann E. MORIN2014-01-131-3/+7
| | | | | | | | | | | | | | Peter has just pointed me to the PGP signatures of the release tarballs, which exist since he's been doing releases. This was not obvious to me that the releases were signed, as there was no info about it on the website. So, add such links on the downloads page. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Peter Korsgaard <jacmet@uclibc.org> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: adding packages luarocksGravatar Francois Perrad2014-01-132-0/+95
| | | | | | | | Signed-off-by: Francois Perrad <francois.perrad@gadz.org> [yann.morin.1998@free.fr: some cleanups and rephrasing] 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>
* manual: add section about dealing efficiently with big image filesGravatar Yann E. MORIN2014-01-091-0/+39
| | | | | | | | | | | | | | | As reported by Ryan, it is not well-known that most tools can deal efficiently with big sparse files. Add a section in the manual about this, with tar and cp used as examples, and a hinting to the man pages for the others. Reported-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Ryan Barnett <rjbarnet@rockwellcollins.com> Cc: Peter Korsgaard <jacmet@uclibc.org> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs.html: add links to nightly build of manual as wellGravatar Peter Korsgaard2014-01-081-0/+8
| | | | | | | The html/pdf/text version of the manual is regenerated from current git head every 6 hours. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update copyright yearGravatar Peter Korsgaard2014-01-082-2/+2
| | | | | | Happy new year! Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: use current date/time for 'generated on'Gravatar Yann E. MORIN2014-01-041-2/+2
| | | | | | | | | | | | | | | | Currently, the manual uses the last modification date and time of manual.txt in the generated manual. This is confusing, especially for long-checked-out repositories where the top-level manual.txt has not changed since the check out. Moreover, the manual explicitly states 'generated on', which is confusing at best. Use the current date and time instead. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: fix uboot subdirectory in example layoutGravatar Simon Dawson2014-01-031-2/+2
| | | | | | | | | If U-Boot patches are nested under BR2_GLOBAL_PATCH_DIR, then the subdirectory should be called "uboot", and not "u-boot". Signed-off-by: Simon Dawson <spdawson@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* package: standardise Apache licensesGravatar Simon Dawson2014-01-021-0/+3
| | | | | | | | Apache licenses are referred to in a variety of ways; standardise these, choosing a form which does not contain whitespace. Signed-off-by: Simon Dawson <spdawson@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* graphs: support generating png graphsGravatar Yann E. MORIN2013-12-291-0/+2
| | | | | | | | | | | | | | PDF files can not be easily embedded in other documents (eg. ODT, or HTML). Add support for generating PNG graphs, by setting the GRAPH_OUT=pdf|png on the command line: make GRAPH_OUT=png graph-build graph-depends The default is still to generate PDF graphs. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Makefile: expose target 'graph-build' to generate the build-time graphsGravatar Yann E. MORIN2013-12-291-0/+2
| | | | | | | | | | | | | | | Generate the build-time graphs by calling: make graph-build This generates the graphs in $(O)/graphs/ It is possible to use the alternate color-scheme by setting the variable GRAPH_ALT=1 on the command line: make GRAPH_ALT=1 graph-build Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: update for multiple global patch dirsGravatar Ryan Barnett2013-12-252-16/+96
| | | | | | | | | | | | | | Updating the documentation to reflect that multiple directories can now be specified for BR2_GLOBAL_PATCH_DIR. Along with giving an example use case of how to use multiple global patch directories. [Thomas: fix minor typo mentionned by Thomas De Schampheleire.] Signed-off-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Cc: Arnout Vandecappelle <arnout@mind.be> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: explain format of comment about udev /dev management dependencyGravatar Thomas De Schampheleire2013-12-191-0/+17
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: clarify format of comments about dependency on Linux kernelGravatar Thomas De Schampheleire2013-12-151-0/+16
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* package: introduce Python package infrastructureGravatar Thomas Petazzoni2013-12-152-0/+161
| | | | | | [Peter: fix s/BUILD_TYPE/SETUP_TYPE/ typo in manual as noted by Samuel] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: systemd does not require glibGravatar Shawn Landden2013-12-091-1/+1
| | | | | | Signed-off-by: Shawn Landden <shawn@churchofgit.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* mention nconfigGravatar Shawn Landden2013-12-092-3/+9
| | | | | Signed-off-by: Shawn Landden <shawn@churchofgit.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Config.in: Add a menu around BR2_EXTERNAL configuration optionsGravatar Peter Korsgaard2013-12-081-4/+0
| | | | | | | | | | | | | | | To make it clear to the user that these options are external to Buildroot and no support is provided by the Buildroot community. With this, there's no need to recommend people to their options inside a menu, so remove that from the documentation. Kconfig nicely allows us to hide the menu completely if BR2_EXTERNAL isn't used, so make use of that to not confuse people. It would be nice if we could add some help text to explain the BR2_EXTERNAL stuff as well, but that isn't supported on menus :/ Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add explanations about BR2_EXTERNALGravatar Thomas Petazzoni2013-12-082-0/+140
| | | | | | | | | | | | This commit updates the manual to add details on how to use the BR2_EXTERNAL feature. [Peter: minor tweaks, fix asciidoc tag as pointed out by Samuel] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Acked-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* core: introduce the BR2_EXTERNAL variableGravatar Thomas Petazzoni2013-12-081-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit introduces the BR2_EXTERNAL environment variable, which will allow to keep Buildroot customization (board-specific configuration files or root filesystem overlays, package Config.in and makefiles, as well as defconfigs) outside of the Buildroot tree. This commit only introduces the variable itself, and ensures that it is available within Config.in options. This allows us to use $BR2_EXTERNAL in a 'source' statement in Config.in. Following patches extend the usage of BR2_EXTERNAL to other areas (packages and defconfigs). In details, this commit: * Introduces the BR2_EXTERNAL Kconfig option. This option has no prompt, and is therefore not visible to the user and also not stored in the .config file. It is automatically set to the value of the BR2_EXTERNAL environment variable. The only purpose of this BR2_EXTERNAL Kconfig option is to allow $BR2_EXTERNAL to be properly expanded when used inside Kconfig source statements. * Calculates the BR2_EXTERNAL value to use. If passed on the command line, then this value is taken in priority, and saved to a .br-external hidden file in the output directory. If not passed on the command line, then we read the .br-external file from the output directory. This allows the user to not pass the BR2_EXTERNAL value at each make invocation. If no BR2_EXTERNAL value is passed, we define it to support/dummy-external, so that the kconfig code finds an existing $(BR2_EXTERNAL)/package/Config.in file to include. * Passes the BR2_EXTERNAL into the *config environment, so that its value is found when parsing/evaluating Config.in files and .config values. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Tested-by: "Samuel Martin" <s.martin49@gmail.com> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: remove package clean commandsGravatar Thomas De Schampheleire2013-12-085-13/+1
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs: document the new github helper functionGravatar Mischa Jonker2013-12-062-4/+6
| | | | | | | | | [Thomas: splitted from Mischa original commit] Signed-off-by: Mischa Jonker <mjonker@synopsys.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: do not generate .pyc filesGravatar Yann E. MORIN2013-12-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Python saves a pre-compiled support/scripts/kconfiglib.pyc file side-to-side with the corresponding .py file. This does not work if the Buildroot source tree is read-only (but this is not an error for Python, which keep going OK). But this may cause issues for out-of-tree builds in case the same Buildroot source tree is shared by many builds. Also, 'make clean' currently does not clean this file, and out-of-tree builds can remove it either, at the risk of causing issues for other out-of-tree builds running at the same time. Just tell Python not to generate .pyc files: - call the script via python, don't use the sha-bang - thus, make the script non-executable, and remove the sha-bang Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: remove references to uninstall commandsGravatar Thomas De Schampheleire2013-12-063-17/+2
| | | | | | [Peter: keep clean comment as pointed out by Arnout] Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: limit the depth of the TOC in the HTML outputGravatar Yann E. MORIN2013-12-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | The current TOC level is set to 4, which does not mean 'a 4-level deep TOC', but really means 'a TOC deep to the 4th level', with the first level being level 0, which means we have: 12. Appendix 12.1. Makedev syntax documentation 12.2. Makeuser syntax documentation 12.3. Partition table layout description syntax 12.3.1. The global section Properties for the global section Which a bit too much. And yet, the fifth level is not shown, since we don't have any! :-/ Limit the depth of the TOC to three levels, which is just enough to be usefull, yet not cluttered by low-level titles. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/news.html: add 2013.11 announcement linkGravatar Peter Korsgaard2013-12-011-1/+1
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Merge branch 'next'Gravatar Peter Korsgaard2013-12-014-11/+50
|\ | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * legal info: update documentation with split target/host outputGravatar Thomas De Schampheleire2013-11-171-9/+12
| | | | | | | | | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * pkg-infra: add user-supplied step-hooksGravatar Yann E. MORIN2013-11-132-0/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allow user to supply their own step-hooks by passing a variable on the make command-line: make BR2_INSTRUMENTATION_SCRIPTS=/path/to/my/script This can be useful to run site-specific actions at each step of the build process, such as logging installed, removed or modified files, do sanity checks on installed files... It is possible to call more than one script, by passing a space-separated lists of scripts to call. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * post-{build, images} hooks: export BUILD_DIR tooGravatar Yann E. MORIN2013-11-131-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Also export BUILD_DIR for post-{build,images} hooks, so they do have a place to store generated files. Note: this will be more einteresting for the instrumentation of steps, to come in a later patch. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | Update for 2013.112013.11Gravatar Peter Korsgaard2013-11-302-5/+14
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/news.html: announce slides from 'Buildroot: What is new' presentation ↵Gravatar Peter Korsgaard2013-11-301-0/+7
| | | | | | | | | | | | at ELCE Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | Update for 2013.11-rc32013.11-rc3Gravatar Peter Korsgaard2013-11-262-3/+15
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | Update for 2013.11-rc22013.11-rc2Gravatar Peter Korsgaard2013-11-182-3/+16
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/download.html: Fix tarball typosGravatar Peter Korsgaard2013-11-131-2/+2
| | | | | | | | | | Reported-by: Arnout Vandecappelle <arnout@mind.be> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs: add a page to thank our sponsorsGravatar Thomas Petazzoni2013-11-132-0/+42
| | | | | | | | | | | | | | | | | | | | Offer a little bit more visibility to the companies who sponsored us, either by sponsoring the developer days, or development boards. Hopefully this will encourage other companies to do the same :) Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs: announce the upcoming Buildroot Developer DayGravatar Thomas Petazzoni2013-11-131-0/+25
| | | | | | | | | | | | | | [Peter: drop 'the' before FOSDEM] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | news.html: add 2013.11-rc1 annoucement linkGravatar Peter Korsgaard2013-11-131-1/+2
|/ | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Update for 2013.11-rc12013.11_rc1Gravatar Peter Korsgaard2013-11-122-5/+18
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/news.html: announce dev meeting reportGravatar Peter Korsgaard2013-11-111-0/+11
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/about.html: we support internal (e)glibc toolchains as well nowGravatar Peter Korsgaard2013-11-111-2/+2
| | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: Add version number to perl in prerequisitesGravatar Mischa Jonker2013-11-111-1/+1
| | | | | | | | Building host-bison needs perl 5.8.7+, as it uses the "-f" option for site customization scripts. This feature was added in 5.8.7. Signed-off-by: Mischa Jonker <mjonker@synopsys.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: add some info on the POST_RSYNC hookGravatar Thomas De Schampheleire2013-11-111-0/+20
| | | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: split info on hooks to a separate section/fileGravatar Thomas De Schampheleire2013-11-115-43/+46
| | | | | | | | | | | Split out the information on hooks to a separate section (and source file). Not only because the hooks are useful for all infrastructures (and thus don't really fit specifically in the generic infrastructure section), but also for clarity when the info on hooks will be expanded in later patches. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* infra: Add POST_RSYNC_HOOKS supportGravatar Thomas De Schampheleire2013-11-111-0/+1
| | | | | | | | | | | | | | One of the use cases is for the 'local packages' to restore the SCM info. Some packages use this information to generate version info during build time. In this case, the local package can have this hook to restore it by symbolic link for example. [Thomas: update commit title] Signed-off-by: Tzu-Jung Lee <tjlee@ambarella.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: clarify that Config.in comments should have correct dependenciesGravatar Thomas De Schampheleire2013-11-101-2/+15
| | | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: github commits should be specified in fullGravatar Thomas De Schampheleire2013-11-021-4/+3
| | | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>