summaryrefslogtreecommitdiffstats
path: root/docs/manual
AgeCommit message (Collapse)Author
2013-06-07manual: github: merge tag/commit ID examplesPeter Korsgaard
And reword as suggested by Samuel. Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-06-07manual: correct error in github tarball informationSpenser Gilliland
Updates to manual for bug 6302 Signed-off-by: Spenser Gilliland <spenser@gillilanding.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-06-06doc: Add txt document for the new package-specific FLAT_STACKSIZE option.Sonic Zhang
Signed-off-by: Sonic Zhang <sonic.zhang@analog.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-05-04manual: do not track generated filesSamuel Martin
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>
2013-05-04manual: add a make target 'manual-update-lists'Samuel Martin
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>
2013-05-04manual: cleanup appendix.txtSamuel Martin
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>
2013-04-25packages: add ability for packages to create usersYann E. MORIN
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>
2013-03-27manual: add manual generation date/git revision in the manual textSamuel Martin
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>
2013-03-25manual: fix typoTilman Keskinöz
Signed-off-by: Tilman Keskinöz <arved@arved.at> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-03-24dependencies: remove a few useless mandatory dependenciesThomas Petazzoni
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>
2013-03-19rework patch modelSimon Dawson
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>
2013-02-28Manual: add empty line after header in .mk filesStephan Hoffmann
Signed-off-by: Stephan Hoffmann <sho@relinux.de> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-02-28working-with: board supportSamuel Martin
Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-02-28manual: misc. post-{build, image} scripts fixesSamuel Martin
* 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>
2013-02-28manual: minor fix in patch-policy.txtSamuel Martin
Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-02-28manual: fix cross-refsSamuel Martin
Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-02-17manual: minor fix in patch-policy.txtSamuel Martin
[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>
2013-02-17manual: sprinkle with some calls to MESSAGESamuel Martin
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>
2013-02-17manual: cleanup and update editor tagsSamuel Martin
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>
2013-02-08package: remove scripts listed in <pkg>_CONFIG_SCRIPTS from targetThomas Petazzoni
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>
2013-02-08package: rename <pkg>_CONFIG_FIXUP to <pkg>_CONFIG_SCRIPTSThomas Petazzoni
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>
2013-02-08rootfs-overlay: also exclude .empty filesArnout Vandecappelle (Essensium/Mind)
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>
2013-02-08docs/manual: slightly reword the solutions to customize rootfsThomas Petazzoni
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>
2013-02-08docs/manual: no longer mention the package/customize thingThomas Petazzoni
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>
2013-02-08docs/manual: mention the new post-image mechanismThomas Petazzoni
[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>
2013-02-05Make savedefconfig save to a configured file.Arnout Vandecappelle (Essensium/Mind)
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>
2013-02-05target/generic: add filesystem overlay optionArnout Vandecappelle (Essensium/Mind)
The filesystem overlay is a tree that is copied over the target fs after building everything - which is currently usually done in the post-build script. [Peter: don't ignore missing directories] 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>
2013-02-05manual: add section about storing the configuration.Arnout Vandecappelle (Essensium/Mind)
Reuse part of board-support.txt, and remove that one because it was unused. [Peter: minor tweaks to text] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-02-04pkg-infra: add <pkg>_CONFIG_FIXUP to fix *-config filesStefan Fröberg
This patch will add <pkg>_CONFIG_FIXUP variable to buildroot infra. It's purpose is to inform buildroot that the package in question contains some $(STAGING_DIR)/usr/bin/*-config files and that we want to automatically fix prefixes of such files. It is often the case that many packages call these files during their configuration step to determine 3rd party library package locations and any flags needed to link against them. For example: Some package might try to check the existense and linking flags of NSPR package by calling $(STAGING_DIR)/usr/bin/nspr-config --prefix. Without this fix. NSPR would return /usr/ as it's prefix which is wrong when cross-compiling. Correct would be $(STAGING_DIR)/usr. All packages that have <pkg>_INSTALL_STAGING = YES defined and also install some config file(s) into $(STAGING_DIR)/usr/bin must hereafter also define <pkg>_CONFIG_FIXUP with the correspondig filename(s). For example: DIVINE_CONFIG_FIXUP = divine-config or for multiple files: IMAGEMAGICK_CONFIG_FIXUP = Magick-config Wand-config Signed-off-by: Stefan Fröberg <stefan.froberg@petroprogram.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-01-14docs/manual: mention the Eclipse integrationThomas Petazzoni
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-01-14Makefile: don't export O to the environmentPeter Korsgaard
Several projects use the kernel style O=<dir> syntax to build out of tree, and atleast uClibc doesn't check that it was explictly passed on the command line, so setting it in the environment breaks the build. Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-01-13Makefile: export a few variables to help support scriptsYann E. MORIN
Support scripts (in support/) may need to parse the .config file, so give them an easy access to it, by exporting BUILDROOT_CONFIG with the fully- qualified path to .config. Also, post-build scripts may need to reference a few locations, so export those, too. Note: we export both O and BASE_DIR. Although they are the same, BASE_DIR is used internally, while O is used on the command line, which makes it a bit ambiguous to know which to use. As users use O= on the command line, they will probably tend to use that in their post-build scripts. Update doc accordingly. [Peter: fixed typo] Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> cc: Peter Korsgaard <jacmet@uclibc.org> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2013-01-07docs/manual: update to mention the multiple patches supportThomas Petazzoni
After the modification of the <pkg>_PATCH semantic, let's update the documentation accordingly. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-30docs/manual: small fixes and enhancements to adding generic packagesYann E. MORIN
Add overall description of LIBFOO_DEVICES and LIBFOO_PERMISSIONS. Fix line numbers. Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-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>
2012-12-29docs/manual: do not suggest to create a symlink for shared download directoryThomas Petazzoni
Creating a symbolic link for the download directory is really not a useful suggestion, since we have the much better solution of the BUILDROOT_DL_DIR environment variable. So emphasize this solution instead, and remove the suggestion of the symbolic link. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-29docs/manual: mention Java-related optional dependenciesThomas Petazzoni
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-29docs/manual: remove incorrect prerequitesThomas Petazzoni
The development files for zlib or netpbm are not needed, and neither is python-xcbgen. None of these are present in the chroot used in the autobuilders, and anyway if those would be needed, it would be a Buildroot bug and not something to be mentionned in the documentation. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-29docs/manual: remove FAQ entry about 'depends on' vs. 'select'Thomas Petazzoni
The FAQ is before the section on package development, and only covers user issues, not developer issues, so the FAQ entry about 'depends on' vs. 'select' really doesn't have its place here. And the 'depends on' vs. 'select' issue is already covered in a later section, see http://buildroot.org/downloads/manual/manual.html#depends-on-vs-select. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-29docs/manual: add details on toolchain configurationThomas Petazzoni
This commit adds a new section Working with Buildroot -> Details in configuration -> Cross-compilation toolchain that gives a lot of details about our three toolchain backends. It takes some elements that were previously later in the manual in "Embedded basics" and in "External toolchain" and combines them with more details about internal backend and Crosstool-NG backend. The "Embedded basics" section becomes empty and is therefore removed. A few elements have been lost in the process, but they were considered to not be really useful, especially located so far in the manual. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-29docs/manual: Slightly improve the introductionThomas Petazzoni
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-12-29docs/manual: add a new 'Details on Buildroot configuration' sectionThomas Petazzoni
As discussed with Samuel Martin, there are a few questions about some Buildroot configuration aspects that come very often on the IRC channel and on the mailing-list. Topics such as the /dev management and init systems are often raised. Therefore, this patch adds a new section that provides details about the Buildroot configuration possibilities. It does not aim at replacing the help text of each configuration option, but rather to complement them by providing more background. Having those informations in the manual will also make it easier for us to point newcomers to the right place in the documentation when they have questions. Note that this section will replace the "Embedded basics" section that comes way too late in the manual. This is done in a followup commit. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-30List the useful hook points available in buildrootDavide Viti
The complete list can be obtained with the following command: grep "_HOOKS[ ]\+?=" package/pkg-generic.mk Signed-off-by: Davide Viti <zinosat@tiscali.it> Acked-by: Samuel Martin <s.martin49@gmail.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-27manual: restructure 'Adding packages' chapterArnout Vandecappelle (Essensium/Mind)
The depends-on-vs-select part of the manual really deserves its own section title (especially because it is referred to and the xref gets a 'sinpara' in PDF if the section doesn't have a title). So restructure the surrounding sections to reduce the section nesting depth. 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>
2012-11-27manual: give example where _INSTALL_TARGET = NOArnout Vandecappelle (Essensium/Mind)
The tutorial for autotools-package and cmake-package currently gives the bad example of setting _INSTALL_TARGET to YES, which is the default. So change this into an example with _INSTALL_TARGET = NO, and explain in which case this is relevant. 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>
2012-11-27manual: more warnings to not use output/targetArnout Vandecappelle (Essensium/Mind)
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>
2012-11-27manual: various fixesArnout Vandecappelle (Essensium/Mind)
Various consistency and correctness improvements. Also removing some sentences that are not or no longer relevant. 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>
2012-11-27manual: trivial fixesArnout Vandecappelle (Essensium/Mind)
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-16manual: minor tweaksSimon Dawson
Minor grammatical and spelling tweaks to the manual content. Signed-off-by: Simon Dawson <spdawson@gmail.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>
2012-11-16manual: contribute.txt: do not use --summary option with 'git format-patch'Samuel Martin
Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-16manual: prerequisite.txt: add texinfo to the mandatory package listSamuel Martin
Using the internal Buildroot toolchain backend, makeinfo, whom belongs to the texinfo package, is required to build gcc and gdb. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2024-11-15 04:32:03 +0000