aboutsummaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
* docs/manual: mention the Eclipse integrationThomas Petazzoni2013-01-142-0/+32
| | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Makefile: don't export O to the environmentPeter Korsgaard2013-01-141-1/+1
| | | | | | | | 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>
* Makefile: export a few variables to help support scriptsYann E. MORIN2013-01-131-0/+7
| | | | | | | | | | | | | | | | | | | | | | | 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>
* docs/manual: update to mention the multiple patches supportThomas Petazzoni2013-01-071-7/+10
| | | | | | | | 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>
* docs/manual: small fixes and enhancements to adding generic packagesYann E. MORIN2012-12-301-13/+21
| | | | | | | | | | 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>
* docs/manual: do not suggest to create a symlink for shared download directoryThomas Petazzoni2012-12-291-15/+8
| | | | | | | | | | | 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>
* docs/manual: mention Java-related optional dependenciesThomas Petazzoni2012-12-291-0/+5
| | | | | | 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>
* docs/manual: remove incorrect prerequitesThomas Petazzoni2012-12-291-5/+0
| | | | | | | | | | | 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>
* docs/manual: remove FAQ entry about 'depends on' vs. 'select'Thomas Petazzoni2012-12-291-11/+0
| | | | | | | | | | | | | | 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>
* docs/manual: add details on toolchain configurationThomas Petazzoni2012-12-295-204/+277
| | | | | | | | | | | | | | | | | | | | | | 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>
* docs/manual: Slightly improve the introductionThomas Petazzoni2012-12-291-5/+10
| | | | | | 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>
* docs/manual: add a new 'Details on Buildroot configuration' sectionThomas Petazzoni2012-12-292-0/+153
| | | | | | | | | | | | | | | | | | | | | | 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>
* List the useful hook points available in buildrootDavide Viti2012-11-301-0/+3
| | | | | | | | | | 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>
* manual: restructure 'Adding packages' chapterArnout Vandecappelle (Essensium/Mind)2012-11-271-2/+5
| | | | | | | | | | | 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>
* manual: give example where _INSTALL_TARGET = NOArnout Vandecappelle (Essensium/Mind)2012-11-272-15/+15
| | | | | | | | | | | 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>
* manual: more warnings to not use output/targetArnout Vandecappelle (Essensium/Mind)2012-11-271-1/+2
| | | | | | 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>
* manual: various fixesArnout Vandecappelle (Essensium/Mind)2012-11-2720-165/+193
| | | | | | | | | | 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>
* manual: trivial fixesArnout Vandecappelle (Essensium/Mind)2012-11-2723-104/+122
| | | | | Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: minor tweaksSimon Dawson2012-11-1623-131/+128
| | | | | | | | | 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>
* manual: contribute.txt: do not use --summary option with 'git format-patch'Samuel Martin2012-11-161-2/+2
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: prerequisite.txt: add texinfo to the mandatory package listSamuel Martin2012-11-161-0/+1
| | | | | | | | 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>
* manual: add beyond-buildroot.txtSamuel Martin2012-11-152-0/+40
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add deprecated-list.txtSamuel Martin2012-11-151-0/+46
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add pkg-list.txt (generated list of available packages)Samuel Martin2012-11-152-0/+883
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add legal-info.txtSamuel Martin2012-11-154-158/+168
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add adding-package-tips.txtSamuel Martin2012-11-152-0/+56
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add patch-policy.txtSamuel Martin2012-11-152-0/+130
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add download-infra.txtSamuel Martin2012-11-153-1/+11
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add package-make-target.txtSamuel Martin2012-11-153-0/+94
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add contribute.txtSamuel Martin2012-11-153-0/+131
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add get-involved.txtSamuel Martin2012-11-152-0/+100
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add writing-rules.txtSamuel Martin2012-11-152-0/+127
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: faq.txt: rework and updateSamuel Martin2012-11-153-61/+136
| | | | | | | Also rename faq.txt -> faq-troubleshooting.txt Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add make-tips.txtSamuel Martin2012-11-152-0/+60
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: add prerequisite.txtSamuel Martin2012-11-152-0/+86
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: adding-package-directory.txt: update, cleanup and typo fixesSamuel Martin2012-11-151-11/+23
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: update rebuilding-packages.txtSamuel Martin2012-11-151-24/+41
| | | | | | | | - update "Understanding how to rebuild packages" section - add "Understanding when a full rebuild is necessary" section Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: customize-rootfs.txt: refactoring, misc. fixes and updateSamuel Martin2012-11-151-12/+18
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: rework using.txt and update common-usage.txtSamuel Martin2012-11-152-85/+110
| | | | | | | | | | | | | | Consider the second chapter: "starting-up", as a tutorial. Assuming that, using.txt only contains the very first commands used to get configure and build its very first target system. So, the following subsection from using.txt have been to common-usage.txt: - Offline builds - Building out-of-tree - Environment variables Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: rework introduction.txt and add embedded-basics.txtSamuel Martin2012-11-153-60/+126
| | | | | | | | | | Split and rephrasing of introduction.txt. Cross-toolchain explainations moved from introduction.txt into embedded-basics.txt. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: rework the whole documentation stubSamuel Martin2012-11-1531-58/+160
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The new skeleton of the manual as it has been thought: 1. About Buildroot: Presentation of Buildroot 2. Starting up: Everything to quickly and easily start working with Buildroot 3. Working with Buildroot Basics to make your work fitting your needs 4. Troubleshooting 5. Going further in Buildroot's innards Explaination of how buildroot is organised, how it works, etc 6. Developer Guidelines 7. Getting involved 8. Contibuting to Buildroot 9. Legal notice 10. Appendix It is easy to distinguish two parts in this plan: - Sections 1 to 4 mainly address people starting with Buildroot - Sections 5 to 10 are more focused on how to develop Buildroot itself Most of the existing sections have just been moved in the hierarchy, few were split and dispatch in, what i think was the relevant section, and numerous others have been created. Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: set toc depth to 4 for html outputsSamuel Martin2012-11-151-2/+2
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: make clean target consistent with others in buildrootSamuel Martin2012-11-151-3/+3
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* adding-package-generic.txt: BR2_SOURCEFORGE_MIRROR is no morePeter Korsgaard2012-11-071-3/+1
| | | | Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* legal-info: support per-package hooksLuca Ceresoli2012-11-041-1/+3
| | | | | | | | | Useful to produce extra warnings for packages that have special licensing-related issues. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* New top-level directory: systemThomas Petazzoni2012-11-041-2/+2
| | | | | | | | | | | | | | | | | | | | | | This directory groups the following elements: * the default root filesystem skeleton * the default device tables * the Config.in options for system configuration (UART port for getty, system hostname, etc.) * the make rules to apply the system configuration options Even though the skeleton and device tables could have lived in fs/, it would have been strange to have the UART, system hostname and other related options into fs/. A new system/ directory makes more sense. As a consequence, this patch also removes target/Makefile.in, which has become useless in the process. [Peter: fixup TARGET_SKELETON settings / documentation to match] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Yann E. MORIN <yann.morin.1998@free.fr> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs/manual: update to host-pkgconfPeter Korsgaard2012-10-292-2/+2
| | | | | | | Update the manual to match now that we have moved to pkgconf instead of pkg-config. Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: remove Manual Makefile sectionSamuel Martin2012-10-212-169/+0
| | | | | Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Add FAQ entry how to properly add package from github.Marek Belisko2012-10-081-0/+21
| | | | | | | Signed-off-by: Marek Belisko <marek.belisko@open-nandra.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>
* doc: update after gettext changesThomas Petazzoni2012-09-201-6/+2
| | | | | | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Tested-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> CC: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-18 23:47:06 +0000