summaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* manual: add a make target 'manual-update-lists'Samuel Martin2013-05-042-5/+16
| | | | | | | | | | The generated lists are automatically updated when building the manual. [Peter: fix typos] Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: indentation, remove temp dir, intro to host utils] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: cleanup appendix.txtSamuel Martin2013-05-042-10/+21
| | | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> [yann.morin.1998@free.fr: one more stuff->feature fixup] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* packages: add ability for packages to create usersYann E. MORIN2013-04-253-2/+102
| | | | | | | | | | | | | | | | Packages that install daemons may need those daemons to run as a non-root, or an otherwise non-system (eg. 'daemon'), user. Add infrastructure for packages to create users, by declaring the FOO_USERS variable that contain a makedev-syntax-like description of the user(s) to add. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Samuel Martin <s.martin49@gmail.com> Cc: Cam Hutchison <camh@xdna.net> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add manual generation date/git revision in the manual textSamuel Martin2013-03-271-0/+3
| | | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: fix typoTilman Keskinöz2013-03-251-1/+1
| | | | | Signed-off-by: Tilman Keskinöz <arved@arved.at> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* dependencies: remove a few useless mandatory dependenciesThomas Petazzoni2013-03-241-5/+0
| | | | | | | | | | | | | awk, bison, flex, makeinfo, gettext should be built as dependencies of packages when needed. In practice, even the toolchain build doesn't need any of these, and only a few packages do require them. It is not needed to list gzip and bzip2 since they are already checked through ${DL_TOOLS}: whenever a package needs gzip or bzip2 for its extraction, the dependency is added. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* rework patch modelSimon Dawson2013-03-193-3/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | At the Buildroot Developers Meeting (4-5 February 2013, in Brussels) a change to the patch logic was discussed. See http://elinux.org/Buildroot:DeveloperDaysFOSDEM2013 for details. In summary: * For patches stored in the package directory, if package/<pkg>/<version>/ does exist, apply package/<pkg>/<version>/*.patch, otherwise, apply package/<pkg>/*.patch * For patches stored in the global patches directory, if $(GLOBAL_PATCH_DIR)/<pkg>/<version>/ does exist, apply $(GLOBAL_PATCH_DIR)/<pkg>/<version>/*.patch, otherwise, apply $(GLOBAL_PATCH_DIR)/<pkg>/*.patch This patch adds the new BR2_GLOBAL_PATCH_DIR configuration item, and reworks the generic package infrastructure to implement the new patch logic. [Peter: fixup doc nits as pointed out by Thomas] Signed-off-by: Simon Dawson <spdawson@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Tested-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Manual: add empty line after header in .mk filesStephan Hoffmann2013-02-283-73/+76
| | | | | | Signed-off-by: Stephan Hoffmann <sho@relinux.de> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* working-with: board supportSamuel Martin2013-02-281-2/+2
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: misc. post-{build, image} scripts fixesSamuel Martin2013-02-281-14/+16
| | | | | | | | | * update post-build scripts mechanism that now support several scripts * fix formatting Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: minor fix in patch-policy.txtSamuel Martin2013-02-281-3/+13
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: fix cross-refsSamuel Martin2013-02-284-3/+12
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: minor fix in patch-policy.txtSamuel Martin2013-02-171-4/+3
| | | | | | | [Peter: Drop *.patch.<arch> description as noted by Thomas] Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: sprinkle with some calls to MESSAGESamuel Martin2013-02-171-1/+1
| | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: cleanup and update editor tagsSamuel Martin2013-02-1745-15/+60
| | | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* package: remove scripts listed in <pkg>_CONFIG_SCRIPTS from targetThomas Petazzoni2013-02-081-1/+6
| | | | | | | | | | The <foo>-config scripts are useless on the target, since they are only needed for development, so we remove them automatically. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* package: rename <pkg>_CONFIG_FIXUP to <pkg>_CONFIG_SCRIPTSThomas Petazzoni2013-02-081-8/+9
| | | | | | | | | | | | | | | | | | | | | | This commit renames the newly introduced <pkg>_CONFIG_FIXUP variable to <pkg>_CONFIG_SCRIPTS, for two reasons: * <pkg>_CONFIG_SCRIPTS will not only "fixup" the scripts in $(STAGING_DIR)/usr/bin, but also remove them from $(TARGET_DIR)/usr/bin. So it is not only about doing a "fixup". * On the principle, it is strange that the variable carries an indication of the action that will take place on those files. It should rather be named to say "Here are the <foo>-config scripts", and let the package infrastructure decide if it should fix them up, remove them, etc. This commit also updates the documentation accordingly. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* rootfs-overlay: also exclude .empty filesArnout Vandecappelle (Essensium/Mind)2013-02-081-2/+2
| | | | | | | | | This makes it possible to put empty directories in the overlay. Thanks to Aras Vaichas for pointing that out. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: slightly reword the solutions to customize rootfsThomas Petazzoni2013-02-081-11/+18
| | | | | | | | | | | | | | | | | The order of the solutions to customize the root filesystem is changed: we now mention the post-build script mechanism *before* the custom root filesystem skeleton mechanism, because the former is preferred over the latter. In addition to this, we give a few more details about direct customization of the root filesystem in output/target, and about the custom target skeleton solution. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Luca Ceresoli <luca@lucaceresoli.net> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: no longer mention the package/customize thingThomas Petazzoni2013-02-081-6/+0
| | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Luca Ceresoli <luca@lucaceresoli.net> Acked-by: "Samuel Martin" <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: mention the new post-image mechanismThomas Petazzoni2013-02-081-0/+22
| | | | | | | | [Peter: fix minor typos] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Make savedefconfig save to a configured file.Arnout Vandecappelle (Essensium/Mind)2013-02-051-4/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Store BR2_DEFCONFIG in .config, and use it to update the original input defconfig file after updating the configuration. When a config is created by using the BR2_DEFCONFIG=... option, this is saved in the .config file; later runs of savedefconfig will update that same location. It is also possible to configure this place in the interactive configuration. The BR2_DEFCONFIG value itself is not saved into the generated defconfig, since Kconfig considers it at its default. This is intentional, to avoid hard-coding an absolute path in the defconfig. It will anyway be set again when the defconfig is used with the 'make BR2_DEFCONFIG=... defconfig' command. As a side-effect of this change, the *config options have been moved out of the BR2_HAVE_DOT_CONFIG condition. This doesn't make any functional difference, because the .config is still not read for the *config targets. However, the defconfig and savedefconfig targets do need to include .config now, which makes them slightly slower. [Peter: slightly tweak help text] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
OpenPOWER on IntegriCloud