Commit Graph

332 Commits

Author SHA1 Message Date
Simon Dawson
ecd2353555 manual: minor tweaks
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-16 22:24:42 +01:00
Samuel Martin
b04a6d7bda manual: contribute.txt: do not use --summary option with 'git format-patch'
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-16 08:43:47 +01:00
Samuel Martin
c7ece205fa manual: prerequisite.txt: add texinfo to the mandatory package list
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>
2012-11-16 08:43:43 +01:00
Samuel Martin
b6584017b4 manual: add beyond-buildroot.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:55 +01:00
Samuel Martin
8cbd58f013 manual: add deprecated-list.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:55 +01:00
Samuel Martin
c39686fc88 manual: add pkg-list.txt (generated list of available packages)
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:55 +01:00
Samuel Martin
757eb1910e manual: add legal-info.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:55 +01:00
Samuel Martin
baa838e392 manual: add adding-package-tips.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:54 +01:00
Samuel Martin
6c61000c3a manual: add patch-policy.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:54 +01:00
Samuel Martin
6bdeb7420e manual: add download-infra.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:54 +01:00
Samuel Martin
0e886fc3f6 manual: add package-make-target.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:54 +01:00
Samuel Martin
a79a54a0e7 manual: add contribute.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:54 +01:00
Samuel Martin
3b785593b6 manual: add get-involved.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:54 +01:00
Samuel Martin
ea1fa83bc3 manual: add writing-rules.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:53 +01:00
Samuel Martin
cc02514f95 manual: faq.txt: rework and update
Also rename faq.txt -> faq-troubleshooting.txt

Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:59:48 +01:00
Samuel Martin
b0cdae65f7 manual: add make-tips.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:58:52 +01:00
Samuel Martin
4ea3644afd manual: add prerequisite.txt
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:58:49 +01:00
Samuel Martin
b4783b41a9 manual: adding-package-directory.txt: update, cleanup and typo fixes
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:58:49 +01:00
Samuel Martin
df469937a5 manual: update rebuilding-packages.txt
- 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>
2012-11-15 23:58:48 +01:00
Samuel Martin
483a1f8281 manual: customize-rootfs.txt: refactoring, misc. fixes and update
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:58:48 +01:00
Samuel Martin
a90382616c manual: rework using.txt and update common-usage.txt
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>
2012-11-15 23:58:48 +01:00
Samuel Martin
0119ef3778 manual: rework introduction.txt and add embedded-basics.txt
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>
2012-11-15 23:58:44 +01:00
Samuel Martin
5e84b8b73c manual: rework the whole documentation stub
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>
2012-11-15 23:58:38 +01:00
Samuel Martin
17feaf0016 manual: set toc depth to 4 for html outputs
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:49:57 +01:00
Samuel Martin
b566e8cb56 manual: make clean target consistent with others in buildroot
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-15 23:49:48 +01:00
Peter Korsgaard
cf76170cc3 adding-package-generic.txt: BR2_SOURCEFORGE_MIRROR is no more
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-11-07 00:10:43 +01:00
Luca Ceresoli
db961da67f legal-info: support per-package hooks
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>
2012-11-04 13:33:29 +01:00
Thomas Petazzoni
6c3e3ad419 New top-level directory: system
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>
2012-11-04 12:51:08 +01:00
Peter Korsgaard
598aea4b61 docs/manual: update to host-pkgconf
Update the manual to match now that we have moved to pkgconf instead of
pkg-config.

Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-10-29 22:06:19 +01:00
Samuel Martin
93e4785aa4 manual: remove Manual Makefile section
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2012-10-21 21:39:43 +02:00
Marek Belisko
a84840bfe9 Add FAQ entry how to properly add package from github.
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>
2012-10-08 21:25:45 +02:00
Thomas Petazzoni
aa8ba9608d doc: update after gettext changes
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>
2012-09-20 21:34:34 +02:00
Thomas Petazzoni
288b73995a Prepare for 2012.08
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-08-31 10:49:41 +02:00
Thomas Petazzoni
8437b56258 Prepare for 2012.08-rc3
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-08-25 22:47:23 +02:00
Yann E. MORIN
576aafbd28 docs/manual: fix cross-reference
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-08-21 12:02:51 +02:00
Thomas Petazzoni
b58c83ae99 Update for 2012.08-rc2
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-08-15 12:11:48 +02:00
Thomas Petazzoni
d40d77ff70 docs: update links to the manual
In addition to the HTML version, also publish the PDF and Text
versions of our manual.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-08-02 10:25:23 +02:00
Thomas Petazzoni
4009cbbbf9 Update for 2012.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-08-01 20:46:31 +02:00
Maxime Ripard
e61153cf97 doc: Update the documentation to mention the new PKG_INSTALL_INIT_ variables
Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-30 23:12:17 +02:00
Thomas Petazzoni
6b36d54118 docs: announce the upcoming Buildroot developer meeting
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-22 18:41:13 +02:00
Thomas Petazzoni
8141ccf380 doc: minor documentation fixes after package infrastructure changes
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-17 20:27:05 +02:00
Arnout Vandecappelle (Essensium/Mind)
2359e1223f Clean up naming of old GENTARGETS infrastructure
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>
2012-07-17 20:24:03 +02:00
Arnout Vandecappelle (Essensium/Mind)
46fa5cbfb8 Rename XXXTARGETS to xxx-package
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>
2012-07-17 20:22:41 +02:00
Arnout Vandecappelle (Essensium/Mind)
c98337911c pkg-infra: add host-xxx-package macro
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>
2012-07-17 20:17:33 +02:00
Thomas Petazzoni
d56422a51a doc: get rid of the old HTML-only documentation
Users keep falling on this documentation, which is no longer kept
up-to-date with the developments. Get rid of it now.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-17 19:42:40 +02:00
Thomas Petazzoni
c6580011f1 doc: Add FAQ entries from the old HTML-only documentation
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-17 19:42:04 +02:00
Luca Ceresoli
1bb7a8ee4b manual: add advice about GPL compliance for Buildroot
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-17 19:06:29 +02:00
Luca Ceresoli
00ba118fca manual: document usage of the legal-info feature
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2012-07-17 19:06:27 +02:00
Nathan Lynch
fe8d4626f0 docs: describe "file" and "local" methods in LIBFOO_SITE_METHOD
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>
2012-07-02 07:32:37 +02:00
Nathan Lynch
9fd16a175b docs: rework LIBFOO_SITE_METHOD documentation
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>
2012-07-02 07:31:47 +02:00