diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about.html | 61 | ||||
| -rw-r--r-- | docs/buildroot.html | 58 | ||||
| -rw-r--r-- | docs/docs.html | 49 |
3 files changed, 127 insertions, 41 deletions
diff --git a/docs/about.html b/docs/about.html index 89ca62b8e..b985c4ff8 100644 --- a/docs/about.html +++ b/docs/about.html @@ -12,22 +12,53 @@ </a> </div> -Buildroot is a set of Makefiles and patches that makes it easy to generate a -cross-compilation toolchain and root filesystem for your target Linux -system using the <a href= "http://www.uclibc.org/">uClibc C library</a>. -Buildroot is useful mainly for people working with small or embedded -systems. Embedded systems often use processors that are not the regular -x86 processors everyone is used to using on their PC. It can be PowerPC -processors, MIPS processors, ARM processors, etc. And to be extra safe, -you do not need to be root to build or run Buildroot. - -<p> - -Buildroot is maintained by <a href= -"mailto:jacmet@uclibc.org">Peter Korsgaard</a>, and -licensed under the +<p>Buildroot is a set of Makefiles and patches that makes it easy to +generate a complete embedded Linux system. Buildroot can generate any +or all of a cross-compilation toolchain, a root filesystem, a kernel +image and a bootloader image. Buildroot is useful mainly for people +working with small or embedded systems, using various CPU +architectures (x86, ARM, MIPS, PowerPC, etc.) : it automates the +building process of your embedded system and eases the +cross-compilation process.</p> + +<p>The major Buildroot features are:</p> + +<ul> + + <li>Can <b>handle everything</b> in your embedded system development + project: cross-compiling toolchain, root filesystem generation, + kernel image compilation and bootloader compilation. Buildroot is + also sufficiently flexible that it can also be used for only one or + several of these steps.</li> + + <li>Is <b>very easy</b> to set up, thanks to its menuconfig and + xconfig configuration interfaces, familiar to all embedded Linux + developers. Building a basic embedded Linux system with Buildroot + typically takes 15-30 minutes.</li> + + <li>Supports <b>several hundreds of packages</b> for userspace + applications and libraries: X.org stack, Gtk2, Qt, DirectFB, SDL, + GStreamer and a large number of network-related and system-related + utilities and libraries are supported.</li> + + <li>Supports <b>multiple filesystem types</b> for the root + filesystem image: JFFS2, UBIFS, tarballs, romfs, cramfs, squashfs + and more.</li> + + <li>Can generate an uClibc cross-compilation toolchain, or re-use + your existing glibc, eglibc or uClibc cross-compilation + toolchain</li> + + <li>Has a <b>simple structure</b> that makes it easy to understand + and extend. It relies only on the well-know Makefile language.</li> + +</ul> + +<p>Buildroot is maintained by <a href= +"mailto:jacmet@uclibc.org">Peter Korsgaard</a>, and licensed under the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU -GENERAL PUBLIC LICENSE V2 (Or later)</a>. +GENERAL PUBLIC LICENSE V2 (Or later)</a>. Stable releases are +delivered every three months.</p> <!--#include file="footer.html" --> diff --git a/docs/buildroot.html b/docs/buildroot.html index abe822f79..3702b449f 100644 --- a/docs/buildroot.html +++ b/docs/buildroot.html @@ -798,6 +798,8 @@ community support.</p> <li><a href="#manual-tutorial">Manual Makefile : tutorial</a></li> </ul> </li> + <li><a href="#gettext-integration">Gettext integration and + interaction with packages</a></li> </ul> <h3><a name="package-directory"></a>Package directory</h3> @@ -1583,6 +1585,62 @@ LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP line <a href="#ex2line40">40</a>, which is used by Buildroot to download, compile, and then install this package. </p> + <h3><a name="gettext-integration"></a>Gettext integration and + interaction with packages</h3> + + <p>Many packages that support internationalization use the gettext + library. Dependency on this library are fairly complicated and + therefore deserves a few explanations.</p> + + <p>The <i>uClibc</i> C library doesn't implement gettext + functionality, therefore with this C library, a separate gettext + must be compiled. On the other hand, the <i>glibc</i> C library + does integrate its own gettext, and in this case, the separate + gettext library should not be compiled, because it creates various + kind of build failures.</p> + + <p>Additionnaly, some packages (such as libglib2) do require + gettext unconditionnally, while other packages (those who + support <code>--disable-nls</code> in general) only require + gettext when locale support is enabled.</p> + + <p>Therefore, Buildroot defines two configuration options:</p> + + <ul> + <li><code>BR2_NEEDS_GETTEXT</code>, which is true as soon as the + toolchain doesn't provide its own gettext implementation</li> + + <li><code>BR2_NEEDS_GETTEXT_IF_LOCALE</code>, which is true if + the toolchain doesn't provide its own gettext implementation and + if locale support is enabled</li> + + </ul> + + <p>Therefore, packages that unconditionnally need gettext should:</p> + + <ol> + <li>Use <code>select BR2_PACKAGE_GNUTTEXT if + BR2_NEEDS_GETTEXT</code> and possibly <code>select + BR2_PACKAGE_LIBINTL if BR2_NEEDS_GETTEXT</code> if libintl is + also needed</li> + + <li>Use <code>$(if $(BR2_NEEDS_GETTEXT),gettext)</code> in the + package <code>DEPENDENCIES</code> variable</li> + </ol> + + <p>Packages that need gettext only when locale support is enabled + should:</p> + + <ol> + <li>Use <code>select BR2_PACKAGE_GNUTTEXT if + BR2_NEEDS_GETTEXT_IF_LOCALE</code> and possibly <code>select + BR2_PACKAGE_LIBINTL if BR2_NEEDS_GETTEXT_IF_LOCALE</code> if + libintl is also needed</li> + + <li>Use <code>$(if + $(BR2_NEEDS_GETTEXT_IF_LOCALE),gettext)</code> in the + package <code>DEPENDENCIES</code> variable</li> + </ol> <h3>Conclusion</h3> diff --git a/docs/docs.html b/docs/docs.html index 663135a99..57f4bf64e 100644 --- a/docs/docs.html +++ b/docs/docs.html @@ -1,35 +1,32 @@ <!--#include file="header.html" --> - <h3>Documentation</h3> -Documentation for buildroot includes: + +<p>Our document "Buildroot usage and documentation" is where you want +to start reading if you wish to understand how Buildroot work, or wish +to change/extend/fix things. If you find any errors (factual, +grammatical, whatever) please report them. Choose between:</p> <ul> + <li><a href="/downloads/buildroot.html">Latest stable release</a></li> + <li><a href="buildroot.html">GIT head revision</a></li> +</ul> + +<p>If you find that you need help with Buildroot, you can ask for +help:</p> + +<ul> + + <li>On the <a href="lists.html">buildroot mailing list</a> + at <code>buildroot at uclibc.org</code></li> + + <li>On the <a href="irc://freenode.net/#uclibc">Buildroot IRC + channel</a>, <code>#uclibc</code> on Freenode</li> + + <li>On our <a href="https://bugs.uclibc.org">bugtracker</a>.</li> - <li> - Usage and documentation is where you want to start reading if you - wish to understand how buildroot work, or wish to - change/extend/fix things. If you find any errors (factual, - grammatical, whatever) please report them. Choose between: - <p> - <ul> - <li><a href="/downloads/buildroot.html">Latest stable release</a></li> - <li><a href="buildroot.html">GIT head revision</a></li> - </ul> - <p> - </li> - - <li> - <a href="README">README</a>. This is the README file included in the - buildroot source release. - </li> - - <li> - If you find that you need help with buildroot, you can ask for help on the - <a href= "lists.html">buildroot mailing list</a> at buildroot at uclibc.org. - In addition the BusyBox, uClibc, and buildroot developers are also known to - hang out on the uClibc IRC channel: #uclibc on irc.freenode.net. - </li> + <li>Through the various companies offering commercial Buildroot + support.</li> </ul> |