aboutsummaryrefslogtreecommitdiffstats
path: root/docs/manual
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* docs/manual: fix cross-referenceYann E. MORIN2012-08-212-1/+2
| | | | | Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* doc: Update the documentation to mention the new PKG_INSTALL_INIT_ variablesMaxime Ripard2012-07-301-0/+7
| | | | | Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* doc: minor documentation fixes after package infrastructure changesThomas Petazzoni2012-07-173-6/+6
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Clean up naming of old GENTARGETS infrastructureArnout Vandecappelle (Essensium/Mind)2012-07-175-15/+15
| | | | | | | | | | | | | | | | | | | | With the renaming of XXXTARGETS to xxx-package, the names of the pkg-xxx.mk files is inconsistent, as well as some internal names in the documentation. These inconsistencies are cleaned up here. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> ...kages-autotargets.txt => adding-packages-autotools.txt} | 4 ++-- ...packages-cmaketargets.txt => adding-packages-cmake.txt} | 4 ++-- docs/manual/adding-packages-directory.txt | 12 ++++++------ ...packages-gentargets.txt => adding-packages-generic.txt} | 4 ++-- docs/manual/adding-packages.txt | 6 +++--- package/Makefile.in | 6 +++--- package/{pkg-autotargets.mk => pkg-autotools.mk} | 0 package/{pkg-cmaketargets.mk => pkg-cmake.mk} | 0 package/{pkg-gentargets.mk => pkg-generic.mk} | 0 9 files changed, 18 insertions(+), 18 deletions(-) Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* Rename XXXTARGETS to xxx-packageArnout Vandecappelle (Essensium/Mind)2012-07-173-20/+20
| | | | | | | | With the introduction of a specific macro for host targets, it was decided to also make the names of the macros more intuitive: generic-package, autotools-package and cmake-package. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
* pkg-infra: add host-xxx-package macroArnout Vandecappelle (Essensium/Mind)2012-07-173-25/+19
| | | | | | | | | | | | | | | Create host-generic-package, host-autotools-package and host-cmake-package macros. Such a macro is more intuitive to use than the $(call ...,host) construct. Also it speeds things up by having one less $(call ...) evaluation. Also includes documentation update, but not for buildroot.html. This brings the time for 'make -qp' (which is used by bash-completion) down from 1.85s to 1.35s on my laptop. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* doc: Add FAQ entries from the old HTML-only documentationThomas Petazzoni2012-07-172-0/+40
| | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: add advice about GPL compliance for BuildrootLuca Ceresoli2012-07-171-0/+27
| | | | | Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* manual: document usage of the legal-info featureLuca Ceresoli2012-07-172-0/+124
| | | | | Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
* docs: describe "file" and "local" methods in LIBFOO_SITE_METHODNathan Lynch2012-07-021-0/+8
| | | | | | | | | | Based on description by Thomas Petazzoni at: http://free-electrons.com/blog/buildroot-2011-11/ Signed-off-by: Nathan Lynch <ntl@pobox.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs: rework LIBFOO_SITE_METHOD documentationNathan Lynch2012-07-021-17/+29
| | | | | | | | | | | | | The current structure of the LIBFOO_SITE_METHOD paragraph would make it difficult to add documentation for the "file" and "local" methods. There are enough possible values for LIBFOO_SITE_METHOD that describing them in a sub-list seems to work well, which makes it easier to add documentation for new methods. Signed-off-by: Nathan Lynch <ntl@pobox.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* docs: update LIBFOO_SITE to describe use of filesystem pathsNathan Lynch2012-07-021-7/+14
| | | | | | | | | | | | Buildroot supports the use of local filesystem paths in LIBFOO_SITE since the 2011.11 release, but this is not documented in the manual. Fix this and slightly reword the surrounding doucmentation accordingly. Signed-off-by: Nathan Lynch <ntl@pobox.com> Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Move the manual build infrastructure to docs/manual/manual.mkThomas Petazzoni2012-04-201-0/+48
| | | | | Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* Add documentation for <pkg>-rebuild and <pkg>-reconfigureStephan Hoffmann2012-04-071-0/+4
| | | | | | | | | Since these two special make targets are very useful but not yet mentioned in the documentation I added them to the make help and the manual. Signed-off-by: Stephan Hoffmann <sho@reLinux.de> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* DOWNLOAD: change $1=DIRECTORY_URL, $2=FILE_NAME to $1=FULL_FILE_URL, ↵Alvaro G. M2012-03-181-1/+1
| | | | | | | | | | | | | | | | | | | | | $2=FILE_NAME This modifies the definition of DOWNLOAD to receive two arguments: the first one is the full URL of the file to download, whereas the second (and optional) is the name the file will have once downloaded. Same thing with the SOURCE_CHECK_WGET and SCP functions. All calls to these functions have been changed to the shortest form of the new API, except for toolchains acquisition. Since there is quite a number of different toolchains this call to DOWNLOAD is better set to the generic one. Signed-off-by: Alvaro G. M <alvaro.gamez@hazent.com> Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> Tested-by: Stephan Hoffmann <sho@relinux.de> Downloading Microblaze LE toolchain works on a clean install Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
* manual: update Config.in dependency explainationsSamuel MARTIN2012-03-181-0/+53
| | | | | | | [Peter: adjusted according to Arnout's suggestions] 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: fix typoSamuel MARTIN2012-03-182-8/+9
| | | | | | 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-17 05:12:14 +0000