summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
...
* docs: document the new github helper functionMischa 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 filesYann 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 commandsThomas 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 outputYann 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>
* legal info: update documentation with split target/host outputThomas 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-hooksYann 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 tooYann 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>
* docs/manual: Add version number to perl in prerequisitesMischa 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 hookThomas 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/fileThomas 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 supportThomas 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 dependenciesThomas 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 fullThomas 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>
* manual: customize-toolchain.txt: update internal backend sectionSamuel Martin2013-11-011-4/+9
| | | | | | | | | Mention all supported C libraries by the internal Buildroot toolchain backend. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: developer-guide.txt: cleanup non-existing sourceSamuel Martin2013-11-011-2/+0
| | | | | | | | | [Thomas: Added ThomasDS Acked-by, which was given on an earlier version of the same patch.] Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
* manual generation: rename manual-txt into manual-textThomas De Schampheleire2013-11-011-1/+1
| | | | | | | | | | The output extension and the generation messages refer to 'text', but the make target was confusingly 'txt'. This patch changes the make target for consistency. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual generation: check dependencies firstThomas De Schampheleire2013-11-013-4/+36
| | | | | | | | | | | To generate the manual, you need a few tools. If these are not present, pretty cryptic error messages are given. This patch adds a simple check for these dependencies, before attempting to build the manual. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* ccache: expose control interface via 'make ccache-options'Tzu-Jung Lee2013-10-271-0/+11
| | | | | | | | | | | | | | usage: # set cache limit size make CCACHE_OPTIONS="--max-size=5G" ccache-options # zero statistics counters make CCACHE_OPTIONS="--zero-stats" ccache-options [Peter: drop the redundant ifeq] Signed-off-by: Tzu-Jung Lee <tjlee@ambarella.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Makefile: revert BUILD_DIR exportGustavo Zacarias2013-10-251-2/+1
| | | | | | | | | | | | | Revert commit feb0877015cc0c644129e69276b3000c83742750 U-Boot uses $(BUILD_DIR) and causes issues, other packages might as well. Fixes: http://autobuild.buildroot.net/results/1f6/1f65289d5c284caa82a4e9137613f792797ee08a/ http://autobuild.buildroot.net/results/6a5/6a5f77483e908dc96d08824cf9113402431bace7/ It should probably be named somewhat more uniquely. Signed-off-by: Gustavo Zacarias <gustavo@zacarias.com.ar> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* Makefile: export BUILD_DIRYann E. MORIN2013-10-241-1/+2
| | | | | | | | | | | $(BUILD_DIR) is a nice place to put files generated during the build. With the advent of user-supplied step-hooks, they may want to store some information on the build. Export BUILD_DIR to that effect; update manual accordingly. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: update review process and patchworkRyan Barnett2013-10-142-4/+47
| | | | | | | | | | | | | Adding more documentaiton based on discussion from the mailing list in regards the buildroot review process and how patchworks can be used to pull in patches for testing purposes. Mailing list discussion: http://lists.busybox.net/pipermail/buildroot/2013-September/078170.html Signed-off-by: Ryan Barnett <rjbarnet@rockwellcollins.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: add section about depending on target and toolchain optionsThomas De Schampheleire2013-10-141-8/+82
| | | | | | | | | Currently, the comments in Config.in files when depending on toolchain options are not at all lined up. This patch adds a section to the documentation that explains which format is to be used. Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual: rename section name of package listsThomas De Schampheleire2013-10-141-4/+4
| | | | | | | | | | The original titles did no longer correspond with the actual menu names. Additionally, choose a name that better reflects the fact that this is a list. 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>
* package: add a <pkg>_EXTRA_DOWNLOADS variableThomas Petazzoni2013-10-081-0/+6
| | | | | | | | | | | | | | | | | | | Converting the external toolchain logic into a package raises a very special use case that wasn't handled by the package infrastructure: the Blackfin toolchain is delivered as two tarballs instead of one. Unfortunately <pkg>_SOURCE only allows to pass one tarball name. However, we really want both tarballs to be known by the package infrastructure, so that the normal 'source' and 'external-deps' mechanism work fine. In order to achieve this, we add a <pkg>_EXTRA_DOWNLOADS variable, which allows a package to list other stuff it would like to see downloaded, but that are otherwise not used by the package infrastructure itself: it is up to the package to do it by itself. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* manual/known-issues.txt: fix s/Soucery/Sourcery/ typoPeter Korsgaard2013-10-071-1/+1
| | | | | Reported-by: homas De Schampheleire <patrickdepinguin@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* trivial: manual: fix typo formating --> formattingThomas De Schampheleire2013-10-061-1/+1
| | | | | | 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>
* docs: update manual after Crosstool-NG backend removalThomas Petazzoni2013-10-065-84/+14
| | | | | | [Peter: remove a few more ctng references in customize-store.txt] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* docs/manual: add a 'Known issues' chapterThomas Petazzoni2013-10-062-0/+34
| | | | | | | | | | | Add a 'Known issues' chapter, which lists the exceptions I have currently in the autobuilder scripts to avoid known problems from occuring. I believe it is more useful to document them rather than keeping them hidden in my autobuilder script. [Peter: s/either/either use/] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
* toolchain/wrapper: add option to print one argument per lineYann E. MORIN2013-09-221-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | In case there are many arguments passed to the tools, the command line can get very long, and difficult to parse visually. For example, the Linux kernel passes a lot of arguments to gcc (at least 45, which gives 53 with our hard-coded args). Looking at such a command line is daunting. So, add the possibility to print each argument on its own line. Also, enclose all args between single quotes, so the command line can be safely copy-pasted without special chars (spaces, $) being inrerpreted by the shell. Add blurb about toolchain-wrapper to documentation at the same time. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas De Schampheleire <patrickdepinguin@gmail.com> Acked-by: Luca Ceresoli <luca@lucaceresoli.net> Tested-by: Luca Ceresoli <luca@lucaceresoli.net> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual generation: change capitalization of messagesThomas De Schampheleire2013-09-201-3/+3
| | | | | | | | | | | | | | | | | | | | | | When generating the manual, you see following messages: >>> Generating HTML manual... >>> Generating Split HTML manual... >>> Generating PDF manual... >>> Generating Text manual... >>> Generating EPUB manual... and with this patch the capitalization is changed so that it becomes: >>> Generating HTML manual... >>> Generating split HTML manual... >>> Generating PDF manual... >>> Generating text manual... >>> Generating ePUB manual... Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* trivial: manual: multimedia is no longer a subdirectoryThomas De Schampheleire2013-09-181-1/+1
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* trivial: manual: fix grammar of 'to express'Thomas De Schampheleire2013-09-181-2/+2
| | | | | Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Trivial documentation fix for Signed-off-byRalph Siemsen2013-09-162-3/+3
| | | | | | | | Make consistent the capitalization and punctuation of Signed-of-by examples. Signed-off-by: Ralph Siemsen <ralphs@netwinder.org> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/patch-policy.txt: fix missing wordPeter Korsgaard2013-09-161-1/+1
| | | | Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: add CVS support documentationGustavo Zacarias2013-09-132-1/+8
| | | | | Signed-off-by: Gustavo Zacarias <gustavo@zacarias.com.ar> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* change package tarball compression to xz whenever possibleJerzy Grzegorek2013-09-083-8/+8
| | | | | | [Peter: leave change xz tarball format to not end up with circular deps] Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Fix build reproducibility in Make 3.82Jérôme Pouiller2013-09-061-1/+1
| | | | | | | | | | | | Make 3.82 no longer sort the result of wildcards (see http://comments.gmane.org/gmane.comp.gnu.make.bugs/4260). This may break build reproducibility. This patch sort results of wildcards to ensure reproducibility. Signed-off-by: Jérôme Pouiller <jezz@sysmic.org> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Remove references to module-init-toolsPeter Korsgaard2013-09-021-15/+0
| | | | | | Now that it is replaced by kmod. Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: minor typos and formating fixesSamuel Martin2013-08-103-12/+20
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: tips: document how to build the manualA.R.D2013-08-101-0/+17
| | | | | | | Signed-off-by: A.R.D. <contact@team-ard.com> Cc: Willy Lambert <lambert.willy@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: contribute.txt: add patch revision sectionVinicius Tinti2013-08-101-4/+71
| | | | | | | | | | | | | Improve the contribute manual section by adding an explanation about patch review and version. The section now provides advices in how to respond maintainers requests and how to proceed on replying them. [Thomas: further small modifications.] Signed-off-by: Vinicius Tinti <viniciustinti@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: mention LIBFOO_EXTRACT_CMDSStephan Hoffmann2013-08-071-0/+7
| | | | | | | | | | [Samuel: add precision about non-tar archive] [Thomas: reword with more details. Fix commit title] Signed-off-by: Stephan Hoffmann <sho@relinux.de> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* system: add option to pass extra args to post-build and post-image scriptsYann E. MORIN2013-07-101-7/+12
| | | | | | | | | | | | | | | | | It can be useful to have different configuration use the same post-build and/or post-image scripts as they share a common infrastructure, but yet have minor differentiation. This option allows passing zero or more additional arguments to each post-build or post-image script. The same set of extra arguments are passed to all scripts, it is not possible to pass different arguments to each script. [Peter: fix help text, post-image gets called with the images dir] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Baruch Siach <baruch@tkos.co.il> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: update to mention eglibc support in Buildroot toolchain backendThomas Petazzoni2013-07-041-26/+26
| | | | | | [Peter: minor tweak] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* uclibc: convert to the package infrastructureThomas Petazzoni2013-07-041-2/+2
| | | | | | [Peter: update manual to match] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Add documentation for the header styleAlexandre Belloni2013-06-164-6/+18
| | | | | Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: github: merge tag/commit ID examplesPeter Korsgaard2013-06-071-16/+8
| | | | | | And reword as suggested by Samuel. Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: correct error in github tarball informationSpenser Gilliland2013-06-071-1/+1
| | | | | | | Updates to manual for bug 6302 Signed-off-by: Spenser Gilliland <spenser@gillilanding.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* doc: Add txt document for the new package-specific FLAT_STACKSIZE option.Sonic Zhang2013-06-061-0/+6
| | | | | Signed-off-by: Sonic Zhang <sonic.zhang@analog.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: do not track generated filesSamuel Martin2013-05-042-916/+0
| | | | | | | | | Since there is no need to edit the generated list, we don't need to keep the files under git control, so remove the existing lists. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
OpenPOWER on IntegriCloud