summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
* manual: document BR2_GRAPH_DEPTHYann E. MORIN2014-04-141-0/+2
| | | | | | 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: add notes about depending on a virtual packageYann E. MORIN2014-04-051-0/+49
| | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: update the virtual package section with the new infrastructureYann E. MORIN2014-04-051-16/+10
| | | | | | | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Eric Le Bihan <eric.le.bihan.dev@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Reviewed-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: add virtual package tutorialeric.le.bihan.dev@free.fr2014-04-052-0/+101
| | | | | | | | | | | | The manual now features a new section with instructions about how to add a virtual package. Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> [yann.morin.1998@free.fr: move down statement about provider's .mk] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Reviewed-by: 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>
* pkg-python: support host-python dependency different from the python in the ↵Samuel Martin2014-04-051-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | target Some packages need a host-python interpreter with a version different from the one installed in the target to run some build scripts (eg. scons requires python2 to run, to build any kind of packages even if the python interpreter selected for the target is python3). In such cases, we need to add the right host-python dependency to the package using the host-python-package infrastructure, and we also want to invoke the right host python interpreter during the build steps. This patch adds a *_NEEDS_HOST_PYTHON variable that can be set either to 'python2' or 'python3'. This variable can be set by any package using the host-python-package infrastructure to force the python interpreter for the build. This variable also takes care of setting the right host-python dependency. This *_NEEDS_HOST_PYTHON variable only affects packages using the host-python-package infrastructure. If some configure/build/install commands are overloaded in the *.mk file, the right python interpreter should be explicitly called. If the package defines some tool variable (eg.: SCONS), the variable should explicitly call the right python interpreter. [Thomas: - fixes to the commit log and documentation suggested by Yann - rename the variable from <pkg>_FORCE_HOST_PYTHON to <pkg>_NEEDS_HOST_PYTHON, as suggested by Yann - do not allow any other value than python2 and python3 in <pkg>_NEEDS_HOST_PYTHON, as suggested by Yann.] Signed-off-by: Samuel Martin <s.martin49@gmail.com> Cc: Gustavo Zacarias <gustavo@zacarias.com.ar> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: fix typo in abbreviation 'i.e.'Jerzy Grzegorek2014-03-294-9/+9
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: fix typo in abbreviation 'e.g.'Jerzy Grzegorek2014-03-292-6/+6
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/legal-notice.txt: fix typoJerzy Grzegorek2014-03-291-1/+1
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/contribute.txt: reword part about reporting issuesJerzy Grzegorek2014-03-291-1/+1
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/contribute.txt: fix typoJerzy Grzegorek2014-03-291-1/+1
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/make-tips.txt: fix typoJerzy Grzegorek2014-03-291-1/+1
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/configure.txt: fix typoJerzy Grzegorek2014-03-291-2/+2
| | | | | | | [Thomas: fix to actually use the correct syntax.] Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/configure.txt: reword part about internal toolchain backendJerzy Grzegorek2014-03-291-1/+1
| | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: Add singular example for dependency commentMaxime Hadjinlian2014-03-291-0/+4
| | | | | | | | | | The manual always uses the format with multiple dependencies. This only add an example where is a single dependency to show that this format is applicable regardless of the number of dependencies. Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual/using: output/toolchain is goneFrancois Perrad2014-03-261-5/+2
| | | | | Signed-off-by: Francois Perrad <francois.perrad@gadz.org> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/adding-packages-tips.txt: reword part about package nameJerzy Grzegorek2014-03-231-1/+1
| | | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/adding-packages-generic.txt: change the default value of <PKG>_SOURCE ↵Jerzy Grzegorek2014-03-231-1/+1
| | | | | | | | variable Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/adding-packages-generic.txt: fix capitalization in titles of chaptersJerzy Grzegorek2014-03-231-2/+2
| | | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/faq-troubleshooting.txt: remove the extra 'the'Jerzy Grzegorek2014-03-231-1/+1
| | | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/customize-packages.txt: reword part about applying patchesJerzy Grzegorek2014-03-231-3/+3
| | | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/common-usage.txt: fix typoJerzy Grzegorek2014-03-231-1/+1
| | | | | | Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Remove STAMP_DIRArnout Vandecappelle2014-03-171-1/+1
| | | | | | | | | Since the migration of the toolchains to the generic package infrastructure, it is no longer used. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Makefile: remove BASE_TARGETS variableFabio Porcedda2014-03-061-5/+4
| | | | | | | | | | Because now the toolchain dependency is automatically added by the package infrastructure the BASE_TARGETS variable is useless so just remove it. Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contributing: modify commit message templateThomas De Schampheleire2014-03-061-4/+11
| | | | | | | | | | | This patch updates the commit message template provided in the manual. The new template emphasizes the importance of providing a description of the problem, the root cause, and the solution, and the fact that all this should be wrapped at 72 characters. Suggested-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contributing: minor rewording of 'reporting bugs' sectionThomas De Schampheleire2014-03-061-8/+13
| | | | | | | | This patch makes some minor fixes in the section about reporting bugs. 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>
* manual: contributing: don't recommend leaving out changelog from patchesThomas De Schampheleire2014-03-061-2/+2
| | | | | | | | | | | | | | Currently, the manual states that if you send a series and include a changelog in the introduction mail (0 of x), it is not necessary to include a changelog on the individual patches. This is not always convenient: for large patch series it requires going back to the introduction mail when opening each patch, to understand what changed. This patch rewords the paragraph accordingly. 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>
* manual: contributing: minor rewording of 'submitting patches' sectionThomas De Schampheleire2014-03-061-9/+11
| | | | | | | | | | This patch makes some minor changes to the section about submitting patches. Content-wise there are little changes. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contributing: add section on TODO listThomas De Schampheleire2014-03-061-0/+9
| | | | | | | | This patch adds a small section about working on items from the TODO list. 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>
* manual: contributing: move section on patch reviews up and change introThomas De Schampheleire2014-03-061-62/+68
| | | | | | | | | | | | This patch moves the section about patch reviews and the Tested-by/Reviewed-by/Acked-by tags upwards. Additionally, the first paragraph is removed and replaced by another one. There are no other changes in the text. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contributing: move and expand autobuild sectionThomas De Schampheleire2014-03-061-17/+46
| | | | | | | | | This patch moves the section about autobuild fixing up, and expands it with more details about what autobuilds are, and how you can help with it. 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>
* toolchain/wrapper: rename BR_DEBUG_WRAPPERYann E. MORIN2014-03-051-1/+1
| | | | | | | | | | | The user-facing variables should be prefixed with BR2_, not BR_. Also quote the variable in the manual. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contributing: add section on analyzing bug reportsThomas De Schampheleire2014-03-051-0/+10
| | | | | | | | | This patch adds a small section to the manual promoting the reproduction, analysis and fixing of bug reports. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contributing: expand introductionThomas De Schampheleire2014-03-051-13/+22
| | | | | | | | | | | This patch expands the introduction of the "Contributing to buildroot" section. In general, the intention of this and subsequent patches is to promote non-feature contributions, like autobuild fixes, bug report analysis, TODO list work, etc. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: clarify Tested-by/Reviewed-by/Acked-by tagsThomas De Schampheleire2014-03-021-4/+41
| | | | | | | | | | This patch updates the manual with more clarified descriptions of tags Tested-by, Reviewed-by, and Acked-by, as discussed on the Buildroot developer days in February 2014. 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>
* manual: document minimal kernel headers dependencyYann E. MORIN2014-03-011-0/+6
| | | | | | | | | | | 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> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Merge branch 'next'Peter Korsgaard2014-02-284-12/+140
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: Makefile package/dmraid/Config.in package/gdb/Config.in.host package/linux-headers/linux-headers.mk package/python/python.mk package/python3/python3.mk package/rt-tests/Config.in package/sdl/sdl.mk package/systemd/systemd-01-fix-getty-unit.patch package/systemd/systemd-02-fix-page-size.patch package/systemd/systemd-03-uclibc-fix.patch package/udev/Config.in package/udisks/Config.in package/vlc/vlc.mk system/Config.in Quite some merge conflicts, hopefully I didn't screw up anything. Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * manual: adding packages perlFrancois Perrad2014-02-232-0/+122
| | | | | | | | | | Signed-off-by: Francois Perrad <francois.perrad@gadz.org> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * docs/manual: indicate how to handle BR2_TOOLCHAIN_HAS_THREADS_NPTLThomas Petazzoni2014-02-221-1/+6
| | | | | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
| * manual: update /dev management section.eric.le.bihan.dev@free.fr2014-02-121-9/+11
| | | | | | | | | | | | | | | | | | | | This patch updates the /dev management section in the manual with information about eudev, which replaces udev. Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Acked-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>
| * udev: convert to virtual packageeric.le.bihan.dev@free.fr2014-02-121-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch converts udev to a virtual package. For the moment, there is only one provider for the udev features: eudev. Packages meant to provide udev-like features must select the symbol BR2_PACKAGE_HAS_UDEV. Packages depending on BR2_ROOTFS_DEVICE_CREATION_DYNAMIC_UDEV or BR2_PACKAGE_UDEV have been converted to use the new symbol. [Peter: move legacy symbols under 2014.05] Signed-off-by: Eric Le Bihan <eric.le.bihan.dev@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | common-usage.txt: adjust documentation for renamed BR2_GRAPH_ variablesPeter Korsgaard2014-02-241-6/+6
| | | | | | | | Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | manual: fix missing DL_DIR rename to BR2_DL_DIRYann E. MORIN2014-02-241-1/+1
| | | | | | | | | | | | | | | | There was one instance of DL_DIR that was left out. Fix that. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: fix minor spelling/grammar mistakesThomas De Schampheleire2014-02-243-7/+7
| | | | | | | | | | | | | | | | | | This commit fixes a few minor spelling or grammar mistakes since the recent additions to the manual (commits 0b100de2cf36d81910ab53978b8a379214a683ea to 7cbb476661b0cfa213d8885f3fe5d58823e84286). Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: mention the per-package graph-depends targetThomas Petazzoni2014-02-231-0/+5
| | | | | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: document the usage of <pkg>_OVERRIDE_SRCDIRThomas Petazzoni2014-02-232-0/+86
| | | | | | | | | | | | [Peter: adjust wording as suggested by Yann] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: refresh informations about *-menuconfig targetsThomas Petazzoni2014-02-231-2/+4
| | | | | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: rephrase paragraph about unsupported external toolchainsThomas Petazzoni2014-02-231-17/+7
| | | | | | | | | | | | | | | | | | | | | | | | The ELDK now relies on Yocto, so it no longer has the funky non-standard way of doing multilib. Also, we didn't mention that Yocto toolchains/SDK are not suitable for usage with Buildroot. Therefore, this commit rewords this part of the documentation to explain that Yocto/OpenEmbedded SDKs cannot be used as external toolchains in Buildroot, and why. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: mention that custom toolchains is also useful for BR toolchainsThomas Petazzoni2014-02-231-8/+8
| | | | | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: update external toolchain examplesThomas Petazzoni2014-02-231-4/+3
| | | | | | | | | | | | | | | | | | Replace ADI by Analog Devices, which is clearer for most people, and remove the Xilinx external toolchains since we have deprecated them. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* | docs/manual: update informations about C library in internal backendThomas Petazzoni2014-02-231-19/+11
| | | | | | | | | | | | | | | | | | | | | | | | Now that we have eglibc and glibc support in the internal backend, and no longer marked as experimental, a little bit of rewording is needed. It is no longer necessary to indicate that uClibc was historically supported as the only C library, and that the glibc support is experimental. We also update the rest of the description to be less uClibc specific. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
OpenPOWER on IntegriCloud