* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
@ 2011-08-04 21:23 Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 1/5] manual: convert existing documentation to the asciidoc format Thomas Petazzoni
` (6 more replies)
0 siblings, 7 replies; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-04 21:23 UTC (permalink / raw)
To: buildroot
Hello,
The Buildroot documentation was started by myself in December 2004
(see commit 32fcf718f82c241e890af8c7ccc10ef6c438331a), and at that
time the amount of documentation was relatively light, so the single
HTML file was seen as an appropriate solution to write the
documentation.
Since then, the documentation has expanded quite a bit, and I intend
to do some more important additions to the documentation in the near
future, but I feel like the hand-written HTML format is a bit
annoying.
Therefore, this set of patches proposes to switch the documentation
over to the AsciiDoc format [1]. It is a very simple text-baseda
format, from which you can generate HTML (single page or splitted),
PDF, text, and more.
I have done an initial conversion of the Buildroot documentation to
AsciiDoc and the result can be seen at :
* http://free-electrons.com/~thomas/buildroot/manual/manual.pdf for
the PDF version
* http://free-electrons.com/~thomas/buildroot/manual/manual.text for
the text version
* http://free-electrons.com/~thomas/buildroot/manual/manual.html for
the single page HTML version
* http://free-electrons.com/~thomas/buildroot/manual/html/ for
the multiple pages HTML version
Some more improvements can quite certainly be made to the converted
document. However, I'd prefer not to maintain it for a too long time
together with the current documentation, so if the solution of
AsciiDoc gets the attention of the Buildroot community, it'd be nice
to have this merged relatively soon, or at least to not do too many
changes to the current documentation.
Best regards,
Thomas
[1] http://www.methods.co.nz/asciidoc/
The following changes since commit 55cea3b5ef3bd5464420fd610c73e150443d0e67:
util-linux: add option for libmount (2011-07-29 13:38:49 +0200)
are available in the git repository at:
http://free-electrons.com/~thomas/buildroot.git asciidoc-manual
Thomas Petazzoni (5):
manual: convert existing documentation to the asciidoc format
manual: provide make targets to build the documentation
remove the old buildroot.html documentation
remove Glibc_vs_uClibc document
manual: ignore generated files
Makefile | 40 +-
docs/Glibc_vs_uClibc.html | 240 ----
docs/buildroot.html | 1819 --------------------------
docs/manual/.gitignore | 4 +
docs/manual/adding-packages-autotargets.txt | 167 +++
docs/manual/adding-packages-cmaketargets.txt | 140 ++
docs/manual/adding-packages-conclusion.txt | 10 +
docs/manual/adding-packages-directory.txt | 76 ++
docs/manual/adding-packages-gentargets.txt | 303 +++++
docs/manual/adding-packages-gettext.txt | 44 +
docs/manual/adding-packages-handwritten.txt | 165 +++
docs/manual/adding-packages.txt | 21 +
docs/manual/board-support.txt | 35 +
docs/manual/ccache-support.txt | 21 +
docs/manual/customize-busybox-config.txt | 24 +
docs/manual/customize-kernel-config.txt | 12 +
docs/manual/customize-rootfs.txt | 36 +
docs/manual/customize-uclibc-config.txt | 32 +
docs/manual/customize.txt | 10 +
docs/manual/download-location.txt | 26 +
docs/manual/external-toolchain.txt | 84 ++
docs/manual/getting.txt | 23 +
docs/manual/how-buildroot-works.txt | 59 +
docs/manual/introduction.txt | 69 +
docs/manual/manual.txt | 32 +
docs/manual/rebuilding-packages.txt | 62 +
docs/manual/using-buildroot-toolchain.txt | 20 +
docs/manual/using.txt | 183 +++
28 files changed, 1697 insertions(+), 2060 deletions(-)
delete mode 100644 docs/Glibc_vs_uClibc.html
delete mode 100644 docs/buildroot.html
create mode 100644 docs/manual/.gitignore
create mode 100644 docs/manual/adding-packages-autotargets.txt
create mode 100644 docs/manual/adding-packages-cmaketargets.txt
create mode 100644 docs/manual/adding-packages-conclusion.txt
create mode 100644 docs/manual/adding-packages-directory.txt
create mode 100644 docs/manual/adding-packages-gentargets.txt
create mode 100644 docs/manual/adding-packages-gettext.txt
create mode 100644 docs/manual/adding-packages-handwritten.txt
create mode 100644 docs/manual/adding-packages.txt
create mode 100644 docs/manual/board-support.txt
create mode 100644 docs/manual/ccache-support.txt
create mode 100644 docs/manual/customize-busybox-config.txt
create mode 100644 docs/manual/customize-kernel-config.txt
create mode 100644 docs/manual/customize-rootfs.txt
create mode 100644 docs/manual/customize-uclibc-config.txt
create mode 100644 docs/manual/customize.txt
create mode 100644 docs/manual/download-location.txt
create mode 100644 docs/manual/external-toolchain.txt
create mode 100644 docs/manual/getting.txt
create mode 100644 docs/manual/how-buildroot-works.txt
create mode 100644 docs/manual/introduction.txt
create mode 100644 docs/manual/manual.txt
create mode 100644 docs/manual/rebuilding-packages.txt
create mode 100644 docs/manual/using-buildroot-toolchain.txt
create mode 100644 docs/manual/using.txt
Thanks,
--
Thomas Petazzoni
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [PATCH 1/5] manual: convert existing documentation to the asciidoc format
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
@ 2011-08-04 21:23 ` Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 2/5] manual: provide make targets to build the documentation Thomas Petazzoni
` (5 subsequent siblings)
6 siblings, 0 replies; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-04 21:23 UTC (permalink / raw)
To: buildroot
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
docs/manual/adding-packages-autotargets.txt | 167 ++++++++++++++
docs/manual/adding-packages-cmaketargets.txt | 140 ++++++++++++
docs/manual/adding-packages-conclusion.txt | 10 +
docs/manual/adding-packages-directory.txt | 76 +++++++
docs/manual/adding-packages-gentargets.txt | 303 ++++++++++++++++++++++++++
docs/manual/adding-packages-gettext.txt | 44 ++++
docs/manual/adding-packages-handwritten.txt | 165 ++++++++++++++
docs/manual/adding-packages.txt | 21 ++
docs/manual/board-support.txt | 35 +++
docs/manual/ccache-support.txt | 21 ++
docs/manual/customize-busybox-config.txt | 24 ++
docs/manual/customize-kernel-config.txt | 12 +
docs/manual/customize-rootfs.txt | 36 +++
docs/manual/customize-uclibc-config.txt | 32 +++
docs/manual/customize.txt | 10 +
docs/manual/download-location.txt | 26 +++
docs/manual/external-toolchain.txt | 84 +++++++
docs/manual/getting.txt | 23 ++
docs/manual/how-buildroot-works.txt | 59 +++++
docs/manual/introduction.txt | 69 ++++++
docs/manual/manual.txt | 32 +++
docs/manual/rebuilding-packages.txt | 62 ++++++
docs/manual/using-buildroot-toolchain.txt | 20 ++
docs/manual/using.txt | 183 ++++++++++++++++
24 files changed, 1654 insertions(+), 0 deletions(-)
create mode 100644 docs/manual/adding-packages-autotargets.txt
create mode 100644 docs/manual/adding-packages-cmaketargets.txt
create mode 100644 docs/manual/adding-packages-conclusion.txt
create mode 100644 docs/manual/adding-packages-directory.txt
create mode 100644 docs/manual/adding-packages-gentargets.txt
create mode 100644 docs/manual/adding-packages-gettext.txt
create mode 100644 docs/manual/adding-packages-handwritten.txt
create mode 100644 docs/manual/adding-packages.txt
create mode 100644 docs/manual/board-support.txt
create mode 100644 docs/manual/ccache-support.txt
create mode 100644 docs/manual/customize-busybox-config.txt
create mode 100644 docs/manual/customize-kernel-config.txt
create mode 100644 docs/manual/customize-rootfs.txt
create mode 100644 docs/manual/customize-uclibc-config.txt
create mode 100644 docs/manual/customize.txt
create mode 100644 docs/manual/download-location.txt
create mode 100644 docs/manual/external-toolchain.txt
create mode 100644 docs/manual/getting.txt
create mode 100644 docs/manual/how-buildroot-works.txt
create mode 100644 docs/manual/introduction.txt
create mode 100644 docs/manual/manual.txt
create mode 100644 docs/manual/rebuilding-packages.txt
create mode 100644 docs/manual/using-buildroot-toolchain.txt
create mode 100644 docs/manual/using.txt
diff --git a/docs/manual/adding-packages-autotargets.txt b/docs/manual/adding-packages-autotargets.txt
new file mode 100644
index 0000000..a319d25
--- /dev/null
+++ b/docs/manual/adding-packages-autotargets.txt
@@ -0,0 +1,167 @@
+Infrastructure for autotools-based packages
+-------------------------------------------
+
++AUTOTARGETS+ tutorial
+~~~~~~~~~~~~~~~~~~~~~~
+
+First, let's see how to write a +.mk+ file for an autotools-based
+package, with an example :
+
+------------------------
+01: #############################################################
+02: #
+03: # libfoo
+04: #
+05: #############################################################
+06: LIBFOO_VERSION = 1.0
+07: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
+08: LIBFOO_SITE = http://www.foosoftware.org/download
+09: LIBFOO_INSTALL_STAGING = YES
+10: LIBFOO_INSTALL_TARGET = YES
+11: LIBFOO_CONF_OPT = --enable-shared
+12: LIBFOO_DEPENDENCIES = libglib2 host-pkg-config
+13:
+14: $(eval $(call AUTOTARGETS,package,libfoo))
+------------------------
+
+On line 6, we declare the version of the package.
+
+On line 7 and 8, we declare the name of the tarball and the location
+of the tarball on the Web. Buildroot will automatically download the
+tarball from this location.
+
+On line 9, we tell Buildroot to install the package to the staging
+directory. The staging directory, located in +output/staging/+
+is the directory where all the packages are installed, including their
+development files, etc. By default, packages are not installed to the
+staging directory, since usually, only libraries need to be installed in
+the staging directory: their development files are needed to compile
+other libraries or applications depending on them. Also by default, when
+staging installation is enabled, packages are installed in this location
+using the +make install+ command.
+
+On line 10, we tell Buildroot to also install the package to the
+target directory. This directory contains what will become the root
+filesystem running on the target. Usually, we try not to install header
+files and to install stripped versions of the binary. By default, target
+installation is enabled, so in fact, this line is not strictly
+necessary. Also by default, packages are installed in this location
+using the +make install+ command.
+
+On line 11, we tell Buildroot to pass a custom configure option, that
+will be passed to the +./configure+ script before configuring
+and building the package.
+
+On line 12, we declare our dependencies, so that they are built
+before the build process of our package starts.
+
+Finally, on line line 14, we invoke the +AUTOTARGETS+
+macro that generates all the Makefile rules that actually allows the
+package to be built.
+
++AUTOTARGETS+ reference
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The main macro of the autotools package infrastructure is
++AUTOTARGETS+. It has the same number of arguments and the
+same semantic as the +GENTARGETS+ macro, which is the main
+macro of the generic package infrastructure. For autotools packages, the
+ability to have target and host packages is also available (and is
+actually widely used).
+
+Just like the generic infrastructure, the autotools infrastructure
+works by defining a number of variables before calling the
++AUTOTARGETS+ macro.
+
+First, all the package metadata information variables that exist in the
+generic infrastructure also exist in the autotools infrastructure:
++LIBFOO_VERSION+, +LIBFOO_SOURCE+,
++LIBFOO_PATCH+, +LIBFOO_SITE+,
++LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+,
++LIBFOO_INSTALL_STAGING+, +LIBFOO_INSTALL_TARGET+.
+
+A few additional variables, specific to the autotools infrastructure,
+can also be defined. Many of them are only useful in very specific
+cases, typical packages will therefore only use a few of them.
+
+* +LIBFOO_SUBDIR+ may contain the name of a subdirectory
+ inside the package that contains the configure script. This is useful,
+ if for example, the main configure script is not at the root of the
+ tree extracted by the tarball. If +HOST_LIBFOO_SUBDIR+ is
+ not specified, it defaults to +LIBFOO_SUBDIR+.
+
+* +LIBFOO_CONF_ENV+, to specify additional environment
+ variables to pass to the configure script. By default, empty.
+
+* +LIBFOO_CONF_OPT+, to specify additional configure
+ options to pass to the configure script. By default, empty.
+
+* +LIBFOO_MAKE+, to specify an alternate +make+
+ command. This is typically useful when parallel make is enabled in
+ the configuration (using +BR2_JLEVEL+) but that this
+ feature should be disabled for the given package, for one reason or
+ another. By default, set to +$(MAKE)+. If parallel building
+ is not supported by the package, then it should be set to
+ +LIBFOO_MAKE=$(MAKE1)+.
+
+* +LIBFOO_MAKE_ENV+, to specify additional environment
+ variables to pass to make in the build step. These are passed before
+ the +make+ command. By default, empty.
+
+* +LIBFOO_MAKE_OPT+, to specify additional variables to
+ pass to make in the build step. These are passed after the
+ +make+ command. By default, empty.
+
+* +LIBFOO_AUTORECONF+, tells whether the package should
+ be autoreconfigured or not (i.e, if the configure script and
+ Makefile.in files should be re-generated by re-running autoconf,
+ automake, libtool, etc.). Valid values are +YES+ and
+ +NO+. By default, the value is +NO+
+
+* +LIBFOO_AUTORECONF_OPT+ to specify additional options
+ passed to the 'autoreconf' program if
+ +LIBFOO_AUTORECONF=YES+. By default, empty.
+
+* +LIBFOO_LIBTOOL_PATCH+ tells whether the Buildroot
+ patch to fix libtool cross-compilation issues should be applied or
+ not. Valid values are +YES+ and +NO+. By
+ default, the value is +YES+
+
+* +LIBFOO_INSTALL_STAGING_OPT+ contains the make options
+ used to install the package to the staging directory. By default, the
+ value is +DESTDIR=$$(STAGING_DIR) install+, which is
+ correct for most autotools packages. It is still possible to override
+ it.
+
+* +LIBFOO_INSTALL_TARGET_OPT+ contains the make options
+ used to install the package to the target directory. By default, the
+ value is +DESTDIR=$$(TARGET_DIR) install+. The default
+ value is correct for most autotools packages, but it is still possible
+ to override it if needed.
+
+* +LIBFOO_CLEAN_OPT+ contains the make options used to
+ clean the package. By default, the value is +clean+.
+
+* +LIBFOO_UNINSTALL_STAGING_OPT+, contains the make
+ options used to uninstall the package from the staging directory. By
+ default, the value is +DESTDIR=$$(STAGING_DIR) uninstall+.
+
+* +LIBFOO_UNINSTALL_TARGET_OPT+, contains the make
+ options used to uninstall the package from the target directory. By
+ default, the value is +DESTDIR=$$(TARGET_DIR) uninstall+.
+
+With the autotools infrastructure, all the steps required to build
+and install the packages are already defined, and they generally work
+well for most autotools-based packages. However, when required, it is
+still possible to customize what is done in any particular step:
+
+* By adding a post-operation hook (after extract, patch, configure,
+ build or install). See the reference documentation of the generic
+ infrastructure for details.
+
+* By overriding one of the steps. For example, even if the autotools
+ infrastructure is used, if the package +.mk+ file defines its
+ own +LIBFOO_CONFIGURE_CMDS+ variable, it will be used
+ instead of the default autotools one. However, using this method
+ should be restricted to very specific cases. Do not use it in the
+ general case.
diff --git a/docs/manual/adding-packages-cmaketargets.txt b/docs/manual/adding-packages-cmaketargets.txt
new file mode 100644
index 0000000..1c3ac48
--- /dev/null
+++ b/docs/manual/adding-packages-cmaketargets.txt
@@ -0,0 +1,140 @@
+Infrastructure for CMake-based packages
+---------------------------------------
+
++CMAKETARGETS+ tutorial
+~~~~~~~~~~~~~~~~~~~~~~~
+
+First, let's see how to write a +.mk+ file for a CMake-based package,
+with an example :
+
+------------------------
+01: #############################################################
+02: #
+03: # libfoo
+04: #
+05: #############################################################
+06: LIBFOO_VERSION = 1.0
+07: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
+08: LIBFOO_SITE = http://www.foosoftware.org/download
+09: LIBFOO_INSTALL_STAGING = YES
+10: LIBFOO_INSTALL_TARGET = YES
+11: LIBFOO_CONF_OPT = -DBUILD_DEMOS=ON
+12: LIBFOO_DEPENDENCIES = libglib2 host-pkg-config
+13:
+14: $(eval $(call CMAKETARGETS,package,libfoo))
+------------------------
+
+On line 6, we declare the version of the package.
+
+On line 7 and 8, we declare the name of the tarball and the location
+of the tarball on the Web. Buildroot will automatically download the
+tarball from this location.
+
+On line 9, we tell Buildroot to install the package to the staging
+directory. The staging directory, located in +output/staging/+
+is the directory where all the packages are installed, including their
+development files, etc. By default, packages are not installed to the
+staging directory, since usually, only libraries need to be installed in
+the staging directory: their development files are needed to compile
+other libraries or applications depending on them. Also by default, when
+staging installation is enabled, packages are installed in this location
+using the +make install+ command.
+
+On line 10, we tell Buildroot to also install the package to the
+target directory. This directory contains what will become the root
+filesystem running on the target. Usually, we try not to install header
+files and to install stripped versions of the binary. By default, target
+installation is enabled, so in fact, this line is not strictly
+necessary. Also by default, packages are installed in this location
+using the +make install+ command.
+
+On line 11, we tell Buildroot to pass custom options to CMake when it is
+configuring the package.
+
+On line 12, we declare our dependencies, so that they are built
+before the build process of our package starts.
+
+Finally, on line line 14, we invoke the +CMAKETARGETS+
+macro that generates all the Makefile rules that actually allows the
+package to be built.
+
++CMAKETARGETS+ reference
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+<h4 id="cmake-reference">Makefile for CMake packages : reference</h4>
+
+The main macro of the CMake package infrastructure is
++CMAKETARGETS+. It has the same number of arguments and the same
+semantic as the +GENTARGETS+ macro, which is the main macro of the
+generic package infrastructure. For CMake packages, the ability to
+have target and host packages is also available.
+
+Just like the generic infrastructure, the CMake infrastructure works
+by defining a number of variables before calling the +CMAKETARGETS+
+macro.
+
+First, all the package metadata information variables that exist in
+the generic infrastructure also exist in the CMake infrastructure:
++LIBFOO_VERSION+, +LIBFOO_SOURCE+, +LIBFOO_PATCH+, +LIBFOO_SITE+,
++LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+, +LIBFOO_INSTALL_STAGING+,
++LIBFOO_INSTALL_TARGET+.
+
+A few additional variables, specific to the CMake infrastructure, can
+also be defined. Many of them are only useful in very specific cases,
+typical packages will therefore only use a few of them.
+
+* +LIBFOO_SUBDIR+ may contain the name of a subdirectory inside the
+ package that contains the main CMakeLists.txt file. This is useful,
+ if for example, the main CMakeLists.txt file is not at the root of
+ the tree extracted by the tarball. If +HOST_LIBFOO_SUBDIR+ is not
+ specified, it defaults to +LIBFOO_SUBDIR+.
+
+* +LIBFOO_CONF_ENV+, to specify additional environment variables to
+ pass to CMake. By default, empty.
+
+* +LIBFOO_CONF_OPT+, to specify additional configure options to pass
+ to CMake. By default, empty.
+
+* +LIBFOO_MAKE+, to specify an alternate +make+ command. This is
+ typically useful when parallel make is enabled in the configuration
+ (using +BR2_JLEVEL+) but that this feature should be disabled for
+ the given package, for one reason or another. By default, set to
+ +$(MAKE)+. If parallel building is not supported by the package,
+ then it should be set to +LIBFOO_MAKE=$(MAKE1)+.
+
+* +LIBFOO_MAKE_ENV+, to specify additional environment variables to
+ pass to make in the build step. These are passed before the +make+
+ command. By default, empty.
+
+* +LIBFOO_MAKE_OPT+, to specify additional variables to pass to make
+ in the build step. These are passed after the +make+ command. By
+ default, empty.
+
+* +LIBFOO_INSTALL_STAGING_OPT+ contains the make options used to
+ install the package to the staging directory. By default, the value
+ is +DESTDIR=$$(STAGING_DIR) install+, which is correct for most
+ CMake packages. It is still possible to override it.
+
+* +LIBFOO_INSTALL_TARGET_OPT+ contains the make options used to
+ install the package to the target directory. By default, the value
+ is +DESTDIR=$$(TARGET_DIR) install+. The default value is correct
+ for most CMake packages, but it is still possible to override it if
+ needed.
+
+* +LIBFOO_CLEAN_OPT+ contains the make options used to clean the
+ package. By default, the value is +clean+.
+
+With the CMake infrastructure, all the steps required to build and
+install the packages are already defined, and they generally work well
+for most CMake-based packages. However, when required, it is still
+possible to customize what is done in any particular step:
+
+* By adding a post-operation hook (after extract, patch, configure,
+ build or install). See the reference documentation of the generic
+ infrastructure for details.
+
+* By overriding one of the steps. For example, even if the CMake
+ infrastructure is used, if the package +.mk+ file defines its own
+ +LIBFOO_CONFIGURE_CMDS+ variable, it will be used instead of the
+ default CMake one. However, using this method should be restricted
+ to very specific cases. Do not use it in the general case.
diff --git a/docs/manual/adding-packages-conclusion.txt b/docs/manual/adding-packages-conclusion.txt
new file mode 100644
index 0000000..3475827
--- /dev/null
+++ b/docs/manual/adding-packages-conclusion.txt
@@ -0,0 +1,10 @@
+Conclusion
+----------
+
+As you can see, adding a software package to Buildroot is simply a
+matter of writing a Makefile using an existing example and modifying it
+according to the compilation process required by the package.
+
+If you package software that might be useful for other people, don't
+forget to send a patch to Buildroot developers!
+
diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
new file mode 100644
index 0000000..4efffa6
--- /dev/null
+++ b/docs/manual/adding-packages-directory.txt
@@ -0,0 +1,76 @@
+Package directory
+-----------------
+
+First of all, create a directory under the +package+ directory for
+your software, for example +libfoo+.
+
+Some packages have been grouped by topic in a sub-directory:
++multimedia+, +java+, +x11r7+, and +games+. If your package fits in
+one of these categories, then create your package directory in these.
+
++Config.in+ file
+~~~~~~~~~~~~~~~~
+
+Then, create a file named +Config.in+. This file will contain the
+option descriptions related to our +libfoo+ software that will be used
+and displayed in the configuration tool. It should basically contain :
+
+---------------------------
+config BR2_PACKAGE_LIBFOO
+ bool "libfoo"
+ help
+ This is a comment that explains what libfoo is.
+
+ http://foosoftware.org/libfoo/
+---------------------------
+
+Of course, you can add other options to configure particular things in
+your software. You can look at examples in other packages. The syntax
+of the +Config.in+ file is the same as the one for the kernel Kconfig
+file. The documentation for this syntax is available at
+http://lxr.free-electrons.com/source/Documentation/kbuild/kconfig-language.txt[]
+
+Finally you have to add your new +libfoo/Config.in+ to
++package/Config.in+ (or in a category subdirectory if you decided to
+put your package in one of the existing categories). The files
+included there are 'sorted alphabetically' per category and are 'NOT'
+supposed to contain anything but the 'bare' name of the package.
+
+--------------------------
+source "package/libfoo/Config.in"
+--------------------------
+
+The +.mk+ file
+~~~~~~~~~~~~~~
+
+Finally, here's the hardest part. Create a file named +libfoo.mk+. It
+describes how the package should be downloaded, configured, built,
+installed, etc.
+
+Depending on the package type, the +.mk+ file must be written in a
+different way, using different infrastructures:
+
+* *Makefiles for generic packages* (not using autotools): These
+ are based on an infrastructure similar to the one used for
+ autotools-based packages, but requires a little more work from the
+ developer. They specify what should be done for the configuration,
+ compilation, installation and cleanup of the package. This
+ infrastructure must be used for all packages that do not use the
+ autotools as their build system. In the future, other specialized
+ infrastructures might be written for other build systems.
+ We cover them through in xref:gentargets-tutorial[] and
+ xref:gentargets-reference[].
+
+* *Makefiles for autotools-based software* (autoconf, automake,
+ etc.): We provide a dedicated infrastructure for such packages, since
+ autotools is a very common build system. This infrastructure <i>must
+ </i> be used for new packages that rely on the autotools as their
+ build system.<br/>We cover them through a
+ <a href="#autotools-tutorial">tutorial</a> and a
+ <a href="#autotools-reference">reference</a>.</li>
+
+* *Manual Makefiles:* These are currently obsolete, and no new
+ manual Makefiles should be added. However, since there are still
+ many of them in the tree, we keep them documented in a <a
+ href="#manual-tutorial">tutorial</a>.</li>
+
diff --git a/docs/manual/adding-packages-gentargets.txt b/docs/manual/adding-packages-gentargets.txt
new file mode 100644
index 0000000..36de3af
--- /dev/null
+++ b/docs/manual/adding-packages-gentargets.txt
@@ -0,0 +1,303 @@
+Infrastructure for packages with specific build systems
+-------------------------------------------------------
+
+By 'packages with specific build systems' we mean all the packages
+whose build system is not one of the standard ones, such as
+'autotools' or 'CMake'. This typically includes packages whose build
+system is based on hand-written Makefiles or shell scripts.
+
++GENTARGETS+ Tutorial
+~~~~~~~~~~~~~~~~~~~~~
+
+------------------------------
+01: #############################################################
+02: #
+03: # libfoo
+04: #
+05: #############################################################
+06: LIBFOO_VERSION = 1.0
+07: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
+08: LIBFOO_SITE = http://www.foosoftware.org/download
+09: LIBFOO_INSTALL_STAGING = YES
+10: LIBFOO_DEPENDENCIES = host-libaaa libbbb
+11:
+12: define LIBFOO_BUILD_CMDS
+13: $(MAKE) CC=$(TARGET_CC) LD=$(TARGET_LD) -C $(@D) all
+14: endef
+15:
+16: define LIBFOO_INSTALL_STAGING_CMDS
+17: $(INSTALL) -D -m 0755 $(@D)/libfoo.a $(STAGING_DIR)/usr/lib/libfoo.a
+18: $(INSTALL) -D -m 0644 $(@D)/foo.h $(STAGING_DIR)/usr/include/foo.h
+19: $(INSTALL) -D -m 0755 $(@D)/libfoo.so* $(STAGING_DIR)/usr/lib
+20: endef
+21:
+22: define LIBFOO_INSTALL_TARGET_CMDS
+23: $(INSTALL) -D -m 0755 $(@D)/libfoo.so* $(TARGET_DIR)/usr/lib
+24: $(INSTALL) -d -m 0755 $(TARGET_DIR)/etc/foo.d
+25: endef
+26:
+27: $(eval $(call GENTARGETS,package,libfoo))
+--------------------------------
+
+The Makefile begins on line 6 to 8 with metadata information: the
+version of the package (+LIBFOO_VERSION+), the name of the
+tarball containing the package (+LIBFOO_SOURCE+) and the
+Internet location at which the tarball can be downloaded
+(+LIBFOO_SITE+). All variables must start with the same prefix,
++LIBFOO_+ in this case. This prefix is always the uppercased
+version of the package name (see below to understand where the package
+name is defined).
+
+On line 9, we specify that this package wants to install something to
+the staging space. This is often needed for libraries, since they must
+install header files and other development files in the staging space.
+This will ensure that the commands listed in the
++LIBFOO_INSTALL_STAGING_CMDS+ variable will be executed.
+
+On line 10, we specify the list of dependencies this package relies
+on. These dependencies are listed in terms of lower-case package names,
+which can be packages for the target (without the +host-+
+prefix) or packages for the host (with the +host-+) prefix).
+Buildroot will ensure that all these packages are built and installed
+'before' the current package starts its configuration.
+
+The rest of the Makefile defines what should be done at the different
+steps of the package configuration, compilation and installation.
++LIBFOO_BUILD_CMDS+ tells what steps should be performed to
+build the package. +LIBFOO_INSTALL_STAGING_CMDS+ tells what
+steps should be performed to install the package in the staging space.
++LIBFOO_INSTALL_TARGET_CMDS+ tells what steps should be
+performed to install the package in the target space.
+
+All these steps rely on the +$(@D)+ variable, which
+contains the directory where the source code of the package has been
+extracted.
+
+Finally, on line 27, we call the +GENTARGETS+ which
+generates, according to the variables defined previously, all the
+Makefile code necessary to make your package working.
+
++GENTARGETS+ Reference
+~~~~~~~~~~~~~~~~~~~~~~
+
+The +GENTARGETS+ macro takes three arguments:
+
+* The first argument is the package directory prefix. If your package
+ is in +package/libfoo+, then the directory prefix is +package+. If
+ your package is in +package/editors/foo+, then the directory prefix
+ must be +package/editors+.
+
+* The second argument is the lower-cased package name. It must match
+ the prefix of the variables in the +.mk+ file and must match the
+ configuration option name in the +Config.in+ file. For example, if
+ the package name is +libfoo+, then the variables in the +.mk+ file
+ must start with +LIBFOO_+ and the configuration option in the
+ +Config.in+ file must be +BR2_PACKAGE_LIBFOO+.
+
+* The third argument is optional. It can be used to tell if the
+ package is a target package (cross-compiled for the target) or a
+ host package (natively compiled for the host). If unspecified, it is
+ assumed that it is a target package. See below for details.
+
+For a given package, in a single +.mk+ file, it is possible to call
+GENTARGETS twice, once to create the rules to generate a target
+package and once to create the rules to generate a host package:
+
+----------------------
+$(eval $(call GENTARGETS,package,libfoo))
+$(eval $(call GENTARGETS,package,libfoo,host))
+----------------------
+
+This might be useful if the compilation of the target package requires
+some tools to be installed on the host. If the package name is
++libfoo+, then the name of the package for the target is also
++libfoo+, while the name of the package for the host is
++host-libfoo+. These names should be used in the DEPENDENCIES
+variables of other packages, if they depend on +libfoo+ or
++host-libfoo+.
+
+The call to the +GENTARGETS+ macro *must* be at the end of the +.mk+
+file, after all variable definitions.
+
+For the target package, the +GENTARGETS+ uses the variables defined by
+the .mk file and prefixed by the uppercased package name:
++LIBFOO_*+. For the host package, it uses the +HOST_LIBFOO_*+. For
+'some' variables, if the +HOST_LIBFOO_+ prefixed variable doesn't
+exist, the package infrastructure uses the corresponding variable
+prefixed by +LIBFOO_+. This is done for variables that are likely to
+have the same value for both the target and host packages. See below
+for details.
+
+The list of variables that can be set in a +.mk+ file to give metadata
+information is (assuming the package name is +libfoo+) :
+
+* +LIBFOO_VERSION+, mandatory, must contain the version of the
+ package. Note that if +HOST_LIBFOO_VERSION+ doesn't exist, it is
+ assumed to be the same as +LIBFOO_VERSION+. It can also be a
+ Subversion or Git branch or tag, for packages that are fetched
+ directly from their revision control system. +
+ Example: +LIBFOO_VERSION = 0.1.2+
+
+* +LIBFOO_SOURCE+ may contain the name of the tarball of
+ the package. If +HOST_LIBFOO_SOURCE+ is not specified, it
+ defaults to +LIBFOO_VERSION+. If none are specified, then
+ the value is assumed to be
+ +packagename-$(LIBFOO_VERSION).tar.gz+. +
+ Example: +LIBFOO_SOURCE = foobar-$(LIBFOO_VERSION).tar.bz2+
+
+* +LIBFOO_PATCH+ may contain the name of a patch, that will be
+ downloaded from the same location as the tarball indicated in
+ +LIBFOO_SOURCE+. If +HOST_LIBFOO_PATCH+ is not specified, it
+ defaults to +LIBFOO_PATCH+. Also note that another mechanism is
+ available to patch a package: all files of the form
+ +packagename-packageversion-description.patch+ present in the
+ package directory inside Buildroot will be applied to the package
+ after extraction.
+
+* +LIBFOO_SITE+ may contain the Internet location of the package. It
+ can either be the HTTP or FTP location of a tarball, or the URL of a
+ Git or Subversion repository (see +LIBFOO_SITE_METHOD+ below). If
+ +HOST_LIBFOO_SITE+ is not specified, it defaults to
+ +LIBFOO_SITE+. If none are specified, then the location is assumed
+ to be
+ +http://$$(BR2_SOURCEFORGE_MIRROR).dl.sourceforge.net/sourceforge/packagename+. +
+ Examples: +LIBFOO_SITE=http://www.libfoosoftware.org/libfoo+ +
+ +LIBFOO_SITE=http://svn.xiph.org/trunk/Tremor/+
+
+* +LIBFOO_SITE_METHOD+ may contain the method to fetch the package
+ source code. It can either be +wget+ (for normal FTP/HTTP downloads
+ of tarballs), +svn+, +git+ or +bzr+. When not specified, it is
+ guessed from the URL given in +LIBFOO_SITE+: +svn://+, +git://+ and
+ +bzr://+ URLs will use the +svn+, +git+ and +bzr+ methods
+ respectively. All other URL-types will use the +wget+ method. So for
+ example, in the case of a package whose source code is available
+ through Subversion repository on HTTP, one 'must' specifiy
+ +LIBFOO_SITE_METHOD=svn+. For +svn+ and +git+ methods, what
+ Buildroot does is a checkout/clone of the repository which is then
+ tarballed and stored into the download cache. Next builds will not
+ checkout/clone again, but will use the tarball directly. When
+ +HOST_LIBFOO_SITE_METHOD+ is not specified, it defaults to the value
+ of +LIBFOO_SITE_METHOD+. See +package/multimedia/tremor/+ for an
+ example.
+
+* +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package
+ name) that are required for the current target package to
+ compile. These dependencies are guaranteed to be compiled and
+ installed before the configuration of the current package starts. In
+ a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependency for
+ the current host package.
+
+* +LIBFOO_INSTALL_STAGING+ can be set to +YES+ or +NO+ (default). If
+ set to +YES+, then the commands in the +LIBFOO_INSTALL_STAGING_CMDS+
+ variables are executed to install the package into the staging
+ directory.
+
+* +LIBFOO_INSTALL_TARGET+ can be set to +YES+ (default) or +NO+. If
+ set to +YES+, then the commands in the +LIBFOO_INSTALL_TARGET_CMDS+
+ variables are executed to install the package into the target
+ directory.
+
+The recommended way to define these variables is to use the following
+syntax:
+
+----------------------
+LIBFOO_VERSION = 2.32
+----------------------
+
+Now, the variables that define what should be performed at the
+different steps of the build process.
+
+* +LIBFOO_CONFIGURE_CMDS+, used to list the actions to be performed to
+ configure the package before its compilation
+
+* +LIBFOO_BUILD_CMDS+, used to list the actions to be performed to
+ compile the package
+
+* +HOST_LIBFOO_INSTALL_CMDS+, used to list the actions to be performed
+ to install the package, when the package is a host package. The
+ package must install its files to the directory given by
+ +$(HOST_DIR)+. All files, including development files such as
+ headers should be installed, since other packages might be compiled
+ on top of this package.
+
+* +LIBFOO_INSTALL_TARGET_CMDS+, used to list the actions to be
+ performed to install the package to the target directory, when the
+ package is a target package. The package must install its files to
+ the directory given by +$(TARGET_DIR)+. Only the files required for
+ 'documentation' and 'execution' of the package should be
+ installed. Header files should not be installed, they will be copied
+ to the target, if the +development files in target filesystem+
+ option is selected.
+
+* +LIBFOO_INSTALL_STAGING_CMDS+, used to list the actions to be
+ performed to install the package to the staging directory, when the
+ package is a target package. The package must install its files to
+ the directory given by +$(STAGING_DIR)+. All development files
+ should be installed, since they might be needed to compile other
+ packages.
+
+* +LIBFOO_CLEAN_CMDS+, used to list the actions to perform to clean up
+ the build directory of the package.
+
+* +LIBFOO_UNINSTALL_TARGET_CMDS+, used to list the actions to
+ uninstall the package from the target directory +$(TARGET_DIR)+
+
+* +LIBFOO_UNINSTALL_STAGING_CMDS+, used to list the actions to
+ uninstall the package from the staging directory +$(STAGING_DIR)+.
+
+The preferred way to define these variables is:
+
+----------------------
+define LIBFOO_CONFIGURE_CMDS
+ action 1
+ action 2
+ action 3
+endef
+----------------------
+
+In the action definitions, you can use the following variables:
+
+* +$(@D)+, which contains the directory in which the package source
+ code has been uncompressed.
+
+* +$(TARGET_CC)+, +$(TARGET_LD)+, etc. to get the target
+ cross-compilation utilities
+
+* +$(TARGET_CROSS)+ to get the cross-compilation toolchain prefix
+
+* Of course the +$(HOST_DIR)+, +$(STAGING_DIR)+ and +$(TARGET_DIR)+
+ variables to install the packages properly.
+
+The last feature of the generic infrastructure is the ability to add
+hooks. These define further actions to perform after existing steps.
+Most hooks aren't really useful for generic packages, since the +.mk+
+file already has full control over the actions performed in each step
+of the package construction. The hooks are more useful for packages
+using the autotools infrastructure described below. However, since
+they are provided by the generic infrastructure, they are documented
+here. The exception is +LIBFOO_POST_PATCH_HOOKS+. Patching the
+package is not user definable, so +LIBFOO_POST_PATCH_HOOKS+ will be
+userful for generic packages.
+
+The following hook points are available:
+
+* +LIBFOO_POST_PATCH_HOOKS+
+* +LIBFOO_PRE_CONFIGURE_HOOKS+
+* +LIBFOO_POST_CONFIGURE_HOOKS+
+* +LIBFOO_POST_BUILD_HOOKS+
+* +LIBFOO_POST_INSTALL_HOOKS+ (for host packages only)
+* +LIBFOO_POST_INSTALL_STAGING_HOOKS+ (for target packages only)
+* +LIBFOO_POST_INSTALL_TARGET_HOOKS+ (for target packages only)
+
+These variables are 'lists' of variable names containing actions to be
+performed at this hook point. This allows several hooks to be
+registered at a given hook point. Here is an example:
+
+----------------------
+define LIBFOO_POST_PATCH_FIXUP
+ action1
+ action2
+endef
+
+LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP
+----------------------
diff --git a/docs/manual/adding-packages-gettext.txt b/docs/manual/adding-packages-gettext.txt
new file mode 100644
index 0000000..1ed834e
--- /dev/null
+++ b/docs/manual/adding-packages-gettext.txt
@@ -0,0 +1,44 @@
+Gettext integration and interaction with packages
+-------------------------------------------------
+
+Many packages that support internationalization use the gettext
+library. Dependencies for this library are fairly complicated and
+therefore, deserves some explanation.
+
+The 'uClibc' C library doesn't implement gettext functionality,
+therefore with this C library, a separate gettext must be compiled. On
+the other hand, the 'glibc' C library does integrate its own gettext,
+and in this case, the separate gettext library should not be compiled,
+because it creates various kinds of build failures.
+
+Additionally, some packages (such as +libglib2+) do require gettext
+unconditionally, while other packages (those who support
++--disable-nls+ in general) only require gettext when locale support
+is enabled.
+
+Therefore, Buildroot defines two configuration options:
+
+* +BR2_NEEDS_GETTEXT+, which is true as soon as the toolchain doesn't
+ provide its own gettext implementation
+
+* +BR2_NEEDS_GETTEXT_IF_LOCALE+, which is true if the toolchain
+ doesn't provide its own gettext implementation and if locale support
+ is enabled
+
+Therefore, packages that unconditionally need gettext should:
+
+* Use +select BR2_PACKAGE_GETTEXT if BR2_NEEDS_GETTEXT+ and possibly
+ +select BR2_PACKAGE_LIBINTL if BR2_NEEDS_GETTEXT+, if libintl is
+ also needed
+
+* Use +$(if $(BR2_NEEDS_GETTEXT),gettext)+ in the package
+ +DEPENDENCIES+ variable
+
+Packages that need gettext only when locale support is enabled should:
+
+* Use +select BR2_PACKAGE_GETTEXT if BR2_NEEDS_GETTEXT_IF_LOCALE+ and
+ possibly +select BR2_PACKAGE_LIBINTL if
+ BR2_NEEDS_GETTEXT_IF_LOCALE+, if libintl is also needed
+
+* Use +$(if $(BR2_NEEDS_GETTEXT_IF_LOCALE),gettext)+ in the package
+ +DEPENDENCIES+ variable
diff --git a/docs/manual/adding-packages-handwritten.txt b/docs/manual/adding-packages-handwritten.txt
new file mode 100644
index 0000000..357bd0e
--- /dev/null
+++ b/docs/manual/adding-packages-handwritten.txt
@@ -0,0 +1,165 @@
+Manual Makefile
+---------------
+
+*NOTE: new manual makefiles should not be created, and existing manual
+makefiles should be converted either to the generic, autotools or
+cmake infrastructure. This section is only kept to document the
+existing manual makefiles and to help understand how they work.*
+
+------------------------
+01: #############################################################
+02: #
+03: # libfoo
+04: #
+05: #############################################################
+06: LIBFOO_VERSION:=1.0
+07: LIBFOO_SOURCE:=libfoo-$(LIBFOO_VERSION).tar.gz
+08: LIBFOO_SITE:=http://www.foosoftware.org/downloads
+09: LIBFOO_DIR:=$(BUILD_DIR)/foo-$(FOO_VERSION)
+10: LIBFOO_BINARY:=foo
+11: LIBFOO_TARGET_BINARY:=usr/bin/foo
+12:
+13: $(DL_DIR)/$(LIBFOO_SOURCE):
+14: $(call DOWNLOAD,$(LIBFOO_SITE),$(LIBFOO_SOURCE))
+15:
+16: $(LIBFOO_DIR)/.source: $(DL_DIR)/$(LIBFOO_SOURCE)
+17: $(ZCAT) $(DL_DIR)/$(LIBFOO_SOURCE) | tar -C $(BUILD_DIR) $(TAR_OPTIONS) -
+18: touch $@
+19:
+20: $(LIBFOO_DIR)/.configured: $(LIBFOO_DIR)/.source
+21: (cd $(LIBFOO_DIR); rm -rf config.cache; \
+22: $(TARGET_CONFIGURE_OPTS) \
+23: $(TARGET_CONFIGURE_ARGS) \
+24: ./configure \
+25: --target=$(GNU_TARGET_NAME) \
+26: --host=$(GNU_TARGET_NAME) \
+27: --build=$(GNU_HOST_NAME) \
+28: --prefix=/usr \
+29: --sysconfdir=/etc \
+30: )
+31: touch $@
+32:
+33: $(LIBFOO_DIR)/$(LIBFOO_BINARY): $(LIBFOO_DIR)/.configured
+34: $(MAKE) CC=$(TARGET_CC) -C $(LIBFOO_DIR)
+35:
+36: $(TARGET_DIR)/$(LIBFOO_TARGET_BINARY): $(LIBFOO_DIR)/$(LIBFOO_BINARY)
+37: $(MAKE) DESTDIR=$(TARGET_DIR) -C $(LIBFOO_DIR) install-strip
+38: rm -Rf $(TARGET_DIR)/usr/man
+39:
+40: libfoo: uclibc ncurses $(TARGET_DIR)/$(LIBFOO_TARGET_BINARY)
+41:
+42: libfoo-source: $(DL_DIR)/$(LIBFOO_SOURCE)
+43:
+44: libfoo-clean:
+45: $(MAKE) prefix=$(TARGET_DIR)/usr -C $(LIBFOO_DIR) uninstall
+46: -$(MAKE) -C $(LIBFOO_DIR) clean
+47:
+48: libfoo-dirclean:
+49: rm -rf $(LIBFOO_DIR)
+50:
+51: #############################################################
+52: #
+53: # Toplevel Makefile options
+54: #
+55: #############################################################
+56: ifeq ($(BR2_PACKAGE_LIBFOO),y)
+57: TARGETS+=libfoo
+58: endif
+------------------------
+
+First of all, this Makefile example works for a package which
+comprises a single binary executable. For other software, such as
+libraries or more complex stuff with multiple binaries, it must be
+qqadapted. For examples look at the other +*.mk+ files in the
++package+ directory.
+
+At lines 6-11, a couple of useful variables are defined:
+
+* +LIBFOO_VERSION+: The version of 'libfoo' that should be downloaded.
+
+* +LIBFOO_SOURCE+: The name of the tarball of 'libfoo' on the download
+ website or FTP site. As you can see +LIBFOO_VERSION+ is used.
+
+* +LIBFOO_SITE+: The HTTP or FTP site from which 'libfoo' archive is
+ downloaded. It must include the complete path to the directory where
+ +LIBFOO_SOURCE+ can be found.
+
+* +LIBFOO_DIR+: The directory into which the software will be
+ configured and compiled. Basically, it's a subdirectory of
+ +BUILD_DIR+ which is created upon decompression of the tarball.
+
+* +LIBFOO_BINARY+: Software binary name. As said previously, this is
+ an example for a package with a single binary.
+
+* +LIBFOO_TARGET_BINARY+: The full path of the binary inside the
+ target filesystem. Lines 13-14 define a target that downloads the
+ tarball from the remote site to the download directory (+DL_DIR+).
+
+Lines 16-18 define a target and associated rules that uncompress the
+downloaded tarball. As you can see, this target depends on the tarball
+file so that the previous target (lines 13-14) is called before
+executing the rules of the current target. Uncompressing is followed
+by 'touching' a hidden file to mark the software as having been
+uncompressed. This trick is used everywhere in a Buildroot Makefile to
+split steps (download, uncompress, configure, compile, install) while
+still having correct dependencies.
+
+Lines 20-31 define a target and associated rules that configure the
+software. It depends on the previous target (the hidden +.source+
+file) so that we are sure the software has been uncompressed. In order
+to configure the package, it basically runs the well-known
++./configure+ script. As we may be doing cross-compilation, +target+,
++host+ and +build+ arguments are given. The prefix is also set to
++/usr+, not because the software will be installed in +/usr+ on your
+host system, but because the software will be installed in + /usr+ on
+the target filesystem. Finally it creates a +.configured+ file to mark
+the software as configured.
+
+Lines 33-34 define a target and a rule that compile the software. This
+target will create the binary file in the compilation directory and
+depends on the software being already configured (hence the reference
+to the +.configured+ file). It basically runs +make+ inside the
+source directory.
+
+Lines 36-38 define a target and associated rules that install the
+software inside the target filesystem. They depend on the binary file
+in the source directory to make sure the software has been
+compiled. They use the +install-strip+ target of the software
++Makefile+ by passing a +DESTDIR+ argument so that the +Makefile+
+doesn't try to install the software in the host +/usr+ but rather in
+the target +/usr+. After the installation, the +/usr/man + directory
+inside the target filesystem is removed to save space.
+
+Line 40 defines the main target of the software — the one that
+will eventually be used by the top level +Makefile+ to download,
+compile, and then install this package. This target should first of
+all depend on all needed dependencies of the software (in our example,
+'uclibc' and 'ncurses') and also depend on the final binary. This last
+dependency will call all previous dependencies in the correct order.
+
+Line 42 defines a simple target that only downloads the code
+source. This is not used during normal operation of Buildroot, but is
+needed if you intend to download all required sources at once for
+later offline build. Note that if you add a new package, providing a
++libfoo-source+ target is 'mandatory' to support users that wish to do
+offline-builds. Furthermore, it eases checking if all package-sources
+are downloadable.
+
+Lines 44-46 define a simple target to clean the software build by
+calling the Makefile with the appropriate options. The +-clean+
+target should run +make clean+ on $(BUILD_DIR)/package-version and
+MUST uninstall all files of the package from $(STAGING_DIR) and from
+$(TARGET_DIR).
+
+Lines 48-49 define a simple target to completely remove the directory
+in which the software was uncompressed, configured and compiled. The
++-dirclean+ target MUST completely rm $(BUILD_DIR)/ package-version.
+
+Lines 51-58 add the target +libfoo+ to the list of targets to be
+compiled by Buildroot, by first checking if the configuration option
+for this package has been enabled using the configuration tool. If so,
+it then "subscribes" this package to be compiled by adding
+the package to the TARGETS global variable. The name added to the
+TARGETS global variable is the name of this package's target, as
+defined on line 40, which is used by Buildroot to download, compile,
+and then install this package.
diff --git a/docs/manual/adding-packages.txt b/docs/manual/adding-packages.txt
new file mode 100644
index 0000000..0217e9f
--- /dev/null
+++ b/docs/manual/adding-packages.txt
@@ -0,0 +1,21 @@
+Adding new packages to Buildroot
+================================
+
+This section covers how new packages (userspace libraries or
+applications) can be integrated into Buildroot. It also shows how
+existing packages are integrated, which is needed for fixing issues or
+tuning their configuration.
+
+include::adding-packages-directory.txt[]
+
+include::adding-packages-gentargets.txt[]
+
+include::adding-packages-autotargets.txt[]
+
+include::adding-packages-cmaketargets.txt[]
+
+include::adding-packages-handwritten.txt[]
+
+include::adding-packages-gettext.txt[]
+
+include::adding-packages-conclusion.txt[]
diff --git a/docs/manual/board-support.txt b/docs/manual/board-support.txt
new file mode 100644
index 0000000..d1d9d63
--- /dev/null
+++ b/docs/manual/board-support.txt
@@ -0,0 +1,35 @@
+Creating your own board support
+===============================
+
+Creating your own board support in Buildroot allows users of a
+particular hardware platform to easily build a system that is known to
+work.
+
+To do so, you need to create a normal Buildroot configuration that
+builds a basic system for the hardware: toolchain, kernel, bootloader,
+filesystem and a simple Busybox-only userspace. No specific package
+should be selected: the configuration should be as minimal as
+possible, and should only build a working basic Busybox system for the
+target platform. You can of course use more complicated configurations
+for your internal projects, but the Buildroot project will only
+integrate basic board configurations. This is because package
+selections are highly application-specific.
+
+Once you have a known working configuration, run +make
+savedefconfig+. This will generate a minimal +defconfig+ file at the
+root of the Buildroot source tree. Move this file into the +configs/+
+directory, and rename it +MYBOARD_defconfig+.
+
+It is recommended to use as much as possible upstream versions of the
+Linux kernel and bootloaders, and to use as much as possible default
+kernel and bootloader configurations. If they are incorrect for your
+platform, we encourage you to send fixes to the corresponding upstream
+projects.
+
+However, in the mean time, you may want to store kernel or bootloader
+configuration or patches specific to your target platform. To do so,
+create a directory +board/MANUFACTURER+ and a subdirectory
++board/MANUFACTURER/BOARDNAME+ (after replacing, of course,
+MANUFACTURER and BOARDNAME with the appropriate values, in lower case
+letters). You can then store your patches and configurations in these
+directories, and reference them from the main Buildroot configuration.
diff --git a/docs/manual/ccache-support.txt b/docs/manual/ccache-support.txt
new file mode 100644
index 0000000..ab8cbad
--- /dev/null
+++ b/docs/manual/ccache-support.txt
@@ -0,0 +1,21 @@
+Using +ccache+ in Buildroot
+===========================
+
+http://ccache.samba.org[ccache] is a compiler cache. It stores the
+object files resulting from each compilation process, and is able to
+skip future compilation of the same source file (with same compiler
+and same arguments) by using the pre-existing object files. When doing
+almost identical builds from scratch a number of times, it can nicely
+speed up the build process.
+
++ccache+ support is integrated in Buildroot. You just have to enable
++Enable compiler cache+ in +Build options+. This will automatically
+build +ccache+ and use it for every host and target compilation.
+
+The cache is located in +$HOME/.buildroot-ccache+. It is stored
+outside of Buildroot output directory so that it can be shared by
+separate Buildroot builds. If you want to get rid of the cache, simply
+remove this directory.
+
+You can get statistics on the cache (its size, number of hits,
+misses, etc.) by running +make ccache-stats+.
diff --git a/docs/manual/customize-busybox-config.txt b/docs/manual/customize-busybox-config.txt
new file mode 100644
index 0000000..60e6a55
--- /dev/null
+++ b/docs/manual/customize-busybox-config.txt
@@ -0,0 +1,24 @@
+Customizing the Busybox configuration
+-------------------------------------
+[[busybox-custom]]
+
+http://www.busybox.net/[Busybox] is very configurable, and you may
+want to customize it. You can follow these simple steps to do so. This
+method isn't optimal, but it's simple, and it works:
+
+* Do an initial compilation of Buildroot, with busybox, without
+ trying to customize it.
+
+* Invoke +make busybox-menuconfig+.
+ The nice configuration tool appears, and you can
+ customize everything.
+
+* Run the compilation of Buildroot again.
+
+Otherwise, you can simply change the
++package/busybox/busybox-<version>.config+ file, if you know the
+options you want to change, without using the configuration tool.
+
+If you want to use an existing config file for busybox, then see
+section xref:env-vars[].
+
diff --git a/docs/manual/customize-kernel-config.txt b/docs/manual/customize-kernel-config.txt
new file mode 100644
index 0000000..6bafe46
--- /dev/null
+++ b/docs/manual/customize-kernel-config.txt
@@ -0,0 +1,12 @@
+Customizing the Linux kernel configuration
+------------------------------------------
+
+The Linux kernel configuration can be customized just like
+xref:busybox-custom[BusyBox] and xref:uclibc-custom[uClibc] using
++make linux-menuconfig+. Make sure you have enabled the kernel build
+in +make menuconfig+ first. Once done, run +make+ to (re)build
+everything.
+
+If you want to use an existing config file for Linux, then see
+xref:env-vars[].
+
diff --git a/docs/manual/customize-rootfs.txt b/docs/manual/customize-rootfs.txt
new file mode 100644
index 0000000..cf3ca6c
--- /dev/null
+++ b/docs/manual/customize-rootfs.txt
@@ -0,0 +1,36 @@
+Customizing the generated target filesystem
+-------------------------------------------
+
+There are a few ways to customize the resulting target filesystem:
+
+* Customize the target filesystem directly and rebuild the image. The
+ target filesystem is available under +output/target/+. You can
+ simply make your changes here and run make afterwards - this will
+ rebuild the target filesystem image. This method allows you to do
+ anything to the target filesystem, but if you decide to completely
+ rebuild your toolchain and tools, these changes will be lost.
+
+* Create your own 'target skeleton'. You can start with the default
+ skeleton available under +fs/skeleton+ and then customize it to suit
+ your needs. The +BR2_ROOTFS_SKELETON_CUSTOM+ and
+ +BR2_ROOTFS_SKELETON_CUSTOM_PATH+ will allow you to specify the
+ location of your custom skeleton. At build time, the contents of the
+ skeleton are copied to output/target before any package
+ installation.
+
+* In the Buildroot configuration, you can specify the path to a
+ post-build script, that gets called 'after' Buildroot builds all the
+ selected software, but 'before' the rootfs packages are
+ assembled. The destination root filesystem folder is given as the
+ first argument to this script, and this script can then be used to
+ copy programs, static data or any other needed file to your target
+ filesystem.<br/>You should, however, use this feature with care.
+ Whenever you find that a certain package generates wrong or unneeded
+ files, you should fix that package rather than work around it with a
+ post-build cleanup script.
+
+* A special package, 'customize', stored in +package/customize+ can be
+ used. You can put all the files that you want to see in the final
+ target root filesystem in +package/customize/source+, and then
+ enable this special package in the configuration system.
+
diff --git a/docs/manual/customize-uclibc-config.txt b/docs/manual/customize-uclibc-config.txt
new file mode 100644
index 0000000..e2e6799
--- /dev/null
+++ b/docs/manual/customize-uclibc-config.txt
@@ -0,0 +1,32 @@
+Customizing the uClibc configuration
+------------------------------------
+[[uclibc-custom]]
+
+Just like xref:busybox-custom[BusyBox], http://www.uclibc.org/[uClibc]
+offers a lot of configuration options. They allow you to select
+various functionalities depending on your needs and limitations.
+
+The easiest way to modify the configuration of uClibc is to
+follow these steps:
+
+* Do an initial compilation of Buildroot without trying to customize
+ uClibc.
+
+* Invoke +make uclibc-menuconfig+. The nice configuration assistant,
+ similar to the one used in the Linux kernel or Buildroot,
+ appears. Make your configuration changes as appropriate.
+
+* Copy the +$(O)/toolchain/uclibc-VERSION/.config+ file to a different
+ place (like +toolchain/uClibc/uClibc-myconfig.config+, or
+ +board/mymanufacturer/myboard/uClibc.config+) and adjust the uClibc
+ configuration (configuration option +BR2_UCLIBC_CONFIG+) to use this
+ configuration instead of the default one.
+
+* Run the compilation of Buildroot again.
+
+Otherwise, you can simply change +toolchain/uClibc/uClibc.config+,
+without running the configuration assistant.
+
+If you want to use an existing config file for uclibc, then see
+xref:env-vars[].
+
diff --git a/docs/manual/customize.txt b/docs/manual/customize.txt
new file mode 100644
index 0000000..c9f4dfd
--- /dev/null
+++ b/docs/manual/customize.txt
@@ -0,0 +1,10 @@
+Customization
+=============
+
+include::customize-rootfs.txt[]
+
+include::customize-busybox-config.txt[]
+
+include::customize-uclibc-config.txt[]
+
+include::customize-kernel-config.txt[]
diff --git a/docs/manual/download-location.txt b/docs/manual/download-location.txt
new file mode 100644
index 0000000..cb6147f
--- /dev/null
+++ b/docs/manual/download-location.txt
@@ -0,0 +1,26 @@
+Location of downloaded packages
+===============================
+
+It might be useful to know that the various tarballs that are
+downloaded by the Makefiles are all stored in the +DL_DIR+ which by
+default is the +dl+ directory. It's useful, for example, if you want
+to keep a complete version of Buildroot which is known to be working
+with the associated tarballs. This will allow you to regenerate the
+toolchain and the target filesystem with exactly the same versions.
+
+If you maintain several Buildroot trees, it might be better to have a
+shared download location. This can be accessed by creating a symbolic
+link from the +dl+ directory to the shared download location:
+
+-----------------
+ $ ln -s <shared download location> dl
+-----------------
+
+Another way of accessing a shared download location is to create the
++BUILDROOT_DL_DIR+ environment variable. If this is set, then the
+value of DL_DIR in the project is overridden. The following line
+should be added to +<~/.bashrc>+.
+
+-----------------
+ $ export BUILDROOT_DL_DIR <shared download location>
+-----------------
diff --git a/docs/manual/external-toolchain.txt b/docs/manual/external-toolchain.txt
new file mode 100644
index 0000000..3a5b011
--- /dev/null
+++ b/docs/manual/external-toolchain.txt
@@ -0,0 +1,84 @@
+Using an external toolchain
+===========================
+
+Using an already existing toolchain is useful for different
+reasons:
+
+* you already have a toolchain that is known to work for your specific
+ CPU
+
+* you want to speed up the Buildroot build process by skipping the
+ long toolchain build part
+
+* the toolchain generation feature of Buildroot is not sufficiently
+ flexible for you (for example if you need to generate a system with
+ 'glibc' instead of 'uClibc')
+
+Buildroot supports using existing toolchains through a mechanism
+called 'external toolchain'. The external toolchain mechanism is
+enabled in the +Toolchain+ menu, by selecting +External toolchain+ in
++Toolchain type+.
+
+Then, you have three solutions to use an external toolchain:
+
+* Use a predefined external toolchain profile, and let Buildroot
+ download, extract and install the toolchain. Buildroot already knows
+ about a few CodeSourcery toolchains for ARM, PowerPC, MIPS and
+ SuperH. Just select the toolchain profile in +Toolchain+ through the
+ available ones. This is definitely the easiest solution.
+
+* Use a predefined external toolchain profile, but instead of having
+ Buildroot download and extract the toolchain, you can tell Buildroot
+ where your toolchain is already installed on your system. Just
+ select the toolchain profile in +Toolchain+ through the available
+ ones, unselect +Download toolchain automatically+, and fill the
+ +Toolchain path+ text entry with the path to your cross-compiling
+ toolchain.
+
+* Use a completely custom external toolchain. This is particularly
+ useful for toolchains generated using Crosstool-NG. To do this,
+ select the +Custom toolchain+ solution in the +Toolchain+ list. You
+ need to fill the +Toolchain path+, +Toolchain prefix+ and +External
+ toolchain C library+ options. Then, you have to tell Buildroot what
+ your external toolchain supports. If your external toolchain uses
+ the 'glibc' library, you only have to tell whether your toolchain
+ supports C++ or not. If your external toolchain uses the 'uclibc'
+ library, then you have to tell Buildroot if it supports largefile,
+ IPv6, RPC, wide-char, locale, program invocation, threads and
+ C++. At the beginning of the execution, Buildroot will tell you if
+ the selected options do not match the toolchain configuration.
+
+
+Our external toolchain support has been tested with toolchains from
+CodeSourcery, toolchains generated by
+http://ymorin.is-a-geek.org/dokuwiki/projects/crosstool[Crosstool-NG],
+and toolchains generated by Buildroot itself. In general, all
+toolchains that support the 'sysroot' feature should work. If not, do
+not hesitate to contact the developers.
+
+We do not support toolchains from the
+http://www.denx.de/wiki/DULG/ELDK[ELDK] of Denx, for two reasons:
+
+* The ELDK does not contain a pure toolchain (i.e just the compiler,
+ binutils, the C and C++ libraries), but a toolchain that comes with
+ a very large set of pre-compiled libraries and programs. Therefore,
+ Buildroot cannot import the 'sysroot' of the toolchain, as it would
+ contain hundreds of megabytes of pre-compiled libraries that are
+ normally built by Buildroot.
+
+* The ELDK toolchains have a completely non-standard custom mechanism
+ to handle multiple library variants. Instead of using the standard
+ GCC 'multilib' mechanism, the ARM ELDK uses different symbolic links
+ to the compiler to differentiate between library variants (for ARM
+ soft-float and ARM VFP), and the PowerPC ELDK compiler uses a
+ +CROSS_COMPILE+ environment variable. This non-standard behaviour
+ makes it difficult to support ELDK in Buildroot.
+
+We also do not support using the distribution toolchain (i.e the
+gcc/binutils/C library installed by your distribution) as the
+toolchain to build software for the target. This is because your
+distribution toolchain is not a "pure" toolchain (i.e only with the
+C/C++ library), so we cannot import it properly into the Buildroot
+build environment. So even if you are building a system for a x86 or
+x86_64 target, you have to generate a cross-compilation toolchain with
+Buildroot or Crosstool-NG.
diff --git a/docs/manual/getting.txt b/docs/manual/getting.txt
new file mode 100644
index 0000000..42ca009
--- /dev/null
+++ b/docs/manual/getting.txt
@@ -0,0 +1,23 @@
+Getting Buildroot
+=================
+
+Buildroot releases are made approximately every 3 months. Direct Git
+access and daily snapshots are also available, if you want more
+bleeding edge.
+
+Releases are available at http://buildroot.net/downloads/[].
+
+The latest snapshot is always available at
+http://buildroot.net/downloads/snapshots/buildroot-snapshot.tar.bz2[],
+and previous snapshots are also available at
+http://buildroot.net/downloads/snapshots/[].
+
+To download Buildroot using Git, you can simply follow the rules
+described on the "Accessing Git" page
+(http://buildroot.net/git.html[]) of the Buildroot website
+(http://buildroot.net[]). For the impatient, here's a quick recipe:
+
+---------------------
+ $ git clone git://git.buildroot.net/buildroot
+---------------------
+
diff --git a/docs/manual/how-buildroot-works.txt b/docs/manual/how-buildroot-works.txt
new file mode 100644
index 0000000..481e5a4
--- /dev/null
+++ b/docs/manual/how-buildroot-works.txt
@@ -0,0 +1,59 @@
+How Buildroot works
+===================
+
+As mentioned above, Buildroot is basically a set of Makefiles that
+download, configure, and compile software with the correct options. It
+also includes patches for various software packages - mainly the ones
+involved in the cross-compilation tool chain (+gcc+, +binutils+ and
++uClibc+).
+
+There is basically one Makefile per software package, and they are
+named with the +.mk+ extension. Makefiles are split into three main
+sections:
+
+* *toolchain* (in the +toolchain/+ directory) contains the Makefiles
+ and associated files for all software related to the
+ cross-compilation toolchain: +binutils+, +gcc+, +gdb+,
+ +kernel-headers+ and +uClibc+.
+
+* *package* (in the +package/+ directory) contains the Makefiles and
+ associated files for all user-space tools that Buildroot can compile
+ and add to the target root filesystem. There is one sub-directory
+ per tool.
+
+* *target* (in the +target+ directory) contains the Makefiles and
+ associated files for software related to the generation of the
+ target root filesystem image. Four types of filesystems are
+ supported: ext2, jffs2, cramfs and squashfs. For each of them there
+ is a sub-directory with the required files. There is also a
+ +default/+ directory that contains the target filesystem skeleton.
+
+Each directory contains at least 2 files:
+
+* +something.mk+ is the Makefile that downloads, configures,
+ compiles and installs the package +something+.
+
+* +Config.in+ is a part of the configuration tool
+ description file. It describes the options related to the
+ package.
+
+The main Makefile performs the following steps (once the
+configuration is done):
+
+* Create all the output directories: +staging+, +target+, +build+,
+ +stamps+, etc. in the output directory (+output/+ by default,
+ another value can be specified using +O=+)
+
+* Generate all the targets listed in the +BASE_TARGETS+ variable. When
+ an internal toolchain is used, this means generating the
+ cross-compilation toolchain. When an external toolchain is used,
+ this means checking the features of the external toolchain and
+ importing it into the Buildroot environment.
+
+* Generate all the targets listed in the +TARGETS+ variable. This
+ variable is filled by all the individual components'
+ Makefiles. Generating these targets will trigger the compilation of
+ the userspace packages (libraries, programs), the kernel, the
+ bootloader and the generation of the root filesystem images,
+ depending on the configuration.
+
diff --git a/docs/manual/introduction.txt b/docs/manual/introduction.txt
new file mode 100644
index 0000000..476ce25
--- /dev/null
+++ b/docs/manual/introduction.txt
@@ -0,0 +1,69 @@
+About Buildroot
+===============
+
+Buildroot is a set of Makefiles and patches that allows you to easily
+generate a cross-compilation toolchain, a root filesystem and a Linux
+kernel image for your target. Buildroot can be used for one, two or
+all of these options, independently.
+
+Buildroot is useful mainly for people working with embedded systems.
+Embedded systems often use processors that are not the regular x86
+processors everyone is used to having in his PC. They can be PowerPC
+processors, MIPS processors, ARM processors, etc.
+
+A compilation toolchain is the set of tools that allows you to compile
+code for your system. It consists of a compiler (in our case, +gcc+),
+binary utils like assembler and linker (in our case, +binutils+) and a
+C standard library (for example
+http://www.gnu.org/software/libc/libc.html[GNU Libc],
+http://www.uclibc.org/[uClibc] or
+http://www.fefe.de/dietlibc/[dietlibc]). The system installed on your
+development station certainly already has a compilation toolchain that
+you can use to compile an application that runs on your system. If
+you're using a PC, your compilation toolchain runs on an x86 processor
+and generates code for an x86 processor. Under most Linux systems, the
+compilation toolchain uses the GNU libc (glibc) as the C standard
+library. This compilation toolchain is called the "host compilation
+toolchain". The machine on which it is running, and on which you're
+working, is called the "host system". The compilation toolchain is
+provided by your distribution, and Buildroot has nothing to do with it
+(other than using it to build a cross-compilation toolchain and other
+tools that are run on the development host).
+
+As said above, the compilation toolchain that comes with your system
+runs on and generates code for the processor in your host system. As
+your embedded system has a different processor, you need a
+cross-compilation toolchain - a compilation toolchain that runs on
+your host system but generates code for your target system (and target
+processor). For example, if your host system uses x86 and your target
+system uses ARM, the regular compilation toolchain on your host runs on
+x86 and generates code for x86, while the cross-compilation toolchain
+runs on x86 and generates code for ARM.
+
+Even if your embedded system uses an x86 processor, you might be
+interested in Buildroot for two reasons:
+
+* The compilation toolchain on your host certainly uses the GNU Libc
+ which is a complete but huge C standard library. Instead of using
+ GNU Libc on your target system, you can use uClibc which is a tiny C
+ standard library. If you want to use this C library, then you need a
+ compilation toolchain to generate binaries linked with it. Buildroot
+ can do that for you.
+
+* Buildroot automates the building of a root filesystem with all
+ needed tools like busybox. That makes it much easier than doing it
+ by hand.
+
+You might wonder why such a tool is needed when you can compile +gcc+,
++binutils+, +uClibc+ and all the other tools by hand. Of course doing
+so is possible but, dealing with all of the configure options and
+problems of every +gcc+ or +binutils+ version is very time-consuming
+and uninteresting. Buildroot automates this process through the use
+of Makefiles and has a collection of patches for each +gcc+ and
++binutils+ version to make them work on most architectures.
+
+Moreover, Buildroot provides an infrastructure for reproducing the
+build process of your kernel, cross-toolchain, and embedded root
+filesystem. Being able to reproduce the build process will be useful
+when a component needs to be patched or updated or when another person
+is supposed to take over the project.
diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt
new file mode 100644
index 0000000..10ce695
--- /dev/null
+++ b/docs/manual/manual.txt
@@ -0,0 +1,32 @@
+The Buildroot user manual
+=========================
+:toc:
+
+Buildroot usage and documentation by Thomas Petazzoni. Contributions
+from Karsten Kruse, Ned Ludd, Martin Herren and others.
+
+image::logo.png[]
+
+:leveloffset: 1
+
+include::introduction.txt[]
+
+include::getting.txt[]
+
+include::using.txt[]
+
+include::customize.txt[]
+
+include::rebuilding-packages.txt[]
+
+include::how-buildroot-works.txt[]
+
+include::using-buildroot-toolchain.txt[]
+
+include::external-toolchain.txt[]
+
+include::ccache-support.txt[]
+
+include::download-location.txt[]
+
+include::adding-packages.txt[]
diff --git a/docs/manual/rebuilding-packages.txt b/docs/manual/rebuilding-packages.txt
new file mode 100644
index 0000000..9a41a88
--- /dev/null
+++ b/docs/manual/rebuilding-packages.txt
@@ -0,0 +1,62 @@
+Understanding how to rebuild packages
+=====================================
+
+One of the most common questions asked by Buildroot users is how to
+rebuild a given package or how to remove a package without rebuilding
+everything from scratch.
+
+Removing a package is currently unsupported by Buildroot without
+rebuilding from scratch. This is because Buildroot doesn't keep track
+of which package installs what files in the +output/staging+ and
++output/target+ directories. However, implementing clean package
+removal is on the TODO-list of Buildroot developers.
+
+The easiest way to rebuild a single package from scratch is to remove
+its build directory in +output/build+. Buildroot will then re-extract,
+re-configure, re-compile and re-install this package from scratch.
+
+However, if you don't want to rebuild the package completely from
+scratch, a better understanding of the Buildroot internals is
+needed. Internally, to keep track of which steps have been done and
+which steps remain to be done, Buildroot maintains stamp files (empty
+files that just tell whether this or that action has been done). The
+problem is that these stamp files are not uniformly named and handled
+by the different packages, so some understanding of the particular
+package is needed.
+
+For packages relying on Buildroot packages infrastructures (see
+xref:add-packages[this section] for details), the following stamp
+files are relevant:
+
+* +output/build/packagename-version/.stamp_configured+. If removed,
+ Buildroot will trigger the recompilation of the package from the
+ configuration step (execution of +./configure+).
+
+* +output/build/packagename-version/.stamp_built+. If removed,
+ Buildroot will trigger the recompilation of the package from the
+ compilation step (execution of +make+).
+
+For other packages, an analysis of the specific 'package.mk' file is
+needed. For example, the zlib Makefile used to look like this (before
+it was converted to the generic package infrastructure):
+
+-----------------
+$(ZLIB_DIR)/.configured: $(ZLIB_DIR)/.patched
+ (cd $(ZLIB_DIR); rm -rf config.cache; \
+ [...]
+ )
+ touch $@
+
+$(ZLIB_DIR)/libz.a: $(ZLIB_DIR)/.configured
+ $(MAKE) -C $(ZLIB_DIR) all libz.a
+ touch -c $@
+-----------------
+
+If you want to trigger the reconfiguration, you need to remove
++output/build/zlib-version/.configured+. If you want to trigger only
+the recompilation, you need to remove
++output/build/zlib-version/libz.a+.
+
+Note that most packages, if not all, will progressively be ported over
+to the generic or autotools infrastructure, making it much easier to
+rebuild individual packages.
diff --git a/docs/manual/using-buildroot-toolchain.txt b/docs/manual/using-buildroot-toolchain.txt
new file mode 100644
index 0000000..712e9a8
--- /dev/null
+++ b/docs/manual/using-buildroot-toolchain.txt
@@ -0,0 +1,20 @@
+Using the generated toolchain outside Buildroot
+===============================================
+
+You may want to compile, for your target, your own programs or other
+software that are not packaged in Buildroot. In order to do this you
+can use the toolchain that was generated by Buildroot.
+
+The toolchain generated by Buildroot is located by default in
++output/host/+. The simplest way to use it is to add
++output/host/usr/bin/+ to your PATH environment variable and then to
+use +ARCH-linux-gcc+, +ARCH-linux-objdump+, +ARCH-linux-ld+, etc.
+
+It is possible to relocate the toolchain - but then +--sysroot+ must
+be passed every time the compiler is called to tell where the
+libraries and header files are.
+
+It is also possible to generate the Buildroot toolchain in a directory
+other than +output/host+ by using the +Build options -> Host dir+
+option. This could be useful if the toolchain must be shared with
+other users.
diff --git a/docs/manual/using.txt b/docs/manual/using.txt
new file mode 100644
index 0000000..8d7f0a7
--- /dev/null
+++ b/docs/manual/using.txt
@@ -0,0 +1,183 @@
+Using Buildroot
+===============
+
+Configuration and general usage
+-------------------------------
+
+Buildroot has a nice configuration tool similar to the one you can
+find in the http://www.kernel.org/[Linux kernel] or in
+http://www.busybox.org/[Busybox]. Note that you can (and should) build
+everything as a normal user. There is no need to be root to configure
+and use Buildroot. The first step is to run the configuration
+assistant:
+
+--------------------
+ $ make menuconfig
+--------------------
+
+to run the curses-based configurator, or
+
+--------------------
+ $ make xconfig
+--------------------
+
+or
+
+--------------------
+ $ make gconfig
+--------------------
+
+to run the Qt or GTK-based configurators.
+
+All of these "make" commands will need to build a configuration
+utility, so you may need to install "development" packages for
+relevant libraries used by the configuration utilities. On Debian-like
+systems, the +libncurses5-dev+ package is required to use the
+'menuconfig' interface, +libqt4-dev+ is required to use the 'xconfig'
+interface, and +libglib2.0-dev, libgtk2.0-dev and libglade2-dev+ are
+needed to use the 'gconfig' interface.
+
+For each menu entry in the configuration tool, you can find associated
+help that describes the purpose of the entry.
+
+Once everything is configured, the configuration tool generates a
++.config+ file that contains the description of your
+configuration. It will be used by the Makefiles to do what's needed.
+
+Let's go:
+
+--------------------
+ $ make
+--------------------
+
+You *should never* use +make -jN+ with Buildroot: it does not support
+'top-level parallel make'. Instead, use the +BR2_JLEVEL+ option to
+tell Buildroot to run each package compilation with +make -jN+.
+
+This command will generally perform the following steps:
+
+* Download source files (as required)
+* Configure, build and install the cross-compiling toolchain if an
+ internal toolchain is used, or import a toolchain if an external
+ toolchain is used
+* Build/install selected target packages
+* Build a kernel image, if selected
+* Build a bootloader image, if selected
+* Create a root filesystem in selected formats
+
+Buildroot output is stored in a single directory, +output/+.
+This directory contains several subdirectories:
+
+* +images/+ where all the images (kernel image, bootloader and root
+ filesystem images) are stored.
+
+* +build/+ where all the components except for the cross-compilation
+ toolchain are built (this includes tools needed to run Buildroot on
+ the host and packages compiled for the target). The +build/+
+ directory contains one subdirectory for each of these components.
+
+* +staging/+ which contains a hierarchy similar to a root filesystem
+ hierarchy. This directory contains the installation of the
+ cross-compilation toolchain and all the userspace packages selected
+ for the target. However, this directory is 'not' intended to be
+ the root filesystem for the target: it contains a lot of development
+ files, unstripped binaries and libraries that make it far too big
+ for an embedded system. These development files are used to compile
+ libraries and applications for the target that depend on other
+ libraries.
+
+* +target/+ which contains 'almost' the complete root filesystem for
+ the target: everything needed is present except the device files in
+ +/dev/+ (Buildroot can't create them because Buildroot doesn't run
+ as root and doesn't want to run as root). Therefore, this directory
+ *should not be used on your target*. Instead, you should use one of
+ the images built in the +images/+ directory. If you need an
+ extracted image of the root filesystem for booting over NFS, then
+ use the tarball image generated in +images/+ and extract it as
+ root. Compared to +staging/+, +target/+ contains only the files and
+ libraries needed to run the selected target applications: the
+ development files (headers, etc.) are not present, unless the
+ +development files in target filesystem+ option is selected.
+
+* +host/+ contains the installation of tools compiled for the host
+ that are needed for the proper execution of Buildroot, including the
+ cross-compilation toolchain.
+
+* +toolchain/+ contains the build directories for the various
+ components of the cross-compilation toolchain.
+
+Offline builds
+--------------
+
+If you intend to do an offline build and just want to download
+all sources that you previously selected in the configurator
+('menuconfig', 'xconfig' or 'gconfig'), then issue:
+
+--------------------
+ $ make source
+--------------------
+
+You can now disconnect or copy the content of your +dl+
+directory to the build-host.
+
+Building out-of-tree
+--------------------
+
+Buildroot supports building out of tree with a syntax similar to the
+Linux kernel. To use it, add +O=<directory>+ to the make command line:
+
+--------------------
+ $ make O=/tmp/build
+--------------------
+
+Or:
+
+--------------------
+ $ cd /tmp/build; make O=$PWD -C path/to/buildroot
+--------------------
+
+All the output files will be located under +/tmp/build+.
+
+When using out-of-tree builds, the Buildroot +.config+ and temporary
+files are also stored in the output directory. This means that you can
+safely run multiple builds in parallel using the same source tree as
+long as they use unique output directories.
+
+For ease of use, Buildroot generates a Makefile wrapper in the output
+directory - So after the first run, you no longer need to pass +O=..+
+and +-C ..+, simply run (in the output directory):
+
+--------------------
+ $ make <target>
+--------------------
+
+Environment variables
+---------------------
+[[env-vars]]
+
+Buildroot also honors some environment variables, when they are passed
+to +make+ or set in the environment:
+
+* +HOSTCXX+, the host C++ compiler to use
+* +HOSTCC+, the host C compiler to use
+* +UCLIBC_CONFIG_FILE=<path/to/.config>+, path to
+ the uClibc configuration file, used to compile uClibc, if an
+ internal toolchain is being built
+* +BUSYBOX_CONFIG_FILE=<path/to/.config>+, path to
+ the Busybox configuration file
+* +BUILDROOT_DL_DIR+ to override the directory in which
+ Buildroot stores/retrieves downloaded files
+
+An example that uses config files located in the toplevel directory and
+in your $HOME:
+
+--------------------
+ $ make UCLIBC_CONFIG_FILE=uClibc.config BUSYBOX_CONFIG_FILE=$HOME/bb.config
+--------------------
+
+If you want to use a compiler other than the default +gcc+
+or +g+++ for building helper-binaries on your host, then do
+
+--------------------
+ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD
+--------------------
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [Buildroot] [PATCH 2/5] manual: provide make targets to build the documentation
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 1/5] manual: convert existing documentation to the asciidoc format Thomas Petazzoni
@ 2011-08-04 21:23 ` Thomas Petazzoni
2011-08-04 23:05 ` Yann E. MORIN
2011-08-04 21:23 ` [Buildroot] [PATCH 3/5] remove the old buildroot.html documentation Thomas Petazzoni
` (4 subsequent siblings)
6 siblings, 1 reply; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-04 21:23 UTC (permalink / raw)
To: buildroot
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
Makefile | 40 +++++++++++++++++++++++++++++++++++++++-
1 files changed, 39 insertions(+), 1 deletions(-)
diff --git a/Makefile b/Makefile
index 02a1659..5face9f 100644
--- a/Makefile
+++ b/Makefile
@@ -660,10 +660,18 @@ ifeq ($(BR2_TOOLCHAIN_CTNG),y)
@echo ' ctng-menuconfig - Run crosstool-NG menuconfig'
endif
@echo
+ @echo 'Documentation:'
+ @echo ' manual - build manual in HTML, splitted HTML, PDF and txt'
+ @echo ' manual-html - build manual in HTML'
+ @echo ' manual-splitted-html - build manual in splitted HTML'
+ @echo ' manual-pdf - build manual in PDF'
+ @echo ' manual-txt - build manual in txt'
+ @echo
@echo 'Miscellaneous:'
@echo ' source - download all sources needed for offline-build'
@echo ' source-check - check all packages for valid download URLs'
@echo ' external-deps - list external packages used'
+ @echo ' manual - build the Buildroot manual'
@echo
@echo ' make V=0|1 - 0 => quiet build (default), 1 => verbose build'
@echo ' make O=dir - Locate all output files in "dir", including .config'
@@ -671,7 +679,7 @@ endif
@$(foreach b, $(sort $(notdir $(wildcard $(TOPDIR)/configs/*_defconfig))), \
printf " %-35s - Build for %s\\n" $(b) $(b:_defconfig=);)
@echo
- @echo 'See docs/README and docs/buildroot.html for further details'
+ @echo 'See docs/README and the Buildroot manual for further details'
@echo
release: OUT=buildroot-$(BR2_VERSION)
@@ -679,5 +687,35 @@ release: OUT=buildroot-$(BR2_VERSION)
release:
git archive --format=tar --prefix=$(OUT)/ master|gzip -9 >$(OUT).tar.gz
+manual: manual-html manual-splitted-html manual-pdf manual-txt
+
+manual-html:
+ @echo "HTML manual..."
+ @(cd docs/manual; \
+ cp ../images/logo.png .; \
+ asciidoc -b xhtml11 -d book manual.txt; \
+ rm logo.png)
+
+manual-splitted-html:
+ @echo "Splited HTML manual..."
+ @(cd docs/manual; \
+ cp ../images/logo.png .; \
+ a2x -f chunked -d book -L manual.txt; \
+ rm logo.png)
+
+manual-pdf:
+ @echo "PDF manual..."
+ @(cd docs/manual; \
+ cp ../images/logo.png .; \
+ a2x --dblatex-opts "-P latex.output.revhistory=0" -f pdf -d book -L manual.txt ; \
+ rm logo.png)
+
+manual-txt:
+ @echo "Text manual..."
+ @(cd docs/manual; \
+ cp ../images/logo.png .; \
+ a2x -f text -d book -L manual.txt; \
+ rm logo.png)
+
.PHONY: $(noconfig_targets)
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [Buildroot] [PATCH 3/5] remove the old buildroot.html documentation
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 1/5] manual: convert existing documentation to the asciidoc format Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 2/5] manual: provide make targets to build the documentation Thomas Petazzoni
@ 2011-08-04 21:23 ` Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 4/5] remove Glibc_vs_uClibc document Thomas Petazzoni
` (3 subsequent siblings)
6 siblings, 0 replies; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-04 21:23 UTC (permalink / raw)
To: buildroot
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
docs/buildroot.html | 1819 ---------------------------------------------------
1 files changed, 0 insertions(+), 1819 deletions(-)
delete mode 100644 docs/buildroot.html
diff --git a/docs/buildroot.html b/docs/buildroot.html
deleted file mode 100644
index 2314d10..0000000
--- a/docs/buildroot.html
+++ /dev/null
@@ -1,1819 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
- <title>Buildroot - Usage and documentation</title>
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
- <link rel="stylesheet" href="stylesheet.css">
-</head>
-
-<body>
- <div class="main">
- <div class="titre">
- <h1>Buildroot</h1>
- </div>
-
- <p><a href="http://buildroot.net/">Buildroot</a> usage and documentation
- by Thomas Petazzoni. Contributions from Karsten Kruse, Ned Ludd, Martin
- Herren and others.</p>
-
- <ul>
- <li><a href="#about">About Buildroot</a></li>
- <li><a href="#download">Obtaining Buildroot</a></li>
- <li><a href="#using">Using Buildroot</a></li>
- <li><a href="#custom_targetfs">Customizing the generated target filesystem</a></li>
- <li><a href="#custom_busybox">Customizing the Busybox configuration</a></li>
- <li><a href="#custom_uclibc">Customizing the uClibc configuration</a></li>
- <li><a href="#custom_linux26">Customizing the Linux kernel configuration</a></li>
- <li><a href="#rebuilding_packages">Understanding how to rebuild packages</a></li>
- <li><a href="#buildroot_innards">How Buildroot works</a></li>
- <li><a href="#using_toolchain">Using the uClibc toolchain outside Buildroot</a></li>
- <li><a href="#external_toolchain">Use an external toolchain</a></li>
- <li><a href="#ccache-support">Using <code>ccache</code> in Buildroot</li>
- <li><a href="#downloaded_packages">Location of downloaded packages</a></li>
- <li><a href="#add_packages">Adding new packages to Buildroot</a></li>
- <li><a href="#board_support">Creating your own board support</a></li>
- <li><a href="#faq">Frequently asked questions</a></li>
- <li><a href="#links">Resources</a></li>
- </ul>
-
- <h2 id="about">About Buildroot</h2>
-
- <p>Buildroot is a set of Makefiles and patches that allows you to easily
- generate a cross-compilation toolchain, a root filesystem and a Linux
- kernel image for your target. Buildroot can be used for one, two or all
- of these options, independently.</p>
-
- <p>Buildroot is useful mainly for people working with embedded systems.
- Embedded systems often use processors that are not the regular x86
- processors everyone is used to having in his PC. They can be PowerPC
- processors, MIPS processors, ARM processors, etc.</p>
-
- <p>A compilation toolchain is the set of tools that allows you to
- compile code for your system. It consists of a compiler (in our case,
- <code>gcc</code>), binary utils like assembler and linker (in our case,
- <code>binutils</code>) and a C standard library (for example
- <a href="http://www.gnu.org/software/libc/libc.html">GNU Libc</a>,
- <a href="http://www.uclibc.org/">uClibc</a> or
- <a href="http://www.fefe.de/dietlibc/">dietlibc</a>). The system installed
- on your development station certainly already has a compilation
- toolchain that you can use to compile an application that runs on your
- system. If you're using a PC, your compilation toolchain runs on an x86
- processor and generates code for an x86 processor. Under most Linux
- systems, the compilation toolchain uses the GNU libc (glibc) as the C
- standard library. This compilation toolchain is called the "host
- compilation toolchain". The machine on which it is running, and on
- which you're working, is called the "host system". The
- compilation toolchain is provided by your distribution, and Buildroot
- has nothing to do with it (other than using it to build a
- cross-compilation toolchain and other tools that are run on the
- development host).</p>
-
- <p>As said above, the compilation toolchain that comes with your system
- runs on and generates code for the processor in your host system. As
- your embedded system has a different processor, you need a
- cross-compilation toolchain — a compilation toolchain that runs on
- your host system but generates code for your target system (and target
- processor). For example, if your host system uses x86 and your target
- system uses ARM, the regular compilation toolchain on your host runs on
- x86 and generates code for x86, while the cross-compilation toolchain
- runs on x86 and generates code for ARM.</p>
-
- <p>Even if your embedded system uses an x86 processor, you might be
- interested in Buildroot for two reasons:</p>
-
- <ul>
- <li>The compilation toolchain on your host certainly uses the GNU Libc
- which is a complete but huge C standard library. Instead of using GNU
- Libc on your target system, you can use uClibc which is a tiny C
- standard library. If you want to use this C library, then you need a
- compilation toolchain to generate binaries linked with it. Buildroot
- can do that for you.</li>
-
- <li>Buildroot automates the building of a root filesystem with all needed
- tools like busybox. That makes it much easier than doing it by hand.</li>
- </ul>
-
- <p>You might wonder why such a tool is needed when you can compile
- <code>gcc</code>, <code>binutils</code>, <code>uClibc</code> and all
- the other tools by hand. Of course doing so is possible but, dealing with
- all of the configure options and problems of every <code>gcc</code> or
- <code>binutils</code> version is very time-consuming and uninteresting.
- Buildroot automates this process through the use of Makefiles and has a
- collection of patches for each <code>gcc</code> and <code>binutils</code>
- version to make them work on most architectures.</p>
-
- <p>Moreover, Buildroot provides an infrastructure for reproducing
- the build process of your kernel, cross-toolchain, and embedded root
- filesystem. Being able to reproduce the build process will be useful when a
- component needs to be patched or updated or when another person is supposed
- to take over the project.</p>
-
- <h2 id="download">Obtaining Buildroot</h2>
-
- <p>Buildroot releases are made approximately every 3
- months. Direct Git access and daily snapshots are also
- available, if you want more bleeding edge.</p>
-
- <p>Releases are available at
- <a href="http://buildroot.net/downloads/">http://buildroot.net/downloads/</a>.</p>
-
- <p>The latest snapshot is always available at
- <a href="http://buildroot.net/downloads/snapshots/buildroot-snapshot.tar.bz2">http://buildroot.net/downloads/snapshots/buildroot-snapshot.tar.bz2</a>,
- and previous snapshots are also available at
- <a href="http://buildroot.net/downloads/snapshots/">http://buildroot.net/downloads/snapshots/</a>.</p>
-
- <p>To download Buildroot using Git, you can simply follow
- the rules described on the "Accessing Git" page
- (<a href= "http://buildroot.net/git.html">http://buildroot.net/git.html</a>)
- of the Buildroot website
- (<a href="http://buildroot.net">http://buildroot.net</a>).
- For the impatient, here's a quick recipe:</p>
-
-<pre>
- $ git clone git://git.buildroot.net/buildroot
-</pre>
-
- <h2 id="using">Using Buildroot</h2>
-
- <p>Buildroot has a nice configuration tool similar to the one you can find
- in the Linux kernel
- (<a href="http://www.kernel.org/">http://www.kernel.org/</a>) or in Busybox
- (<a href="http://www.busybox.org/">http://www.busybox.org/</a>). Note that
- you can (and should) build everything as a normal user. There is no need to
- be root to configure and use Buildroot. The first step is to run the
- configuration assistant:</p>
-
-<pre>
- $ make menuconfig
-</pre>
-
- <p>to run the curses-based configurator, or</p>
-
-<pre>
- $ make xconfig
-</pre>
-
- <p>or</p>
-
-<pre>
- $ make gconfig
-</pre>
-
- <p>to run the Qt or GTK-based configurators.</p>
-
- <p>All of these "make" commands will need to build a configuration
- utility, so you may need to install "development" packages for relevant
- libraries used by the configuration utilities. On Debian-like systems,
- the <code>libncurses5-dev</code> package is required to use the <i>
- menuconfig</i> interface, <code>libqt4-dev</code> is required to use
- the <i>xconfig</i> interface, and <code>libglib2.0-dev, libgtk2.0-dev
- and libglade2-dev</code> are needed to use the <i>gconfig</i> interface.</p>
-
- <p>For each menu entry in the configuration tool, you can find associated
- help that describes the purpose of the entry.</p>
-
- <p>Once everything is configured, the configuration tool generates a
- <code>.config</code> file that contains the description of your
- configuration. It will be used by the Makefiles to do what's needed.</p>
-
-
- <p>Let's go:</p>
-
-<pre>
- $ make
-</pre>
-
- <p>You <b>should never</b> use <code>make -jN</code> with
- Buildroot: it does not support <i>top-level parallel
- make</i>. Instead, use the <code>BR2_JLEVEL</code> option to tell
- Buildroot to run each package compilation with <code>make
- -jN</code>.</p>
-
- <p>This command will generally perform the following steps:</p>
- <ul>
- <li>Download source files (as required)</li>
- <li>Configure, build and install the cross-compiling toolchain
- if an internal toolchain is used, or import a toolchain if an
- external toolchain is used</li>
- <li>Build/install selected target packages</li>
- <li>Build a kernel image, if selected</li>
- <li>Build a bootloader image, if selected</li>
- <li>Create a root filesystem in selected formats</li>
- </ul>
-
- <p>Buildroot output is stored in a single directory, <code>output/</code>.
- This directory contains several subdirectories:</p>
-
- <ul>
- <li><code>images/</code> where all the images (kernel image,
- bootloader and root filesystem images) are stored.</li>
-
- <li><code>build/</code> where all the components except for the
- cross-compilation toolchain are built (this includes tools needed to
- run Buildroot on the host and packages compiled for the target). The
- <code>build/</code> directory contains one subdirectory for each of
- these components.</li>
-
- <li><code>staging/</code> which contains a hierarchy similar to a root
- filesystem hierarchy. This directory contains the installation of the
- cross-compilation toolchain and all the userspace packages selected
- for the target. However, this directory is <i>not</i> intended to be
- the root filesystem for the target: it contains a lot of development
- files, unstripped binaries and libraries that make it far too big for
- an embedded system. These development files are used to compile
- libraries and applications for the target that depend on other
- libraries.</li>
-
- <li><code>target/</code> which contains <i>almost</i> the complete
- root filesystem for the target: everything needed is present except
- the device files in <code>/dev/</code> (Buildroot can't create them
- because Buildroot doesn't run as root and doesn't want to run as
- root). Therefore, this directory <b>should not be used on your target</b>.
- Instead, you should use one of the images built in the
- <code>images/</code> directory. If you need an extracted image of the
- root filesystem for booting over NFS, then use the tarball image
- generated in <code>images/</code> and extract it as root.<br/>Compared
- to <code>staging/</code>, <code>target/</code> contains only the
- files and libraries needed to run the selected target applications:
- the development files (headers, etc.) are not present, unless the
- <code>development files in target filesystem</code> option is selected.
- </li>
-
- <li><code>host/</code> contains the installation of tools compiled for
- the host that are needed for the proper execution of Buildroot,
- including the cross-compilation toolchain.</li>
-
- <li><code>toolchain/</code> contains the build directories for the
- various components of the cross-compilation toolchain.</li>
- </ul>
-
- <h3 id="offline_builds">Offline builds</h3>
-
- <p>If you intend to do an offline build and just want to download
- all sources that you previously selected in the configurator
- (<i>menuconfig</i>, <i>xconfig</i> or <i>gconfig</i>), then issue:</p>
-
-<pre>
- $ make source
-</pre>
-
- <p>You can now disconnect or copy the content of your <code>dl</code>
- directory to the build-host.</p>
-
- <h3 id="building_out_of_tree">Building out-of-tree</h3>
-
- <p>Buildroot supports building out of tree with a syntax similar to the
- Linux kernel. To use it, add O=<directory> to the make command
- line:</p>
-
-<pre>
- $ make O=/tmp/build
-</pre>
-
- <p>Or:</p>
-
-<pre>
- $ cd /tmp/build; make O=$PWD -C path/to/buildroot
-</pre>
-
- <p>All the output files will be located under <code>/tmp/build</code>.</p>
-
- <p>When using out-of-tree builds, the Buildroot <code>.config</code> and
- temporary files are also stored in the output directory. This means that
- you can safely run multiple builds in parallel using the same source
- tree as long as they use unique output directories.</p>
-
- <p>For ease of use, Buildroot generates a Makefile wrapper in the output
- directory - So after the first run, you no longer need to pass
- <code>O=..</code> and <code>-C ..</code>, simply run (in the output
- directory):</p>
-
-<pre>
- $ make <target>
-</pre>
-
- <h3 id="environment_variables">Environment variables</h3>
-
- <p>Buildroot also honors some environment variables, when they are passed
- to <code>make</code> or set in the environment:</p>
- <ul>
- <li><code>HOSTCXX</code>, the host C++ compiler to use</li>
- <li><code>HOSTCC</code>, the host C compiler to use</li>
- <li><code>UCLIBC_CONFIG_FILE=<path/to/.config></code>, path to
- the uClibc configuration file, used to compile uClibc, if an
- internal toolchain is being built</li>
- <li><code>BUSYBOX_CONFIG_FILE=<path/to/.config></code>, path to
- the Busybox configuration file</li>
- <li><code>BUILDROOT_DL_DIR</code> to override the directory in which
- Buildroot stores/retrieves downloaded files</li>
- </ul>
-
- <p>An example that uses config files located in the toplevel directory and
- in your $HOME:</p>
-
-<pre>
- $ make UCLIBC_CONFIG_FILE=uClibc.config BUSYBOX_CONFIG_FILE=$HOME/bb.config
-</pre>
-
- <p>If you want to use a compiler other than the default <code>gcc</code>
- or <code>g++</code> for building helper-binaries on your host, then do</p>
-
-<pre>
- $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD
-</pre>
-
- <h2 id="custom_targetfs">Customizing the generated target filesystem</h2>
-
- <p>There are a few ways to customize the resulting target filesystem:</p>
-
- <ul>
- <li>Customize the target filesystem directly and rebuild the image.
- The target filesystem is available under <code>output/target/</code>.
- You can simply make your changes here and run make afterwards —
- this will rebuild the target filesystem image. This method allows you
- to do anything to the target filesystem, but if you decide to
- completely rebuild your toolchain and tools, these changes will be
- lost.</li>
-
- <li>Create your own <i>target skeleton</i>. You can start with
- the default skeleton available under <code>fs/skeleton</code>
- and then customize it to suit your
- needs. The <code>BR2_ROOTFS_SKELETON_CUSTOM</code>
- and <code>BR2_ROOTFS_SKELETON_CUSTOM_PATH</code> will allow you
- to specify the location of your custom skeleton. At build time,
- the contents of the skeleton are copied to output/target before
- any package installation.</li>
-
- <li>In the Buildroot configuration, you can specify the path to a
- post-build script, that gets called <i>after</i> Buildroot builds all
- the selected software, but <i>before</i> the rootfs packages are
- assembled. The destination root filesystem folder is given as the
- first argument to this script, and this script can then be used to
- copy programs, static data or any other needed file to your target
- filesystem.<br/>You should, however, use this feature with care.
- Whenever you find that a certain package generates wrong or unneeded
- files, you should fix that package rather than work around it with a
- post-build cleanup script.</li>
-
- <li>A special package, <i>customize</i>, stored in
- <code>package/customize</code> can be used. You can put all the
- files that you want to see in the final target root filesystem
- in <code>package/customize/source</code>, and then enable this
- special package in the configuration system.</li>
- </ul>
-
- <h2 id="custom_busybox">Customizing the Busybox configuration</h2>
-
- <p><a href="http://www.busybox.net/">Busybox</a> is very configurable,
- and you may want to customize it. You can follow these simple steps to
- do so. This method isn't optimal, but it's simple, and it works:</p>
-
- <ol>
- <li>Do an initial compilation of Buildroot, with busybox, without
- trying to customize it.</li>
-
- <li>Invoke <code>make busybox-menuconfig</code>.
- The nice configuration tool appears, and you can
- customize everything.</li>
-
- <li>Run the compilation of Buildroot again.</li>
- </ol>
-
- <p>Otherwise, you can simply change the
- <code>package/busybox/busybox-<version>.config</code> file, if you
- know the options you want to change, without using the configuration tool.
- </p>
-
- <p>If you want to use an existing config file for busybox, then see
- section <a href="#environment_variables">environment variables</a>.</p>
-
- <h2 id="custom_uclibc">Customizing the uClibc configuration</h2>
-
- <p>Just like <a href="#custom_busybox">BusyBox</a>,
- <a href="http://www.uclibc.org/">uClibc</a> offers a lot of
- configuration options. They allow you to select various
- functionalities depending on your needs and limitations.</p>
-
- <p>The easiest way to modify the configuration of uClibc is to
- follow these steps:</p>
-
- <ol>
- <li>Do an initial compilation of Buildroot without trying to
- customize uClibc.</li>
-
- <li>Invoke <code>make uclibc-menuconfig</code>.
- The nice configuration assistant, similar to
- the one used in the Linux kernel or Buildroot, appears. Make
- your configuration changes as appropriate.</li>
-
- <li>Copy the <code>$(O)/toolchain/uclibc-VERSION/.config</code>
- file to a different place
- (like <code>toolchain/uClibc/uClibc-myconfig.config</code>,
- or <code>board/mymanufacturer/myboard/uClibc.config</code>) and
- adjust the uClibc configuration (configuration
- option <code>BR2_UCLIBC_CONFIG</code>) to use this configuration
- instead of the default one.</li>
-
- <li>Run the compilation of Buildroot again.</li>
- </ol>
-
- <p>Otherwise, you can simply change
- <code>toolchain/uClibc/uClibc.config</code>, without running the
- configuration assistant.</p>
-
- <p>If you want to use an existing config file for uclibc, then see
- section <a href="#environment_variables">environment variables</a>.</p>
-
- <h2 id="custom_linux26">Customizing the Linux kernel configuration</h2>
-
- <p>The Linux kernel configuration can be customized just like
- <a href="#custom_busybox">BusyBox</a> and
- <a href="#custom_uclibc">uClibc</a> using <code>make linux-menuconfig
- </code>. Make sure you have enabled the kernel build in <code>make
- menuconfig</code> first. Once done, run <code>make</code> to (re)build
- everything.</p>
-
- <p>If you want to use an existing config file for Linux, then see
- section <a href="#environment_variables">environment variables</a>.</p>
-
- <h2 id="rebuilding_packages">Understanding how to rebuild packages</h2>
-
- <p>One of the most common questions asked by Buildroot
- users is how to rebuild a given package or how to
- remove a package without rebuilding everything from scratch.</p>
-
- <p>Removing a package is currently unsupported by Buildroot
- without rebuilding from scratch. This is because Buildroot doesn't
- keep track of which package installs what files in the
- <code>output/staging</code> and <code>output/target</code>
- directories. However, implementing clean package removal is on the
- TODO-list of Buildroot developers.</p>
-
- <p>The easiest way to rebuild a single package from scratch is to
- remove its build directory in <code>output/build</code>. Buildroot
- will then re-extract, re-configure, re-compile and re-install this
- package from scratch.</p>
-
- <p>However, if you don't want to rebuild the package completely
- from scratch, a better understanding of the Buildroot internals is
- needed. Internally, to keep track of which steps have been done
- and which steps remain to be done, Buildroot maintains stamp
- files (empty files that just tell whether this or that action
- has been done). The problem is that these stamp files are not
- uniformly named and handled by the different packages, so some
- understanding of the particular package is needed.</p>
-
- <p>For packages relying on Buildroot packages infrastructures (see
- <a href="#add_packages">this section</a> for details), the
- following stamp files are relevant:</p>
-
- <ul>
- <li><code>output/build/packagename-version/.stamp_configured</code>. If
- removed, Buildroot will trigger the recompilation of the package
- from the configuration step (execution of
- <code>./configure</code>).</li>
-
- <li><code>output/build/packagename-version/.stamp_built</code>. If
- removed, Buildroot will trigger the recompilation of the package
- from the compilation step (execution of <code>make</code>).</li>
- </ul>
-
- <p>For other packages, an analysis of the specific <i>package.mk</i>
- file is needed. For example, the zlib Makefile used to look like this
- (before it was converted to the generic package infrastructure):</p>
-
-<pre>
-$(ZLIB_DIR)/.configured: $(ZLIB_DIR)/.patched
- (cd $(ZLIB_DIR); rm -rf config.cache; \
- [...]
- )
- touch $@
-
-$(ZLIB_DIR)/libz.a: $(ZLIB_DIR)/.configured
- $(MAKE) -C $(ZLIB_DIR) all libz.a
- touch -c $@
-</pre>
-
- <p>If you want to trigger the reconfiguration, you need to
- remove <code>output/build/zlib-version/.configured</code>. If
- you want to trigger only the recompilation, you need to remove
- <code>output/build/zlib-version/libz.a</code>.</p>
-
- <p>Note that most packages, if not all, will progressively be
- ported over to the generic or autotools infrastructure, making it
- much easier to rebuild individual packages.</p>
-
- <h2 id="buildroot_innards">How Buildroot works</h2>
-
- <p>As mentioned above, Buildroot is basically a set of Makefiles that
- download, configure, and compile software with the correct options. It
- also includes patches for various software packages — mainly the
- ones involved in the cross-compilation tool chain (<code>gcc</code>,
- <code>binutils</code> and <code>uClibc</code>).</p>
-
- <p>There is basically one Makefile per software package, and they are
- named with the <code>.mk</code> extension. Makefiles are split into
- three main sections:</p>
-
- <ul>
- <li><b>toolchain</b> (in the <code>toolchain/</code> directory) contains
- the Makefiles and associated files for all software related to the
- cross-compilation toolchain: <code>binutils</code>, <code>gcc</code>,
- <code>gdb</code>, <code>kernel-headers</code> and <code>uClibc</code>.</li>
-
- <li><b>package</b> (in the <code>package/</code> directory) contains the
- Makefiles and associated files for all user-space tools that Buildroot
- can compile and add to the target root filesystem. There is one
- sub-directory per tool.</li>
-
- <li><b>target</b> (in the <code>target</code> directory) contains the
- Makefiles and associated files for software related to the generation of
- the target root filesystem image. Four types of filesystems are supported:
- ext2, jffs2, cramfs and squashfs. For each of them there is a
- sub-directory with the required files. There is also a
- <code>default/</code> directory that contains the target filesystem
- skeleton.</li>
- </ul>
-
- <p>Each directory contains at least 2 files:</p>
-
- <ul>
- <li><code>something.mk</code> is the Makefile that downloads, configures,
- compiles and installs the package <code>something</code>.</li>
-
- <li><code>Config.in</code> is a part of the configuration tool
- description file. It describes the options related to the
- package.</li>
- </ul>
-
- <p>The main Makefile performs the following steps (once the
- configuration is done):</p>
-
- <ol>
- <li>Create all the output directories: <code>staging</code>,
- <code>target</code>, <code>build</code>, <code>stamps</code>,
- etc. in the output directory (<code>output/</code> by default,
- another value can be specified using <code>O=</code>)</li>
-
- <li>Generate all the targets listed in the
- <code>BASE_TARGETS</code> variable. When an internal toolchain
- is used, this means generating the cross-compilation
- toolchain. When an external toolchain is used, this means checking
- the features of the external toolchain and importing it into the
- Buildroot environment.</li>
-
- <li>Generate all the targets listed in the <code>TARGETS</code>
- variable. This variable is filled by all the individual
- components' Makefiles. Generating these targets will
- trigger the compilation of the userspace packages (libraries,
- programs), the kernel, the bootloader and the generation of the
- root filesystem images, depending on the configuration.</li>
- </ol>
-
- <h2 id="board_support"> Creating your own board support</h2>
-
- <p>Creating your own board support in Buildroot allows users of a
- particular hardware platform to easily build a system that is
- known to work.</p>
-
- <p>To do so, you need to create a normal Buildroot configuration
- that builds a basic system for the hardware: toolchain, kernel,
- bootloader, filesystem and a simple Busybox-only userspace. No
- specific package should be selected: the configuration should be
- as minimal as possible, and should only build a working basic
- Busybox system for the target platform. You can of course use more
- complicated configurations for your internal projects, but the
- Buildroot project will only integrate basic board
- configurations. This is because package selections are highly
- application-specific.</p>
-
- <p>Once you have a known working configuration, run <code>make
- savedefconfig</code>. This will generate a
- minimal <code>defconfig</code> file at the root of the Buildroot
- source tree. Move this file into the <code>configs/</code>
- directory, and rename it <code>MYBOARD_defconfig</code>.</p>
-
- <p>It is recommended to use as much as possible upstream versions
- of the Linux kernel and bootloaders, and to use as much as
- possible default kernel and bootloader configurations. If they are
- incorrect for your platform, we encourage you to send fixes to the
- corresponding upstream projects.</p>
-
- <p>However, in the mean time, you may want to store kernel or
- bootloader configuration or patches specific to your target
- platform. To do so, create a
- directory <code>board/MANUFACTURER</code> and a
- subdirectory <code>board/MANUFACTURER/BOARDNAME</code> (after
- replacing, of course, MANUFACTURER and BOARDNAME with the
- appropriate values, in lower case letters). You can then store
- your patches and configurations in these directories, and
- reference them from the main Buildroot configuration.</p>
-
- <h2 id="using_toolchain">Using the generated toolchain outside Buildroot</h2>
-
- <p>You may want to compile, for your target, your own programs or other
- software that are not packaged in Buildroot. In order to do this you can
- use the toolchain that was generated by Buildroot.</p>
-
- <p>The toolchain generated by Buildroot is located by default in
- <code>output/host/</code>. The simplest way to use it is to add
- <code>output/host/usr/bin/</code> to your PATH environment variable and
- then to use <code>ARCH-linux-gcc</code>, <code>ARCH-linux-objdump</code>,
- <code>ARCH-linux-ld</code>, etc.</p>
-
- <p>It is possible to relocate the toolchain — but
- then <code>--sysroot</code> must be passed every time the compiler
- is called to tell where the libraries and header files are.</p>
-
- <p>It is also possible to generate the Buildroot toolchain in a
- directory other than <code>output/host</code> by using the <code>
- Build options -> Host dir</code> option.
- This could be useful if the toolchain must be shared with other users.</p>
-
- <h2 id="ccache-support">Using <code>ccache</code> in Buildroot</h2>
-
- <p><a href="http://ccache.samba.org">ccache</a> is a compiler
- cache. It stores the object files resulting from each compilation
- process, and is able to skip future compilation of the same source
- file (with same compiler and same arguments) by using the
- pre-existing object files. When doing almost identical builds from
- scratch a number of times, it can nicely speed up the build
- process.</p>
-
- <p><code>ccache</code> support is integrated in Buildroot. You
- just have to enable <code>Enable compiler cache</code>
- in <code>Build options</code>. This will automatically build
- <code>ccache</code> and use it for every host and target
- compilation.</p>
-
- <p>The cache is located
- in <code>$HOME/.buildroot-ccache</code>. It is stored outside of
- Buildroot output directory so that it can be shared by separate
- Buildroot builds. If you want to get rid of the cache, simply
- remove this directory.</p>
-
- <p>You can get statistics on the cache (its size, number of hits,
- misses, etc.) by running <code>make ccache-stats</code>.</p>
-
- <h2 id="downloaded_packages">Location of downloaded packages</h2>
-
- <p>It might be useful to know that the various tarballs that are
- downloaded by the Makefiles are all stored in the <code>DL_DIR</code>
- which by default is the <code>dl</code> directory. It's useful, for
- example, if you want to keep a complete version of Buildroot which is
- known to be working with the associated tarballs. This will allow you to
- regenerate the toolchain and the target filesystem with exactly the same
- versions.</p>
-
- <p>If you maintain several Buildroot trees, it might be better to have a
- shared download location. This can be accessed by creating a symbolic
- link from the <code>dl</code> directory to the shared download location:</p>
-
-<pre>
- $ ln -s <shared download location> dl
-</pre>
-
- <p>Another way of accessing a shared download location is to
- create the <code>BUILDROOT_DL_DIR</code> environment variable.
- If this is set, then the value of DL_DIR in the project is
- overridden. The following line should be added to
- <code>"~/.bashrc"</code>.</p>
-
-<pre>
- $ export BUILDROOT_DL_DIR <shared download location>
-</pre>
-
- <h2 id="external_toolchain">Using an external toolchain</h2>
-
- <p>Using an already existing toolchain is useful for different
- reasons:</p>
-
- <ul>
- <li>you already have a toolchain that is known to work for your
- specific CPU</li>
- <li>you want to speed up the Buildroot build process by skipping
- the long toolchain build part</li>
- <li>the toolchain generation feature of Buildroot is not
- sufficiently flexible for you (for example if you need to
- generate a system with <i>glibc</i> instead of
- <i>uClibc</i>)</li>
- </ul>
-
- <p>Buildroot supports using existing toolchains through a
- mechanism called <i>external toolchain</i>. The external toolchain
- mechanism is enabled in the <code>Toolchain</code> menu, by
- selecting <code>External toolchain</code> in <code>Toolchain
- type</code>.</p>
-
- <p>Then, you have three solutions to use an external
- toolchain:</p>
-
- <ul>
-
- <li>Use a predefined external toolchain profile, and let
- Buildroot download, extract and install the toolchain. Buildroot
- already knows about a few CodeSourcery toolchains for ARM,
- PowerPC, MIPS and SuperH. Just select the toolchain profile
- in <code>Toolchain</code> through the available ones. This is
- definitely the easiest solution.</li>
-
- <li>Use a predefined external toolchain profile, but instead of
- having Buildroot download and extract the toolchain, you can
- tell Buildroot where your toolchain is already installed on your
- system. Just select the toolchain profile
- in <code>Toolchain</code> through the available ones,
- unselect <code>Download toolchain automatically</code>, and fill
- the <code>Toolchain path</code> text entry with the path to your
- cross-compiling toolchain.</li>
-
- <li>Use a completely custom external toolchain. This is
- particularly useful for toolchains generated using
- Crosstool-NG. To do this, select the <code>Custom
- toolchain</code> solution in the <code>Toolchain</code>
- list. You need to fill the <code>Toolchain
- path</code>, <code>Toolchain prefix</code> and <code>External
- toolchain C library</code> options. Then, you have to tell
- Buildroot what your external toolchain supports. If your
- external toolchain uses the <i>glibc</i> library, you only have
- to tell whether your toolchain supports C++ or not. If your
- external toolchain uses the <i>uclibc</i> library, then you have
- to tell Buildroot if it supports largefile, IPv6, RPC,
- wide-char, locale, program invocation, threads and C++. At the
- beginning of the execution, Buildroot will tell you if the
- selected options do not match the toolchain configuration.</li>
-
- </ul>
-
- <p>Our external toolchain support has been tested with toolchains
- from CodeSourcery, toolchains generated
- by <a href="http://ymorin.is-a-geek.org/dokuwiki/projects/crosstool">Crosstool-NG</a>,
- and toolchains generated by Buildroot itself. In general, all
- toolchains that support the <i>sysroot</i> feature should
- work. If not, do not hesitate to contact the developers.</p>
-
- <p>We do not support toolchains from
- the <a href="http://www.denx.de/wiki/DULG/ELDK">ELDK of Denx</a>,
- for two reasons:</p>
-
- <ul>
-
- <li>The ELDK does not contain a pure toolchain (i.e just the
- compiler, binutils, the C and C++ libraries), but a toolchain
- that comes with a very large set of pre-compiled libraries and
- programs. Therefore, Buildroot cannot import the <i>sysroot</i>
- of the toolchain, as it would contain hundreds of megabytes of
- pre-compiled libraries that are normally built by
- Buildroot.</li>
-
- <li>The ELDK toolchains have a completely non-standard custom
- mechanism to handle multiple library variants. Instead of using
- the standard GCC <i>multilib</i> mechanism, the ARM ELDK uses
- different symbolic links to the compiler to differentiate
- between library variants (for ARM soft-float and ARM VFP), and
- the PowerPC ELDK compiler uses a <code>CROSS_COMPILE</code>
- environment variable. This non-standard behaviour makes it
- difficult to support ELDK in Buildroot.</li>
-
- </ul>
-
- <p>We also do not support using the distribution toolchain (i.e
- the gcc/binutils/C library installed by your distribution) as the
- toolchain to build software for the target. This is because your
- distribution toolchain is not a "pure" toolchain (i.e only with
- the C/C++ library), so we cannot import it properly into the
- Buildroot build environment. So even if you are building a system
- for a x86 or x86_64 target, you have to generate a
- cross-compilation toolchain with Buildroot or Crosstool-NG.</p>
-
- <h2 id="add_packages">Adding new packages to Buildroot</h2>
-
- <p>This section covers how new packages (userspace libraries or
- applications) can be integrated into Buildroot. It also shows how existing
- packages are integrated, which is needed for fixing issues or tuning their
- configuration.</p>
-
- <ul>
- <li><a href="#package-directory">Package directory</a></li>
- <li><a href="#config-in-file"><code>Config.in</code> file</a></li>
- <li><a href="#mk-file">The <code>.mk</code> file</a>
- <ul>
- <li><a href="#generic-tutorial">Makefile for generic packages : tutorial</a></li>
- <li><a href="#generic-reference">Makefile for generic packages : reference</a></li>
- <li><a href="#autotools-tutorial">Makefile for autotools-based packages : tutorial</a></li>
- <li><a href="#autotools-reference">Makefile for autotools-based packages : reference</a></li>
- <li><a href="#cmake-tutorial">Makefile for CMake-based packages : tutorial</a></li>
- <li><a href="#cmake-reference">Makefile for CMake-based packages : reference</a></li>
- <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 id="package-directory">Package directory</h3>
-
- <p>First of all, create a directory under the <code>package</code>
- directory for your software, for example <code>libfoo</code>.</p>
-
- <p>Some packages have been grouped by topic in a sub-directory:
- <code>multimedia</code>, <code>java</code>, <code>x11r7</code>, and
- <code>games</code>. If your package fits in one of these
- categories, then create your package directory in these.</p>
-
- <h3 id="config-in-file"><code>Config.in</code> file</h3>
-
- <p>Then, create a file named <code>Config.in</code>. This file
- will contain the option descriptions related to our
- <code>libfoo</code> software that will be used and displayed in the
- configuration tool. It should basically contain :</p>
-
-<pre>
-config BR2_PACKAGE_LIBFOO
- bool "libfoo"
- help
- This is a comment that explains what libfoo is.
-
- http://foosoftware.org/libfoo/
-</pre>
-
- <p>Of course, you can add other options to configure particular
- things in your software. You can look at examples in other
- packages. The syntax of the Config.in file is the same as the one
- for the kernel Kconfig file. The documentation for this syntax is
- available at
- <a href="http://lxr.free-electrons.com/source/Documentation/kbuild/kconfig-language.txt">http://lxr.free-electrons.com/source/Documentation/kbuild/kconfig-language.txt</a>
- </p>
-
- <p>Finally you have to add your new <code>libfoo/Config.in</code> to
- <code>package/Config.in</code> (or in a category subdirectory if
- you decided to put your package in one of the existing
- categories). The files included there are <em>sorted
- alphabetically</em> per category and are <em>NOT</em> supposed to
- contain anything but the <em>bare</em> name of the package.</p>
-
-<pre>
-source "package/libfoo/Config.in"
-</pre>
-
- <h3 id="mk-file">The <code>.mk</code> file</h3>
-
- <p>Finally, here's the hardest part. Create a file named
- <code>libfoo.mk</code>. It describes how the package should be
- downloaded, configured, built, installed, etc.</p>
-
- <p>Depending on the package type, the <code>.mk</code> file must be
- written in a different way, using different infrastructures:</p>
-
- <ul>
- <li><b>Makefiles for generic packages</b> (not using autotools): These
- are based on an infrastructure similar to the one used for
- autotools-based packages, but requires a little more work from the
- developer. They specify what should be done for the configuration,
- compilation, installation and cleanup of the package. This
- infrastructure must be used for all packages that do not use the
- autotools as their build system. In the future, other specialized
- infrastructures might be written for other build systems.<br/>We cover
- them through a <a href="#generic-tutorial">tutorial</a> and a
- <a href="#generic-reference">reference</a>.</li>
-
- <li><b>Makefiles for autotools-based software</b> (autoconf, automake,
- etc.): We provide a dedicated infrastructure for such packages, since
- autotools is a very common build system. This infrastructure <i>must
- </i> be used for new packages that rely on the autotools as their
- build system.<br/>We cover them through a
- <a href="#autotools-tutorial">tutorial</a> and a
- <a href="#autotools-reference">reference</a>.</li>
-
- <li><b>Manual Makefiles:</b> These are currently obsolete, and no new
- manual Makefiles should be added. However, since there are still many
- of them in the tree, we keep them documented in a
- <a href="#manual-tutorial">tutorial</a>.</li>
- </ul>
-
- <h4 id="generic-tutorial">Makefile for generic packages : tutorial</h4>
-
-<pre>
-<span style="color: #000000">01:</span><span style="font-style: italic; color: #9A1900"> #############################################################</span>
-<span style="color: #000000">02:</span><span style="font-style: italic; color: #9A1900"> #</span>
-<span style="color: #000000">03:</span><span style="font-style: italic; color: #9A1900"> # libfoo</span>
-<span style="color: #000000">04:</span><span style="font-style: italic; color: #9A1900"> #</span>
-<span style="color: #000000">05:</span><span style="font-style: italic; color: #9A1900"> #############################################################</span>
-<span style="color: #000000">06:</span><span style="color: #009900"> LIBFOO_VERSION</span> = 1.0
-<span style="color: #000000">07:</span><span style="color: #009900"> LIBFOO_SOURCE</span> = libfoo-<span style="color: #009900">$(LIBFOO_VERSION)</span>.tar.gz
-<span style="color: #000000">08:</span><span style="color: #009900"> LIBFOO_SITE</span> = http://www.foosoftware.org/download
-<span style="color: #000000">09:</span><span style="color: #009900"> LIBFOO_INSTALL_STAGING</span> = YES
-<span style="color: #000000">10:</span><span style="color: #009900"> LIBFOO_DEPENDENCIES</span> = host-libaaa libbbb
-<span style="color: #000000">11:</span>
-<span style="color: #000000">12:</span> define LIBFOO_BUILD_CMDS
-<span style="color: #000000">13:</span> <span style="color: #009900">$(MAKE)</span> CC=<span style="color: #009900">$(TARGET_CC)</span> LD=<span style="color: #009900">$(TARGET_LD)</span> -C <span style="color: #009900">$(@D)</span> all
-<span style="color: #000000">14:</span> endef
-<span style="color: #000000">15:</span>
-<span style="color: #000000">16:</span> define LIBFOO_INSTALL_STAGING_CMDS
-<span style="color: #000000">17:</span> <span style="color: #009900">$(INSTALL)</span> -D -m 0755 <span style="color: #009900">$(@D)</span>/libfoo.a <span style="color: #009900">$(STAGING_DIR)</span>/usr/lib/libfoo.a
-<span style="color: #000000">18:</span> <span style="color: #009900">$(INSTALL)</span> -D -m 0644 <span style="color: #009900">$(@D)</span>/foo.h <span style="color: #009900">$(STAGING_DIR)</span>/usr/include/foo.h
-<span style="color: #000000">19:</span> <span style="color: #009900">$(INSTALL)</span> -D -m 0755 <span style="color: #009900">$(@D)</span>/libfoo.so* <span style="color: #009900">$(STAGING_DIR)</span>/usr/lib
-<span style="color: #000000">20:</span> endef
-<span style="color: #000000">21:</span>
-<span style="color: #000000">22:</span> define LIBFOO_INSTALL_TARGET_CMDS
-<span style="color: #000000">23:</span> <span style="color: #009900">$(INSTALL)</span> -D -m 0755 <span style="color: #009900">$(@D)</span>/libfoo.so* <span style="color: #009900">$(TARGET_DIR)</span>/usr/lib
-<span style="color: #000000">24:</span> <span style="color: #009900">$(INSTALL)</span> -d -m 0755 <span style="color: #009900">$(TARGET_DIR)</span>/etc/foo.d
-<span style="color: #000000">25:</span> endef
-<span style="color: #000000">26:</span>
-<span style="color: #000000">27:</span><span style="color: #009900"> $(eval $(call GENTARGETS,package,libfoo))</span>
-</pre>
-
- <p>The Makefile begins on line 6 to 8 with metadata information: the
- version of the package (<code>LIBFOO_VERSION</code>), the name of the
- tarball containing the package (<code>LIBFOO_SOURCE</code>) and the
- Internet location at which the tarball can be downloaded
- (<code>LIBFOO_SITE</code>). All variables must start with the same prefix,
- <code>LIBFOO_</code> in this case. This prefix is always the uppercased
- version of the package name (see below to understand where the package
- name is defined).</p>
-
- <p>On line 9, we specify that this package wants to install something to
- the staging space. This is often needed for libraries, since they must
- install header files and other development files in the staging space.
- This will ensure that the commands listed in the
- <code>LIBFOO_INSTALL_STAGING_CMDS</code> variable will be executed.</p>
-
- <p>On line 10, we specify the list of dependencies this package relies
- on. These dependencies are listed in terms of lower-case package names,
- which can be packages for the target (without the <code>host-</code>
- prefix) or packages for the host (with the <code>host-</code>) prefix).
- Buildroot will ensure that all these packages are built and installed
- <i>before</i> the current package starts its configuration.</p>
-
- <p>The rest of the Makefile defines what should be done at the different
- steps of the package configuration, compilation and installation.
- <code>LIBFOO_BUILD_CMDS</code> tells what steps should be performed to
- build the package. <code>LIBFOO_INSTALL_STAGING_CMDS</code> tells what
- steps should be performed to install the package in the staging space.
- <code>LIBFOO_INSTALL_TARGET_CMDS</code> tells what steps should be
- performed to install the package in the target space.</p>
-
- <p>All these steps rely on the <code>$(@D)</code> variable, which
- contains the directory where the source code of the package has been
- extracted.</p>
-
- <p>Finally, on line 27, we call the <code>GENTARGETS</code> which
- generates, according to the variables defined previously, all the
- Makefile code necessary to make your package working.</p>
-
- <h4 id="generic-reference">Makefile for generic packages : reference</h4>
-
- <p>The <code>GENTARGETS</code> macro takes three arguments:</p>
-
- <ul>
- <li>The first argument is the package directory prefix. If your
- package is in <code>package/libfoo</code>, then the directory prefix
- is <code>package</code>. If your package is in
- <code>package/editors/foo</code>, then the directory prefix must be
- <code>package/editors</code>.</li>
-
- <li>The second argument is the lower-cased package name. It must match
- the prefix of the variables in the <code>.mk</code> file and must
- match the configuration option name in the <code>Config.in</code>
- file. For example, if the package name is <code>libfoo</code>, then the
- variables in the <code>.mk</code> file must start with
- <code>LIBFOO_</code> and the configuration option in the
- <code>Config.in</code> file must be <code>BR2_PACKAGE_LIBFOO</code>.</li>
-
- <li>The third argument is optional. It can be used to tell if the
- package is a target package (cross-compiled for the target) or a host
- package (natively compiled for the host). If unspecified, it is
- assumed that it is a target package. See below for details.</li>
- </ul>
-
- <p>For a given package, in a single <code>.mk</code> file, it is
- possible to call GENTARGETS twice, once to create the rules to generate
- a target package and once to create the rules to generate a host package:
- </p>
-
-<pre>
-$(eval $(call GENTARGETS,package,libfoo))
-$(eval $(call GENTARGETS,package,libfoo,host))
-</pre>
-
- <p>This might be useful if the compilation of the target package
- requires some tools to be installed on the host. If the package name is
- <code>libfoo</code>, then the name of the package for the target is also
- <code>libfoo</code>, while the name of the package for the host is
- <code>host-libfoo</code>. These names should be used in the DEPENDENCIES
- variables of other packages, if they depend on <code>libfoo</code> or
- <code>host-libfoo</code>.</p>
-
- <p>The call to the <code>GENTARGETS</code> macro <b>must</b> be at the
- end of the <code>.mk</code> file, after all variable definitions.</p>
-
- <p>For the target package, the <code>GENTARGETS</code> uses the
- variables defined by the .mk file and prefixed by the uppercased package
- name: <code>LIBFOO_*</code>. For the host package, it uses the
- <code>HOST_LIBFOO_*</code>. For <i>some</i> variables, if the
- <code>HOST_LIBFOO_</code> prefixed variable doesn't exist, the package
- infrastructure uses the corresponding variable prefixed by
- <code>LIBFOO_</code>. This is done for variables that are likely to have
- the same value for both the target and host packages. See below for
- details.</p>
-
- <p>The list of variables that can be set in a <code>.mk</code> file to
- give metadata information is (assuming the package name is
- <code>libfoo</code>) :</p>
-
- <ul>
- <li><code>LIBFOO_VERSION</code>, mandatory, must contain the
- version of the package. Note that
- if <code>HOST_LIBFOO_VERSION</code> doesn't exist, it is assumed
- to be the same as <code>LIBFOO_VERSION</code>. It can also be a
- Subversion or Git branch or tag, for packages that are fetched
- directly from their revision control system.<br/>
- Example: <code>LIBFOO_VERSION = 0.1.2</code></li>
-
- <li><code>LIBFOO_SOURCE</code> may contain the name of the tarball of
- the package. If <code>HOST_LIBFOO_SOURCE</code> is not specified, it
- defaults to <code>LIBFOO_VERSION</code>. If none are specified, then
- the value is assumed to be
- <code>packagename-$(LIBFOO_VERSION).tar.gz</code>.<br/>Example:
- <code>LIBFOO_SOURCE = foobar-$(LIBFOO_VERSION).tar.bz2</code></li>
-
- <li><code>LIBFOO_PATCH</code> may contain the name of a patch, that
- will be downloaded from the same location as the tarball indicated in
- <code>LIBFOO_SOURCE</code>. If <code>HOST_LIBFOO_PATCH</code> is not
- specified, it defaults to <code>LIBFOO_PATCH</code>. Also note that
- another mechanism is available to patch a package: all files of the
- form <code>packagename-packageversion-description.patch</code> present
- in the package directory inside Buildroot will be applied to the
- package after extraction.</li>
-
- <li><code>LIBFOO_SITE</code> may contain the Internet location
- of the package. It can either be the HTTP or FTP location of a
- tarball, or the URL of a Git or Subversion repository
- (see <code>LIBFOO_SITE_METHOD</code>
- below). If <code>HOST_LIBFOO_SITE</code> is not specified, it
- defaults to <code>LIBFOO_SITE</code>. If none are specified,
- then the location is assumed to be
- <code>http://$$(BR2_SOURCEFORGE_MIRROR).dl.sourceforge.net/sourceforge/packagename</code>.
- <br/>Examples:<br/>
- <code>LIBFOO_SITE=http://www.libfoosoftware.org/libfoo</code><br/>
- <code>LIBFOO_SITE=http://svn.xiph.org/trunk/Tremor/</code></li>
-
- <li><code>LIBFOO_SITE_METHOD</code> may contain the method to
- fetch the package source code. It can either
- be <code>wget</code> (for normal FTP/HTTP downloads of
- tarballs), <code>svn</code>, <code>git</code> or <code>bzr</code>.
- When not specified, it is guessed from the URL given
- in <code>LIBFOO_SITE</code>: <code>svn://</code>, <code>git://</code>
- and <code>bzr://</code> URLs will use the <code>svn</code>,
- <code>git</code> and <code>bzr</code> methods respectively. All other
- URL-types will use the <code>wget</code> method. So for example, in the
- case of a package whose source code is available through
- Subversion repository on HTTP, one <i>must</i>
- specifiy <code>LIBFOO_SITE_METHOD=svn</code>. For <code>svn</code>
- and <code>git</code> methods, what Buildroot does is a
- checkout/clone of the repository which is then tarballed and
- stored into the download cache. Next builds will not
- checkout/clone again, but will use the tarball
- directly. When <code>HOST_LIBFOO_SITE_METHOD</code> is not
- specified, it defaults to the value
- of <code>LIBFOO_SITE_METHOD</code>. See <code>package/multimedia/tremor/</code>
- for an example.</li>
-
- <li><code>LIBFOO_DEPENDENCIES</code> lists the dependencies (in terms
- of package name) that are required for the current target package to
- compile. These dependencies are guaranteed to be compiled and
- installed before the configuration of the current package starts. In a
- similar way, <code>HOST_LIBFOO_DEPENDENCIES</code> lists the
- dependency for the current host package.</li>
-
- <li><code>LIBFOO_INSTALL_STAGING</code> can be set to <code>YES</code>
- or <code>NO</code> (default). If set to <code>YES</code>, then the
- commands in the <code>LIBFOO_INSTALL_STAGING_CMDS</code> variables are
- executed to install the package into the staging directory.</li>
-
- <li><code>LIBFOO_INSTALL_TARGET</code> can be set to <code>YES</code>
- (default) or <code>NO</code>. If set to <code>YES</code>, then the
- commands in the <code>LIBFOO_INSTALL_TARGET_CMDS</code> variables are
- executed to install the package into the target directory.</li> </ul>
-
- <p>The recommended way to define these variables is to use the following
- syntax:</p>
-
-<pre>
-LIBFOO_VERSION = 2.32
-</pre>
-
- <p>Now, the variables that define what should be performed at the
- different steps of the build process.</p>
-
- <ul>
- <li><code>LIBFOO_CONFIGURE_CMDS</code>, used to list the actions to be
- performed to configure the package before its compilation</li>
-
- <li><code>LIBFOO_BUILD_CMDS</code>, used to list the actions to be
- performed to compile the package</li>
-
- <li><code>HOST_LIBFOO_INSTALL_CMDS</code>, used to list the actions to
- be performed to install the package, when the package is a host
- package. The package must install its files to the directory given by
- <code>$(HOST_DIR)</code>. All files, including development files such
- as headers should be installed, since other packages might be compiled
- on top of this package.</li>
-
- <li><code>LIBFOO_INSTALL_TARGET_CMDS</code>, used to list the actions
- to be performed to install the package to the target directory, when
- the package is a target package. The package must install its files to
- the directory given by <code>$(TARGET_DIR)</code>. Only the files
- required for <i>documentation</i> and <i>execution</i> of the package
- should be installed. Header files should not be installed, they will
- be copied to the target, if the
- <code>development files in target filesystem</code> option is selected.
- </li>
-
- <li><code>LIBFOO_INSTALL_STAGING_CMDS</code>, used to list the actions
- to be performed to install the package to the staging directory, when
- the package is a target package. The package must install its files to
- the directory given by <code>$(STAGING_DIR)</code>. All development
- files should be installed, since they might be needed to compile other
- packages.</li>
-
- <li><code>LIBFOO_CLEAN_CMDS</code>, used to list the actions to
- perform to clean up the build directory of the package.</li>
-
- <li><code>LIBFOO_UNINSTALL_TARGET_CMDS</code>, used to list the actions
- to uninstall the package from the target directory
- <code>$(TARGET_DIR)</code></li>
-
- <li><code>LIBFOO_UNINSTALL_STAGING_CMDS</code>, used to list the
- actions to uninstall the package from the staging directory
- <code>$(STAGING_DIR)</code>.</li>
- </ul>
-
- <p>The preferred way to define these variables is:</p>
-
-<pre>
-define LIBFOO_CONFIGURE_CMDS
- action 1
- action 2
- action 3
-endef
-</pre>
-
- <p>In the action definitions, you can use the following variables:</p>
-
- <ul>
- <li><code>$(@D)</code>, which contains the directory in which the
- package source code has been uncompressed.</li>
-
- <li><code>$(TARGET_CC)</code>, <code>$(TARGET_LD)</code>, etc. to get
- the target cross-compilation utilities</li>
-
- <li><code>$(TARGET_CROSS)</code> to get the cross-compilation
- toolchain prefix</li>
-
- <li>Of course the <code>$(HOST_DIR)</code>, <code>$(STAGING_DIR)</code>
- and <code>$(TARGET_DIR)</code> variables to install the packages
- properly.</li>
- </ul>
-
- <p>The last feature of the generic infrastructure is the ability to add
- hooks. These define further actions to perform after existing steps.
- Most hooks aren't really useful for generic packages, since the
- <code>.mk</code> file already has full control over the actions
- performed in each step of the package construction. The hooks are more
- useful for packages using the autotools infrastructure described below.
- However, since they are provided by the generic infrastructure, they are
- documented here. The exception is <code>LIBFOO_POST_PATCH_HOOKS</code>.
- Patching the package is not user definable, so
- <code>LIBFOO_POST_PATCH_HOOKS</code> will be userful for generic packages.
- </p>
-
- <p>The following hook points are available:</p>
-
- <ul>
- <li><code>LIBFOO_POST_PATCH_HOOKS</code></li>
- <li><code>LIBFOO_PRE_CONFIGURE_HOOKS</code></li>
- <li><code>LIBFOO_POST_CONFIGURE_HOOKS</code></li>
- <li><code>LIBFOO_POST_BUILD_HOOKS</code></li>
- <li><code>LIBFOO_POST_INSTALL_HOOKS</code> (for host packages only)</li>
- <li><code>LIBFOO_POST_INSTALL_STAGING_HOOKS</code> (for target packages only)</li>
- <li><code>LIBFOO_POST_INSTALL_TARGET_HOOKS</code> (for target packages only)</li>
- </ul>
-
- <p>These variables are <i>lists</i> of variable names containing actions
- to be performed at this hook point. This allows several hooks to be
- registered at a given hook point. Here is an example:</p>
-
-<pre>
-define LIBFOO_POST_PATCH_FIXUP
- action1
- action2
-endef
-
-LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP
-</pre>
-
- <h4 id="autotools-tutorial">Makefile for autotools-based packages : tutorial</h4>
-
- <p>First, let's see how to write a <code>.mk</code> file for an
- autotools-based package, with an example :</p>
-
-<pre>
-<span style="color: #000000">01:</span><span style="font-style: italic; color: #9A1900"> #############################################################</span>
-<span style="color: #000000">02:</span><span style="font-style: italic; color: #9A1900"> #</span>
-<span style="color: #000000">03:</span><span style="font-style: italic; color: #9A1900"> # libfoo</span>
-<span style="color: #000000">04:</span><span style="font-style: italic; color: #9A1900"> #</span>
-<span style="color: #000000">05:</span><span style="font-style: italic; color: #9A1900"> #############################################################</span>
-<span style="color: #000000">06:</span><span style="color: #009900"> LIBFOO_VERSION</span> = 1.0
-<span style="color: #000000">07:</span><span style="color: #009900"> LIBFOO_SOURCE</span> = libfoo-<span style="color: #009900">$(LIBFOO_VERSION)</span>.tar.gz
-<span style="color: #000000">08:</span><span style="color: #009900"> LIBFOO_SITE</span> = http://www.foosoftware.org/download
-<span style="color: #000000">09:</span><span style="color: #009900"> LIBFOO_INSTALL_STAGING</span> = YES
-<span style="color: #000000">10:</span><span style="color: #009900"> LIBFOO_INSTALL_TARGET</span> = YES
-<span style="color: #000000">11:</span><span style="color: #009900"> LIBFOO_CONF_OPT</span> = --enable-shared
-<span style="color: #000000">12:</span><span style="color: #009900"> LIBFOO_DEPENDENCIES</span> = libglib2 host-pkg-config
-<span style="color: #000000">13:</span>
-<span style="color: #000000">14:</span><span style="color: #009900"> $(eval $(call AUTOTARGETS,package,libfoo))</span>
-</pre>
-
- <p>On line 6, we declare the version of the package.</p>
-
- <p>On line 7 and 8, we declare the name of the tarball and the location
- of the tarball on the Web. Buildroot will automatically download the
- tarball from this location.</p>
-
- <p>On line 9, we tell Buildroot to install the package to the staging
- directory. The staging directory, located in <code>output/staging/</code>
- is the directory where all the packages are installed, including their
- development files, etc. By default, packages are not installed to the
- staging directory, since usually, only libraries need to be installed in
- the staging directory: their development files are needed to compile
- other libraries or applications depending on them. Also by default, when
- staging installation is enabled, packages are installed in this location
- using the <code>make install</code> command.</p>
-
- <p>On line 10, we tell Buildroot to also install the package to the
- target directory. This directory contains what will become the root
- filesystem running on the target. Usually, we try not to install header
- files and to install stripped versions of the binary. By default, target
- installation is enabled, so in fact, this line is not strictly
- necessary. Also by default, packages are installed in this location
- using the <code>make install</code> command.</p>
-
- <p>On line 11, we tell Buildroot to pass a custom configure option, that
- will be passed to the <code>./configure</code> script before configuring
- and building the package.</p>
-
- <p>On line 12, we declare our dependencies, so that they are built
- before the build process of our package starts.</p>
-
- <p>Finally, on line line 14, we invoke the <code>AUTOTARGETS</code>
- macro that generates all the Makefile rules that actually allows the
- package to be built.</p>
-
- <h4 id="autotools-reference">Makefile for autotools packages : reference</h4>
-
- <p>The main macro of the autotools package infrastructure is
- <code>AUTOTARGETS</code>. It has the same number of arguments and the
- same semantic as the <code>GENTARGETS</code> macro, which is the main
- macro of the generic package infrastructure. For autotools packages, the
- ability to have target and host packages is also available (and is
- actually widely used).</p>
-
- <p>Just like the generic infrastructure, the autotools infrastructure
- works by defining a number of variables before calling the
- <code>AUTOTARGETS</code> macro.</p>
-
- <p>First, all the package metadata information variables that exist in the
- generic infrastructure also exist in the autotools infrastructure:
- <code>LIBFOO_VERSION</code>, <code>LIBFOO_SOURCE</code>,
- <code>LIBFOO_PATCH</code>, <code>LIBFOO_SITE</code>,
- <code>LIBFOO_SUBDIR</code>, <code>LIBFOO_DEPENDENCIES</code>,
- <code>LIBFOO_INSTALL_STAGING</code>, <code>LIBFOO_INSTALL_TARGET</code>.</p>
-
- <p>A few additional variables, specific to the autotools infrastructure,
- can also be defined. Many of them are only useful in very specific
- cases, typical packages will therefore only use a few of them.</p>
-
- <ul>
- <li><code>LIBFOO_SUBDIR</code> may contain the name of a subdirectory
- inside the package that contains the configure script. This is useful,
- if for example, the main configure script is not at the root of the
- tree extracted by the tarball. If <code>HOST_LIBFOO_SUBDIR</code> is
- not specified, it defaults to <code>LIBFOO_SUBDIR</code>.</li>
-
- <li><code>LIBFOO_CONF_ENV</code>, to specify additional environment
- variables to pass to the configure script. By default, empty.</li>
-
- <li><code>LIBFOO_CONF_OPT</code>, to specify additional configure
- options to pass to the configure script. By default, empty.</li>
-
- <li><code>LIBFOO_MAKE</code>, to specify an alternate <code>make</code>
- command. This is typically useful when parallel make is enabled in
- the configuration (using <code>BR2_JLEVEL</code>) but that this
- feature should be disabled for the given package, for one reason or
- another. By default, set to <code>$(MAKE)</code>. If parallel building
- is not supported by the package, then it should be set to
- <code>LIBFOO_MAKE=$(MAKE1)</code>.</li>
-
- <li><code>LIBFOO_MAKE_ENV</code>, to specify additional environment
- variables to pass to make in the build step. These are passed before
- the <code>make</code> command. By default, empty.</li>
-
- <li><code>LIBFOO_MAKE_OPT</code>, to specify additional variables to
- pass to make in the build step. These are passed after the
- <code>make</code> command. By default, empty.</li>
-
- <li><code>LIBFOO_AUTORECONF</code>, tells whether the package should
- be autoreconfigured or not (i.e, if the configure script and
- Makefile.in files should be re-generated by re-running autoconf,
- automake, libtool, etc.). Valid values are <code>YES</code> and
- <code>NO</code>. By default, the value is <code>NO</code></li>
-
- <li><code>LIBFOO_AUTORECONF_OPT</code> to specify additional options
- passed to the <i>autoreconf</i> program if
- <code>LIBFOO_AUTORECONF=YES</code>. By default, empty.</li>
-
- <li><code>LIBFOO_LIBTOOL_PATCH</code> tells whether the Buildroot
- patch to fix libtool cross-compilation issues should be applied or
- not. Valid values are <code>YES</code> and <code>NO</code>. By
- default, the value is <code>YES</code></li>
-
- <li><code>LIBFOO_INSTALL_STAGING_OPT</code> contains the make options
- used to install the package to the staging directory. By default, the
- value is <code>DESTDIR=$$(STAGING_DIR) install</code>, which is
- correct for most autotools packages. It is still possible to override
- it.</li>
-
- <li><code>LIBFOO_INSTALL_TARGET_OPT</code> contains the make options
- used to install the package to the target directory. By default, the
- value is <code>DESTDIR=$$(TARGET_DIR) install</code>. The default
- value is correct for most autotools packages, but it is still possible
- to override it if needed.</li>
-
- <li><code>LIBFOO_CLEAN_OPT</code> contains the make options used to
- clean the package. By default, the value is <code>clean</code>.</li>
-
- <li><code>LIBFOO_UNINSTALL_STAGING_OPT</code>, contains the make
- options used to uninstall the package from the staging directory. By
- default, the value is <code>DESTDIR=$$(STAGING_DIR) uninstall</code>.</li>
-
- <li><code>LIBFOO_UNINSTALL_TARGET_OPT</code>, contains the make
- options used to uninstall the package from the target directory. By
- default, the value is <code>DESTDIR=$$(TARGET_DIR) uninstall</code>.</li>
- </ul>
-
- <p>With the autotools infrastructure, all the steps required to build
- and install the packages are already defined, and they generally work
- well for most autotools-based packages. However, when required, it is
- still possible to customize what is done in any particular step:</p>
-
- <ul>
- <li>By adding a post-operation hook (after extract, patch, configure,
- build or install). See the reference documentation of the generic
- infrastructure for details.</li>
-
- <li>By overriding one of the steps. For example, even if the autotools
- infrastructure is used, if the package <code>.mk</code> file defines its
- own <code>LIBFOO_CONFIGURE_CMDS</code> variable, it will be used
- instead of the default autotools one. However, using this method
- should be restricted to very specific cases. Do not use it in the
- general case.</li>
- </ul>
-
- <h4 id="cmake-tutorial">Makefile for CMake-based packages : tutorial</h4>
-
- <p>First, let's see how to write a <code>.mk</code> file for a CMake-based
- package, with an example :</p>
-
-<pre>
-<span style="color: #000000">01:</span><span style="font-style: italic; color: #9A1900"> #############################################################</span>
-<span style="color: #000000">02:</span><span style="font-style: italic; color: #9A1900"> #</span>
-<span style="color: #000000">03:</span><span style="font-style: italic; color: #9A1900"> # libfoo</span>
-<span style="color: #000000">04:</span><span style="font-style: italic; color: #9A1900"> #</span>
-<span style="color: #000000">05:</span><span style="font-style: italic; color: #9A1900"> #############################################################</span>
-<span style="color: #000000">06:</span><span style="color: #009900"> LIBFOO_VERSION</span> = 1.0
-<span style="color: #000000">07:</span><span style="color: #009900"> LIBFOO_SOURCE</span> = libfoo-<span style="color: #009900">$(LIBFOO_VERSION)</span>.tar.gz
-<span style="color: #000000">08:</span><span style="color: #009900"> LIBFOO_SITE</span> = http://www.foosoftware.org/download
-<span style="color: #000000">09:</span><span style="color: #009900"> LIBFOO_INSTALL_STAGING</span> = YES
-<span style="color: #000000">10:</span><span style="color: #009900"> LIBFOO_INSTALL_TARGET</span> = YES
-<span style="color: #000000">11:</span><span style="color: #009900"> LIBFOO_CONF_OPT</span> = -DBUILD_DEMOS=ON
-<span style="color: #000000">12:</span><span style="color: #009900"> LIBFOO_DEPENDENCIES</span> = libglib2 host-pkg-config
-<span style="color: #000000">13:</span>
-<span style="color: #000000">14:</span><span style="color: #009900"> $(eval $(call CMAKETARGETS,package,libfoo))</span>
-</pre>
-
- <p>On line 6, we declare the version of the package.</p>
-
- <p>On line 7 and 8, we declare the name of the tarball and the location
- of the tarball on the Web. Buildroot will automatically download the
- tarball from this location.</p>
-
- <p>On line 9, we tell Buildroot to install the package to the staging
- directory. The staging directory, located in <code>output/staging/</code>
- is the directory where all the packages are installed, including their
- development files, etc. By default, packages are not installed to the
- staging directory, since usually, only libraries need to be installed in
- the staging directory: their development files are needed to compile
- other libraries or applications depending on them. Also by default, when
- staging installation is enabled, packages are installed in this location
- using the <code>make install</code> command.</p>
-
- <p>On line 10, we tell Buildroot to also install the package to the
- target directory. This directory contains what will become the root
- filesystem running on the target. Usually, we try not to install header
- files and to install stripped versions of the binary. By default, target
- installation is enabled, so in fact, this line is not strictly
- necessary. Also by default, packages are installed in this location
- using the <code>make install</code> command.</p>
-
- <p>On line 11, we tell Buildroot to pass custom options to CMake when it is
- configuring the package.</p>
-
- <p>On line 12, we declare our dependencies, so that they are built
- before the build process of our package starts.</p>
-
- <p>Finally, on line line 14, we invoke the <code>CMAKETARGETS</code>
- macro that generates all the Makefile rules that actually allows the
- package to be built.</p>
-
- <h4 id="cmake-reference">Makefile for CMake packages : reference</h4>
-
- <p>The main macro of the CMake package infrastructure is
- <code>CMAKETARGETS</code>. It has the same number of arguments and the
- same semantic as the <code>GENTARGETS</code> macro, which is the main
- macro of the generic package infrastructure. For CMake packages, the
- ability to have target and host packages is also available.</p>
-
- <p>Just like the generic infrastructure, the CMake infrastructure
- works by defining a number of variables before calling the
- <code>CMAKETARGETS</code> macro.</p>
-
- <p>First, all the package metadata information variables that exist in the
- generic infrastructure also exist in the CMake infrastructure:
- <code>LIBFOO_VERSION</code>, <code>LIBFOO_SOURCE</code>,
- <code>LIBFOO_PATCH</code>, <code>LIBFOO_SITE</code>,
- <code>LIBFOO_SUBDIR</code>, <code>LIBFOO_DEPENDENCIES</code>,
- <code>LIBFOO_INSTALL_STAGING</code>, <code>LIBFOO_INSTALL_TARGET</code>.</p>
-
- <p>A few additional variables, specific to the CMake infrastructure,
- can also be defined. Many of them are only useful in very specific
- cases, typical packages will therefore only use a few of them.</p>
-
- <ul>
- <li><code>LIBFOO_SUBDIR</code> may contain the name of a subdirectory
- inside the package that contains the main CMakeLists.txt file. This is
- useful, if for example, the main CMakeLists.txt file is not at the root
- of the tree extracted by the tarball. If <code>HOST_LIBFOO_SUBDIR</code>
- is not specified, it defaults to <code>LIBFOO_SUBDIR</code>.</li>
-
- <li><code>LIBFOO_CONF_ENV</code>, to specify additional environment
- variables to pass to CMake. By default, empty.</li>
-
- <li><code>LIBFOO_CONF_OPT</code>, to specify additional configure
- options to pass to CMake. By default, empty.</li>
-
- <li><code>LIBFOO_MAKE</code>, to specify an alternate <code>make</code>
- command. This is typically useful when parallel make is enabled in
- the configuration (using <code>BR2_JLEVEL</code>) but that this
- feature should be disabled for the given package, for one reason or
- another. By default, set to <code>$(MAKE)</code>. If parallel building
- is not supported by the package, then it should be set to
- <code>LIBFOO_MAKE=$(MAKE1)</code>.</li>
-
- <li><code>LIBFOO_MAKE_ENV</code>, to specify additional environment
- variables to pass to make in the build step. These are passed before
- the <code>make</code> command. By default, empty.</li>
-
- <li><code>LIBFOO_MAKE_OPT</code>, to specify additional variables to
- pass to make in the build step. These are passed after the
- <code>make</code> command. By default, empty.</li>
-
- <li><code>LIBFOO_INSTALL_STAGING_OPT</code> contains the make options
- used to install the package to the staging directory. By default, the
- value is <code>DESTDIR=$$(STAGING_DIR) install</code>, which is
- correct for most CMake packages. It is still possible to override
- it.</li>
-
- <li><code>LIBFOO_INSTALL_TARGET_OPT</code> contains the make options
- used to install the package to the target directory. By default, the
- value is <code>DESTDIR=$$(TARGET_DIR) install</code>. The default
- value is correct for most CMake packages, but it is still possible
- to override it if needed.</li>
-
- <li><code>LIBFOO_CLEAN_OPT</code> contains the make options used to
- clean the package. By default, the value is <code>clean</code>.</li>
- </ul>
-
- <p>With the CMake infrastructure, all the steps required to build
- and install the packages are already defined, and they generally work
- well for most CMake-based packages. However, when required, it is
- still possible to customize what is done in any particular step:</p>
-
- <ul>
- <li>By adding a post-operation hook (after extract, patch, configure,
- build or install). See the reference documentation of the generic
- infrastructure for details.</li>
-
- <li>By overriding one of the steps. For example, even if the CMake
- infrastructure is used, if the package <code>.mk</code> file defines its
- own <code>LIBFOO_CONFIGURE_CMDS</code> variable, it will be used
- instead of the default CMake one. However, using this method
- should be restricted to very specific cases. Do not use it in the
- general case.</li>
- </ul>
-
- <h4 id ="manual-tutorial">Manual Makefile : tutorial</h4>
-
- <p><b>NOTE: new manual makefiles should not be created, and existing
- manual makefiles should be converted either to the generic, autotools
- or cmake infrastructure. This section is only kept to document the existing
- manual makefiles and to help understand how they work.</b></p>
-
-<pre>
-01: #############################################################
-02: #
-03: # libfoo
-04: #
-05: #############################################################
-<span id="ex2line6">06: LIBFOO_VERSION:=1.0</span>
-07: LIBFOO_SOURCE:=libfoo-$(LIBFOO_VERSION).tar.gz
-08: LIBFOO_SITE:=http://www.foosoftware.org/downloads
-09: LIBFOO_DIR:=$(BUILD_DIR)/foo-$(FOO_VERSION)
-10: LIBFOO_BINARY:=foo
-11: LIBFOO_TARGET_BINARY:=usr/bin/foo
-12:
-<span id="ex2line13">13: $(DL_DIR)/$(LIBFOO_SOURCE):</span>
-14: $(call DOWNLOAD,$(LIBFOO_SITE),$(LIBFOO_SOURCE))
-15:
-<span id="ex2line16">16: $(LIBFOO_DIR)/.source: $(DL_DIR)/$(LIBFOO_SOURCE)</span>
-17: $(ZCAT) $(DL_DIR)/$(LIBFOO_SOURCE) | tar -C $(BUILD_DIR) $(TAR_OPTIONS) -
-18: touch $@
-19:
-<span id="ex2line20">20: $(LIBFOO_DIR)/.configured: $(LIBFOO_DIR)/.source</span>
-21: (cd $(LIBFOO_DIR); rm -rf config.cache; \
-22: $(TARGET_CONFIGURE_OPTS) \
-23: $(TARGET_CONFIGURE_ARGS) \
-24: ./configure \
-25: --target=$(GNU_TARGET_NAME) \
-26: --host=$(GNU_TARGET_NAME) \
-27: --build=$(GNU_HOST_NAME) \
-28: --prefix=/usr \
-29: --sysconfdir=/etc \
-30: )
-31: touch $@
-32:
-<span id="ex2line33">33: $(LIBFOO_DIR)/$(LIBFOO_BINARY): $(LIBFOO_DIR)/.configured</span>
-34: $(MAKE) CC=$(TARGET_CC) -C $(LIBFOO_DIR)
-35:
-<span id="ex2line36">36: $(TARGET_DIR)/$(LIBFOO_TARGET_BINARY): $(LIBFOO_DIR)/$(LIBFOO_BINARY)</span>
-37: $(MAKE) DESTDIR=$(TARGET_DIR) -C $(LIBFOO_DIR) install-strip
-38: rm -Rf $(TARGET_DIR)/usr/man
-39:
-<span id="ex2line40">40: libfoo: uclibc ncurses $(TARGET_DIR)/$(LIBFOO_TARGET_BINARY)</span>
-41:
-<span id="ex2line42">42: libfoo-source: $(DL_DIR)/$(LIBFOO_SOURCE)</span>
-43:
-<span id="ex2line44">44: libfoo-clean:</span>
-45: $(MAKE) prefix=$(TARGET_DIR)/usr -C $(LIBFOO_DIR) uninstall
-46: -$(MAKE) -C $(LIBFOO_DIR) clean
-47:
-<span id="ex2line48">48: libfoo-dirclean:</span>
-49: rm -rf $(LIBFOO_DIR)
-50:
-<span id="ex2line51">51: #############################################################</span>
-52: #
-53: # Toplevel Makefile options
-54: #
-55: #############################################################
-56: ifeq ($(BR2_PACKAGE_LIBFOO),y)
-57: TARGETS+=libfoo
-58: endif
-</pre>
-
- <p>First of all, this Makefile example works for a package which
- comprises a single binary executable. For other software, such as
- libraries or more complex stuff with multiple binaries, it must be
- adapted. For examples look at the other <code>*.mk</code> files in the
- <code>package</code> directory.</p>
-
- <p>At lines <a href="#ex2line6">6-11</a>, a couple of useful variables are
- defined:</p>
-
- <ul>
- <li><code>LIBFOO_VERSION</code>: The version of <i>libfoo</i> that
- should be downloaded.</li>
-
- <li><code>LIBFOO_SOURCE</code>: The name of the tarball of <i>libfoo</i>
- on the download website or FTP site. As you can see
- <code>LIBFOO_VERSION</code> is used.</li>
-
- <li><code>LIBFOO_SITE</code>: The HTTP or FTP site from which
- <i>libfoo</i> archive is downloaded. It must include the complete path to
- the directory where <code>LIBFOO_SOURCE</code> can be found.</li>
-
- <li><code>LIBFOO_DIR</code>: The directory into which the software will
- be configured and compiled. Basically, it's a subdirectory of
- <code>BUILD_DIR</code> which is created upon decompression of the tarball.
- </li>
-
- <li><code>LIBFOO_BINARY</code>: Software binary name. As said previously,
- this is an example for a package with a single binary.</li>
-
- <li><code>LIBFOO_TARGET_BINARY</code>: The full path of the binary inside
- the target filesystem.</li> </ul>
-
- <p>Lines <a href="#ex2line13">13-14</a> define a target that downloads
- the tarball from the remote site to the download directory
- (<code>DL_DIR</code>).</p>
-
- <p>Lines <a href="#ex2line16">16-18</a> define a target and associated
- rules that uncompress the downloaded tarball. As you can see, this
- target depends on the tarball file so that the previous target (lines
- <a href="#ex2line13">13-14</a>) is called before executing the rules of
- the current target. Uncompressing is followed by <i>touching</i> a
- hidden file to mark the software as having been uncompressed. This trick
- is used everywhere in a Buildroot Makefile to split steps (download,
- uncompress, configure, compile, install) while still having correct
- dependencies.</p>
-
- <p>Lines <a href="#ex2line20">20-31</a> define a target and associated
- rules that configure the software. It depends on the previous target
- (the hidden <code>.source</code> file) so that we are sure the software
- has been uncompressed. In order to configure the package, it basically
- runs the well-known <code>./configure</code> script. As we may be doing
- cross-compilation, <code>target</code>, <code>host</code> and
- <code>build</code> arguments are given. The prefix is also set to
- <code>/usr</code>, not because the software will be installed in
- <code>/usr</code> on your host system, but because the software will be
- installed in <code> /usr</code> on the target filesystem. Finally it
- creates a <code>.configured</code> file to mark the software as
- configured.</p>
-
- <p>Lines <a href="#ex2line33">33-34</a> define a target and a rule that
- compile the software. This target will create the binary file in the
- compilation directory and depends on the software being already
- configured (hence the reference to the <code>.configured</code> file).
- It basically runs <code>make</code> inside the source directory.</p>
-
- <p>Lines <a href="#ex2line36">36-38</a> define a target and associated
- rules that install the software inside the target filesystem. They
- depend on the binary file in the source directory to make sure the
- software has been compiled. They use the <code>install-strip</code>
- target of the software <code>Makefile</code> by passing a
- <code>DESTDIR</code> argument so that the <code>Makefile</code> doesn't
- try to install the software in the host <code>/usr</code> but rather in
- the target <code>/usr</code>. After the installation, the
- <code>/usr/man </code> directory inside the target filesystem is removed
- to save space. </p>
-
- <p>Line <a href="#ex2line40">40</a> defines the main target of the
- software — the one that will eventually be used by the top level
- <code>Makefile</code> to download, compile, and then install this
- package. This target should first of all depend on all needed
- dependencies of the software (in our example, <i>uclibc</i> and
- <i>ncurses</i>) and also depend on the final binary. This last dependency
- will call all previous dependencies in the correct order.</p>
-
- <p>Line <a href="#ex2line42">42</a> defines a simple target that only
- downloads the code source. This is not used during normal operation of
- Buildroot, but is needed if you intend to download all required sources
- at once for later offline build. Note that if you add a new package,
- providing a <code>libfoo-source</code> target is <i>mandatory</i> to
- support users that wish to do offline-builds. Furthermore, it eases
- checking if all package-sources are downloadable.</p>
-
- <p>Lines <a href="#ex2line44">44-46</a> define a simple target to clean
- the software build by calling the Makefile with the appropriate options.
- The <code>-clean</code> target should run <code>make clean</code> on
- $(BUILD_DIR)/package-version and MUST uninstall all files of the package
- from $(STAGING_DIR) and from $(TARGET_DIR).</p>
-
- <p>Lines <a href="#ex2line48">48-49</a> define a simple target to
- completely remove the directory in which the software was uncompressed,
- configured and compiled. The <code>-dirclean</code> target MUST
- completely rm $(BUILD_DIR)/ package-version.</p>
-
- <p>Lines <a href="#ex2line51">51-58</a> add the target <code>libfoo</code>
- to the list of targets to be compiled by Buildroot, by first checking if
- the configuration option for this package has been enabled using the
- configuration tool. If so, it then "subscribes" this package
- to be compiled by adding the package to the TARGETS global variable.
- The name added to the TARGETS global variable is the name of this
- package's target, as defined on line <a href="#ex2line40">40</a>, which
- is used by Buildroot to download, compile, and then install this package.
- </p>
-
- <h3 id="gettext-integration">Gettext integration and interaction with packages</h3>
-
- <p>Many packages that support internationalization use the gettext
- library. Dependencies for this library are fairly complicated and therefore,
- deserves some explanation.</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 kinds of build failures.</p>
-
- <p>Additionally, some packages (such as libglib2) do require gettext
- unconditionally, 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 unconditionally need gettext should:</p>
-
- <ol>
- <li>Use <code>select BR2_PACKAGE_GETTEXT 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_GETTEXT 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>
-
- <p>As you can see, adding a software package to Buildroot is simply a
- matter of writing a Makefile using an existing example and modifying it
- according to the compilation process required by the package.</p>
-
- <p>If you package software that might be useful for other people, don't
- forget to send a patch to Buildroot developers!</p>
-
- <h2 id="faq">Frequently asked questions</h2>
-
- <ul>
- <li><a href="#faq-boot-hangs">The boot hangs
- after <code>Starting network...</code></a></li>
- <li><a href="#module-init-tools-doesnt-build">module-init-tools
- fails to build with <code>cannot find -lc</code></a></li>
- </ul>
-
- <h3 id="faq-boot-hangs">The boot hangs after <code>Starting
- network...</code></h3>
-
- <p>If the boot process seems to hang after the following messages
- (messages not necessarly exactly similar, depending on the list of
- packages selected):</p>
-
- <pre>Freeing init memory: 3972K
-Initializing random number generator... done.
-Starting network...
-Starting dropbear sshd: generating rsa key... generating dsa key... OK</pre>
-
- <p>then it means that your system is running, but didn't start a
- shell on the serial console. In order to have the system start a
- shell on your serial console, you have to go in the Buildroot
- configuration, <code>Target options</code>, enable <code>Generic
- serial port config</code>, and select the serial port and speed
- you would like to use for the shell. This will automatically tune
- the <code>/etc/inittab</code> file of the generated system so that
- a shell starts on the correct serial port.</p>
-
- <h3 id="module-init-tools-doesnt-build">module-init-tools
- fails to build with <code>cannot find -lc</code></h3>
-
- <p>If the build of <i>module-init-tools</i> for the host fails
- with:</p>
-
- <pre>/usr/bin/ld: cannot find -lc </pre>
-
- <p>then probably you are running a Fedora (or similar)
- distribution, and you should install the <code>glibc-static</code>
- package. This is because the <i>module-init-tools</i> build
- process wants to link statically against the C library.</p>
-
- <h2 id="links">Resources</h2>
-
- <p>To learn more about Buildroot you can visit these websites:</p>
-
- <ul>
- <li><a href="http://www.uclibc.org/">http://www.uclibc.org/</a></li>
- <li><a href="http://www.busybox.net/">http://www.busybox.net/</a></li>
- </ul>
- </div>
-</body>
-</html>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [Buildroot] [PATCH 4/5] remove Glibc_vs_uClibc document
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
` (2 preceding siblings ...)
2011-08-04 21:23 ` [Buildroot] [PATCH 3/5] remove the old buildroot.html documentation Thomas Petazzoni
@ 2011-08-04 21:23 ` Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 5/5] manual: ignore generated files Thomas Petazzoni
` (2 subsequent siblings)
6 siblings, 0 replies; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-04 21:23 UTC (permalink / raw)
To: buildroot
This document has nothing to do with Buildroot, and is probably a
leftover from the uClibc documentation.
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
docs/Glibc_vs_uClibc.html | 240 ---------------------------------------------
1 files changed, 0 insertions(+), 240 deletions(-)
delete mode 100644 docs/Glibc_vs_uClibc.html
diff --git a/docs/Glibc_vs_uClibc.html b/docs/Glibc_vs_uClibc.html
deleted file mode 100644
index c14eb8c..0000000
--- a/docs/Glibc_vs_uClibc.html
+++ /dev/null
@@ -1,240 +0,0 @@
-<!--#include file="header.html" -->
-
-<h2>uClibc vs. glibc</h2>
-
-<p>
- uClibc and Glibc are not the same -- there are a number of differences which
- may or may not cause you problems. This document attempts to list these
- differences and, when completed, will contain a full list of all relevant
- differences.
- <br><br></p>
- <ol>
- <li>uClibc is smaller than glibc. We attempt to maintain a glibc compatible
- interface, allowing applications that compile with glibc to easily compile with
- uClibc. However, we do not include _everything_ that glibc includes, and
- therefore some applications may not compile. If this happens to you, please
- report the failure to the uclibc mailing list, with detailed error messages.
- </li><br>
- <li>uClibc is much more configurable then glibc. This means that a developer
- may have compiled uClibc in such a way that significant amounts of
- functionality have been omitted.
- </li><br>
- <li>uClibc does not even attempt to ensure binary compatibility across releases.
- When a new version of uClibc is released, you may or may not need to recompile
- all your binaries.
- </li><br>
- <li><ul><li> malloc(0) in glibc returns a valid pointer to something(!?!?) while in
- uClibc calling malloc(0) returns a NULL. The behavior of malloc(0) is listed
- as implementation-defined by SuSv3, so both libraries are equally correct.
- This difference also applies to realloc(NULL, 0). I personally feel glibc's
- behavior is not particularly safe. To enable glibc behavior, one has to
- explicitly enable the MALLOC_GLIBC_COMPAT option.
- </li><br><li>
- glibc's malloc() implementation has behavior that is tunable via the
- MALLOC_CHECK_ environment variable. This is primarily used to provide extra
- malloc debugging features. These extended malloc debugging features are not
- available within uClibc. There are many good malloc debugging libraries
- available for Linux (dmalloc, electric fence, valgrind, etc) that work much
- better than the glibc extended malloc debugging. So our omitting this
- functionality from uClibc is not a great loss.
- </li><br>
- </ul></li>
- <li>uClibc does not provide a database library (libdb).
- </li><br>
- <li>uClibc does not support NSS (/lib/libnss_*), which allows glibc to easily
- support various methods of authentication and DNS resolution. uClibc only
- supports flat password files and shadow password files for storing
- authentication information. If you need something more complex than this,
- you can compile and install pam.
- </li><br>
- <li>uClibc's libresolv is only a stub. Some, but not all of the functionality
- provided by glibc's libresolv is provided internal to uClibc. Other functions
- are not at all implemented.
- </li><br>
- <li>libnsl provides support for Network Information Service (NIS) which was
- originally called "Yellow Pages" or "YP", which is an extension of RPC invented
- by Sun to share Unix password files over the network. I personally think NIS
- is an evil abomination and should not be used. These days, using ldap is much
- more effective mechanism for doing the same thing. uClibc provides a stub
- libnsl, but has no actual support for Network Information Service (NIS).
- We therefore, also do not provide any of the headers files provided by glibc
- under /usr/include/rpcsvc.
- </li><br>
- <li>uClibc's locale support is not 100% complete yet. We are working on it.
- </li><br>
- <li>uClibc's math library only supports long double as inlines, and even
- then the long double support is quite limited. Also, very few of the
- float math functions are implemented. Stick with double and you should
- be just fine.
- </li><br>
- <li>uClibc's libcrypt does not support the reentrant crypt_r, setkey_r and
- encrypt_r, since these are not required by SuSv3.
- </li><br>
- <li>uClibc directly uses kernel types to define most opaque data types.
- </li><br>
- <li>uClibc directly uses the linux kernel's arch specific 'stuct stat'.
- </li><br>
- <li>uClibc's librt library currently lacks all aio routines, all clock
- routines, and all shm routines (only the timer routines and the mq
- routines are implemented).
- </li><br>
-</ol>
-<hr>
-<h3>Manuel's Notes</h3>
-
- Some general comments...<br>
- <p>
- The intended target for all my uClibc code is ANSI/ISO C99 and SUSv3
- compliance. While some glibc extensions are present, many will eventually
- be configurable. Also, even when present, the glibc-like extensions may
- differ slightly or be more restrictive than the native glibc counterparts.
- They are primarily meant to be porting _aides_ and not necessarily
- drop-in replacements.
- </p><br>
-Now for some details...<br><br>
-
-<u>time functions</u><br>
-<ol>
-<li>Leap seconds are not supported.</li><br>
-<li>/etc/timezone and the whole zoneinfo directory tree are not supported.
- To set the timezone, set the TZ environment variable as specified in
- http://www.opengroup.org/onlinepubs/007904975/basedefs/xbd_chap08.html
- or you may also create an /etc/TZ file of a single line, ending with a
- newline, containing the TZ setting. For example
- echo CST6CDT > /etc/TZ
-</li><br>
-<li>Currently, locale specific eras and alternate digits are not supported.
- They are on my TODO list.
-</li>
-</ol><br>
-<u>wide char support</u><br>
-<ol>
-<li>The only multibyte encoding currently supported is UTF-8. The various
- ISO-8859-* encodings are (optionally) supported. The internal
- representation of wchar's is assumed to be 31 bit unicode values in
- native endian representation. Also, the underlying char encoding is
- assumed to match ASCII in the range 0-0x7f.
-</li>
-<li>In the next iteration of locale support, I plan to add support for
- (at least some) other multibyte encodings.
-</li>
-</ol>
-<u>locale support</u><br>
-<ol>
-<li>The target for support is SUSv3 locale functionality. While nl_langinfo
- has been extended, similar to glibc, it only returns values for related
- locale entries.
-</li>
-<li>Currently, all SUSv3 libc locale functionality should be implemented
- except for wcsftime and collating item support in regex.
-</li>
-</ol>
-<u>stdio</u><br>
-<ol>
-<li>Conversion of large magnitude floating-point values by printf suffers a loss
- of precision due to the algorithm used.
-</li><br>
-<li>uClibc's printf is much stricter than glibcs, especially regarding positional
- args. The entire format string is parsed first and an error is returned if
- a problem is detected. In locales other than C, the format string is checked
- to be a valid multibyte sequence as well. Also, currently at most 10 positional
- args are allowed (although this is configurable).
-</li><br>
-<li>BUFSIZ is configurable, but no attempt is made at automatic tuning of internal
- buffer sizes for stdio streams. In fact, the stdio code in general sacrifices
- sophistication/performace for minimal size.
-</li><br>
-<li>uClibc allows glibc-like custom printf functions. However, while not
- currently checked, the specifier must be <= 0x7f.
-</li><br>
-<li>uClibc allows glibc-like custom streams. However, no in-buffer seeking is
- done.
-</li><br>
-<li>The functions fcloseall() and __fpending() can behave differently than their
- glibc counterparts.
-</li><br>
-<li>uClibc's setvbuf is more restrictive about when it can be called than glibc's
- is. The standards specify that setvbuf must occur before any other operations
- take place on the stream.
-</li><br>
-<li>Right now, %m is not handled properly by printf when the format uses positional
- args.
-</li><br>
-<li>The FILEs created by glibc's fmemopen(), open_memstream(), and fopencookie()
- are not capable of wide orientation. The corresponding uClibc routines do
- not have this limitation.
-</li><br>
-<li>For scanf, the C99 standard states "The fscanf function returns the value of
- the macro EOF if an input failure occurs before any conversion." But glibc's
- scanf does not respect conversions for which assignment was surpressed, even
- though the standard states that the value is converted but not stored.
-</li></ol><br>
-<hr><h3>Glibc bugs</h3><br>
-glibc bugs that Ulrich Drepper has refused to acknowledge or comment on
- ( <a href="http://sources.redhat.com/ml/libc-alpha/2003-09/">http://sources.redhat.com/ml/libc-alpha/2003-09/</a> )
-<br>
-<ol>
-<li>The C99 standard says that for printf, a %s conversion makes no special
- provisions for multibyte characters. SUSv3 is even more clear, stating
- that bytes are written and a specified precision is in bytes. Yet glibc
- treats the arg as a multibyte string when a precision is specified and
- not otherwise.
-</li><br>
-<li>Both C99 and C89 state that the %c conversion for scanf reads the exact
- number of bytes specified by the optional field width (or 1 if not specified).
- uClibc complies with the standard. There is an argument that perhaps the
- specified width should be treated as an upper bound, based on some historical
- use. However, such behavior should be mentioned in the Conformance document.
-</li><br>
-<li>glibc's scanf is broken regarding some numeric patterns. Some invalid
- strings are accepted as valid ("0x.p", "1e", digit grouped strings).
- In spite of my posting examples clearly illustrating the bugs, they remain
- unacknowledged by the glibc developers.
-</li><br>
-<li>glibc's scanf seems to require a 'p' exponent for hexadecimal float strings.
- According to the standard, this is optional.
-</li><br>
-<li>C99 requires that once an EOF is encountered, the stream should be treated
- as if at end-of-file even if more data becomes available. Further reading
- can be attempted by clearing the EOF flag though, via clearerr() or a file
- positioning function. For details concerning the original change, see
- Defect Report #141. glibc is currently non-compliant, and the developers
- did not comment when I asked for their official position on this issue.
-</li><br>
-<li>glibc's collation routines and/or localedef are broken regarding implicit
- and explicit UNDEFINED rules.
-</li><br></ol>
-More to follow as I think of it...
-<br><br><hr>
-<h3>Profiling:</h3>
-<p>
-uClibc no longer supports 'gcc -fprofile-arcs -pg' style profiling, which
-causes your application to generate a 'gmon.out' file that can then be analyzed
-by 'gprof'. Not only does this require explicit extra support in uClibc, it
-requires that you rebuild everything with profiling support. There is both a
-size and performance penalty to profiling your applications this way, as well
-as Heisenberg effects, where the act of measuring changes what is measured.
-</p>
-<p>
-There exist a number of less invasive alternatives that do not require you to
-specially instrument your application, and recompile and relink everything.
-</p><p>
-The OProfile system-wide profiler is an excellent alternative:
- <a href="http://oprofile.sourceforge.net/">http://oprofile.sourceforge.net/</a>
-</p><p>
-Many people have had good results using the combination of Valgrind
-to generate profiling information and KCachegrind for analysis:
- <a href="http://developer.kde.org/~sewardj/">http://developer.kde.org/~sewardj/</a>
- <a href="http://kcachegrind.sourceforge.net/">http://kcachegrind.sourceforge.net/</a>
-</p><p>
-Prospect is another alternative based on OProfile:
- <a href="http://prospect.sourceforge.net/">http://prospect.sourceforge.net/</a>
-</p><p>
-And the Linux Trace Toolkit (LTT) is also a fine tool:
- <a href="http://www.opersys.com/LTT/">http://www.opersys.com/LTT/</a>
-</p><p>
-FunctionCheck:
- <a href="http://www710.univ-lyon1.fr/~yperret/fnccheck/">http://www710.univ-lyon1.fr/~yperret/fnccheck/</a>
-</p>
-
-<!--#include file="footer.html" -->
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [Buildroot] [PATCH 5/5] manual: ignore generated files
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
` (3 preceding siblings ...)
2011-08-04 21:23 ` [Buildroot] [PATCH 4/5] remove Glibc_vs_uClibc document Thomas Petazzoni
@ 2011-08-04 21:23 ` Thomas Petazzoni
2011-08-04 22:56 ` [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Grant Edwards
2011-08-05 5:42 ` Thomas De Schampheleire
6 siblings, 0 replies; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-04 21:23 UTC (permalink / raw)
To: buildroot
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
docs/manual/.gitignore | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
create mode 100644 docs/manual/.gitignore
diff --git a/docs/manual/.gitignore b/docs/manual/.gitignore
new file mode 100644
index 0000000..cda42e4
--- /dev/null
+++ b/docs/manual/.gitignore
@@ -0,0 +1,4 @@
+manual.chunked/
+manual.html
+manual.pdf
+manual.text
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
` (4 preceding siblings ...)
2011-08-04 21:23 ` [Buildroot] [PATCH 5/5] manual: ignore generated files Thomas Petazzoni
@ 2011-08-04 22:56 ` Grant Edwards
2011-08-05 5:42 ` Thomas De Schampheleire
6 siblings, 0 replies; 16+ messages in thread
From: Grant Edwards @ 2011-08-04 22:56 UTC (permalink / raw)
To: buildroot
On 2011-08-04, Thomas Petazzoni <thomas.petazzoni@free-electrons.com> wrote:
> The Buildroot documentation was started by myself in December 2004
> (see commit 32fcf718f82c241e890af8c7ccc10ef6c438331a), and at that
> time the amount of documentation was relatively light, so the single
> HTML file was seen as an appropriate solution to write the
> documentation.
>
> Since then, the documentation has expanded quite a bit, and I intend
> to do some more important additions to the documentation in the near
> future, but I feel like the hand-written HTML format is a bit
> annoying.
>
> Therefore, this set of patches proposes to switch the documentation
> over to the AsciiDoc format [1]. It is a very simple text-baseda
> format, from which you can generate HTML (single page or splitted),
> PDF, text, and more.
Sounds like a great idea to me.
I use asciidoc for the internal user's manual for the platform which
runs the results of my buildroot use. That document weighs in at
about 90 pages (in USLetter PDF format). I find asciidoc very easy to
work with, and it's a lot less work than hand-coded HTML or using
something like OpenOffice/LibreOffice.
FWIW, I prefer the PDF produced by the fop backend over that produced
by dblatex, but that's a matter of taste (I usually use the HTML
version of my document).
I also agree 100% with the decision to keep the option of a
single-HTML-page document. Splitting up documents in to dozens or even
hundreds of separate HTML pages makes them almost impossible to
search.
--
Grant Edwards grant.b.edwards Yow! Pardon me, but do you
at know what it means to be
gmail.com TRULY ONE with your BOOTH!
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [PATCH 2/5] manual: provide make targets to build the documentation
2011-08-04 21:23 ` [Buildroot] [PATCH 2/5] manual: provide make targets to build the documentation Thomas Petazzoni
@ 2011-08-04 23:05 ` Yann E. MORIN
0 siblings, 0 replies; 16+ messages in thread
From: Yann E. MORIN @ 2011-08-04 23:05 UTC (permalink / raw)
To: buildroot
Thomas, All,
On Thursday 04 August 2011 23:23:20 Thomas Petazzoni wrote:
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> ---
> Makefile | 40 +++++++++++++++++++++++++++++++++++++++-
> 1 files changed, 39 insertions(+), 1 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index 02a1659..5face9f 100644
> --- a/Makefile
> +++ b/Makefile
[--SNIP--]
> @@ -679,5 +687,35 @@ release: OUT=buildroot-$(BR2_VERSION)
> release:
> git archive --format=tar --prefix=$(OUT)/ master|gzip -9 >$(OUT).tar.gz
>
> +manual: manual-html manual-splitted-html manual-pdf manual-txt
> +
> +manual-html:
> + @echo "HTML manual..."
> + @(cd docs/manual; \
> + cp ../images/logo.png .; \
> + asciidoc -b xhtml11 -d book manual.txt; \
Does not work for out-of-tree builds.
Where is the doc output supposed to be: in the source tree, or in the
build dir? If the later, I tested the above doesn't work. If the former,
it'd be weird to have generated files in the source tree. Especially
if it is shared by more than one build instannce...
> + rm logo.png)
Don't remove the logo, it is needed later for viewing the HTML doc.
But see below...
> +manual-splitted-html:
> + @echo "Splited HTML manual..."
> + @(cd docs/manual; \
> + cp ../images/logo.png .; \
> + a2x -f chunked -d book -L manual.txt; \
> + rm logo.png)
> +
> +manual-pdf:
> + @echo "PDF manual..."
> + @(cd docs/manual; \
> + cp ../images/logo.png .; \
> + a2x --dblatex-opts "-P latex.output.revhistory=0" -f pdf -d book -L manual.txt ; \
> + rm logo.png)
> +
> +manual-txt:
> + @echo "Text manual..."
> + @(cd docs/manual; \
> + cp ../images/logo.png .; \
> + a2x -f text -d book -L manual.txt; \
> + rm logo.png)
> +
> .PHONY: $(noconfig_targets)
I find the copy-then-remove a little bit uggly. Maybe somthing along the
lines of (Makefile totally untested, asciidoc commands manually tested):
---8<---
MANUAL_SOURCES = $(wildcard docs/manual/*.txt)
$(O)/docs/manual/logo.png: docs/images/logo.png
$(Q)mkdir -p $(@D)
$(Q)cp $< $@
manual: manual-html manual-splitted-html [...]
manual-%: $(MANUAL_SOURCES) $(O)/docs/manual/logo.png
manual-html:
@echo "HTML manual..."
$(Q)asciidoc -b xhtml11 -d book docs/manual/manual.txt \
-o $(O)/docs/manual/manual.html
manual-splitted-html:
@echo "Splited HTML manual..."
$(Q)a2x -f chunked -d book -L docs/manual/manual.txt \
-r docs/images \
-D $(O)/docs/manual
# And so on...
---8<---
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| Yann E. MORIN | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ |
| +33 223 225 172 `------------.-------: X AGAINST | \e/ There is no |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL | v conspiracy. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
` (5 preceding siblings ...)
2011-08-04 22:56 ` [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Grant Edwards
@ 2011-08-05 5:42 ` Thomas De Schampheleire
2011-08-05 6:39 ` Thomas Petazzoni
6 siblings, 1 reply; 16+ messages in thread
From: Thomas De Schampheleire @ 2011-08-05 5:42 UTC (permalink / raw)
To: buildroot
Hello Thomas,
On Thu, Aug 4, 2011 at 11:23 PM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
> Hello,
>
> The Buildroot documentation was started by myself in December 2004
> (see commit 32fcf718f82c241e890af8c7ccc10ef6c438331a), and at that
> time the amount of documentation was relatively light, so the single
> HTML file was seen as an appropriate solution to write the
> documentation.
>
> Since then, the documentation has expanded quite a bit, and I intend
> to do some more important additions to the documentation in the near
> future, but I feel like the hand-written HTML format is a bit
> annoying.
>
> Therefore, this set of patches proposes to switch the documentation
> over to the AsciiDoc format [1]. It is a very simple text-baseda
> format, from which you can generate HTML (single page or splitted),
> PDF, text, and more.
>
> I have done an initial conversion of the Buildroot documentation to
> AsciiDoc and the result can be seen at :
>
> ?* http://free-electrons.com/~thomas/buildroot/manual/manual.pdf for
> ? the PDF version
>
> ?* http://free-electrons.com/~thomas/buildroot/manual/manual.text for
> ? the text version
>
> ?* http://free-electrons.com/~thomas/buildroot/manual/manual.html for
> ? the single page HTML version
>
> ?* http://free-electrons.com/~thomas/buildroot/manual/html/ for
> ? the multiple pages HTML version
>
> Some more improvements can quite certainly be made to the converted
> document. However, I'd prefer not to maintain it for a too long time
> together with the current documentation, so if the solution of
> AsciiDoc gets the attention of the Buildroot community, it'd be nice
> to have this merged relatively soon, or at least to not do too many
> changes to the current documentation.
I'm in favor of this manual conversion. It's true that it is a bit
annoying having to take care of the HTML.
One comment though: how will you ship buildroot? Will the generated
manuals be included in the official tarballs?
I think it should. Otherwise, a new user will have nothing but the
individual txt files, which are not convenient to read directly
because of the number of files. In order to get 'real' documentation,
he'd already have to know that there are make targets for it, he'd
need at least asciidoc to get a full manual.txt and possibly docbook
to get pdf or html output.
Best regards,
Thomas
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-05 5:42 ` Thomas De Schampheleire
@ 2011-08-05 6:39 ` Thomas Petazzoni
2011-08-05 7:44 ` Peter Korsgaard
0 siblings, 1 reply; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-05 6:39 UTC (permalink / raw)
To: buildroot
Hello Thomas,
Le Fri, 5 Aug 2011 07:42:28 +0200,
Thomas De Schampheleire <patrickdepinguin+buildroot@gmail.com> a ?crit :
> I'm in favor of this manual conversion. It's true that it is a bit
> annoying having to take care of the HTML.
Yeah, it is a bit painful and I hope that having a better format, with
splitted files, will encourage us to do more updates to the
documentation.
> One comment though: how will you ship buildroot? Will the generated
> manuals be included in the official tarballs?
> I think it should. Otherwise, a new user will have nothing but the
> individual txt files, which are not convenient to read directly
> because of the number of files. In order to get 'real' documentation,
> he'd already have to know that there are make targets for it, he'd
> need at least asciidoc to get a full manual.txt and possibly docbook
> to get pdf or html output.
This is a question, of course. Peter has raised the same comment on IRC
when I quickly presented the proposal, some days ago.
I agree that somehow a generated version of the documentation should be
part of the release tarballs. The generated documentation should also
be on the website, for every Buildroot release.
For the first part, I guess the "make release" target can be extended
to generate the documentation and then include it into the tarball, but
I think this is something to be discussed with Peter.
What would be great is at least to reach to a decision on whether or
not converting the documentation to AsciiDoc is desirable or not. If it
is, then I can start collecting patches to fix issues related to the
conversion or improvements to the documentation in AsciiDoc format,
waiting for the next release cycle to start to get this new
documentation format merged.
Regards,
Thomas
--
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-05 6:39 ` Thomas Petazzoni
@ 2011-08-05 7:44 ` Peter Korsgaard
2011-08-05 8:22 ` Thomas Petazzoni
0 siblings, 1 reply; 16+ messages in thread
From: Peter Korsgaard @ 2011-08-05 7:44 UTC (permalink / raw)
To: buildroot
>>>>> "Thomas" == Thomas Petazzoni <thomas.petazzoni@free-electrons.com> writes:
Hi,
>> One comment though: how will you ship buildroot? Will the generated
>> manuals be included in the official tarballs?
>> I think it should. Otherwise, a new user will have nothing but the
>> individual txt files, which are not convenient to read directly
>> because of the number of files. In order to get 'real' documentation,
>> he'd already have to know that there are make targets for it, he'd
>> need at least asciidoc to get a full manual.txt and possibly docbook
>> to get pdf or html output.
Thomas> This is a question, of course. Peter has raised the same
Thomas> comment on IRC when I quickly presented the proposal, some days
Thomas> ago.
Thomas> I agree that somehow a generated version of the documentation
Thomas> should be part of the release tarballs. The generated
Thomas> documentation should also be on the website, for every
Thomas> Buildroot release.
Thomas> For the first part, I guess the "make release" target can be
Thomas> extended to generate the documentation and then include it into
Thomas> the tarball, but I think this is something to be discussed with
Thomas> Peter.
Indeed. For releases I think atleast the text and single-html version
should get included in the tarball. We also need to setup something with
a git hook to regenerate (some of) the documentation on the server
whenever any of the source files changes. Currently the website is
simply a git checkout managed from cron on the server, and there's no
asciidoc on the server, but presumably that's just a question about
asking the osuosl.org guys for it.
Thomas> What would be great is at least to reach to a decision on
Thomas> whether or not converting the documentation to AsciiDoc is
Thomas> desirable or not. If it is, then I can start collecting patches
Thomas> to fix issues related to the conversion or improvements to the
Thomas> documentation in AsciiDoc format, waiting for the next release
Thomas> cycle to start to get this new documentation format merged.
Well, so far I've only heard positive feedback, so I would say: Go for
it!
--
Bye, Peter Korsgaard
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-05 7:44 ` Peter Korsgaard
@ 2011-08-05 8:22 ` Thomas Petazzoni
2011-08-07 19:18 ` Peter Korsgaard
0 siblings, 1 reply; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-05 8:22 UTC (permalink / raw)
To: buildroot
Le Fri, 05 Aug 2011 09:44:12 +0200,
Peter Korsgaard <jacmet@uclibc.org> a ?crit :
> Thomas> For the first part, I guess the "make release" target can be
> Thomas> extended to generate the documentation and then include it into
> Thomas> the tarball, but I think this is something to be discussed with
> Thomas> Peter.
>
> Indeed. For releases I think atleast the text and single-html version
> should get included in the tarball.
So, should we extend the release to target to uncompress the tarball
after it has been generated by git archive, generate the documentation,
add it to the release directory, and re-create the tarball? Or is
there a better way?
> We also need to setup something with
> a git hook to regenerate (some of) the documentation on the server
> whenever any of the source files changes. Currently the website is
> simply a git checkout managed from cron on the server, and there's no
> asciidoc on the server, but presumably that's just a question about
> asking the osuosl.org guys for it.
In order to move forward on this, can we start discussing this with the
osuosl.org people?
> Well, so far I've only heard positive feedback, so I would say: Go for
> it!
Great!
Thomas
--
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-05 8:22 ` Thomas Petazzoni
@ 2011-08-07 19:18 ` Peter Korsgaard
2011-08-07 19:24 ` Yann E. MORIN
2011-08-08 18:20 ` Peter Korsgaard
0 siblings, 2 replies; 16+ messages in thread
From: Peter Korsgaard @ 2011-08-07 19:18 UTC (permalink / raw)
To: buildroot
>>>>> "Thomas" == Thomas Petazzoni <thomas.petazzoni@free-electrons.com> writes:
Hi,
>> Indeed. For releases I think atleast the text and single-html
>> version should get included in the tarball.
Thomas> So, should we extend the release to target to uncompress the
Thomas> tarball after it has been generated by git archive, generate
Thomas> the documentation, add it to the release directory, and
Thomas> re-create the tarball? Or is there a better way?
I haven't looked in detail, but we can probably just use tar --append to
add the documentation afterwards.
>> We also need to setup something with
>> a git hook to regenerate (some of) the documentation on the server
>> whenever any of the source files changes. Currently the website is
>> simply a git checkout managed from cron on the server, and there's no
>> asciidoc on the server, but presumably that's just a question about
>> asking the osuosl.org guys for it.
Thomas> In order to move forward on this, can we start discussing this
Thomas> with the osuosl.org people?
Yes, I've already mailed them to get asciidoc installed and get control
over the website update cronjob.
--
Bye, Peter Korsgaard
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-07 19:18 ` Peter Korsgaard
@ 2011-08-07 19:24 ` Yann E. MORIN
2011-08-08 18:20 ` Peter Korsgaard
1 sibling, 0 replies; 16+ messages in thread
From: Yann E. MORIN @ 2011-08-07 19:24 UTC (permalink / raw)
To: buildroot
Peter, Thomas, All,
On Sunday 07 August 2011 21:18:55 Peter Korsgaard wrote:
> >> Indeed. For releases I think atleast the text and single-html
> >> version should get included in the tarball.
>
> Thomas> So, should we extend the release to target to uncompress the
> Thomas> tarball after it has been generated by git archive, generate
> Thomas> the documentation, add it to the release directory, and
> Thomas> re-create the tarball? Or is there a better way?
>
> I haven't looked in detail, but we can probably just use tar --append to
> add the documentation afterwards.
I can take a look if you want. Thomas, is your 'asciidoc-manual' up-to-date?
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| Yann E. MORIN | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ |
| +33 223 225 172 `------------.-------: X AGAINST | \e/ There is no |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL | v conspiracy. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-07 19:18 ` Peter Korsgaard
2011-08-07 19:24 ` Yann E. MORIN
@ 2011-08-08 18:20 ` Peter Korsgaard
2011-08-09 15:02 ` Thomas Petazzoni
1 sibling, 1 reply; 16+ messages in thread
From: Peter Korsgaard @ 2011-08-08 18:20 UTC (permalink / raw)
To: buildroot
>>>>> "Peter" == Peter Korsgaard <jacmet@uclibc.org> writes:
Hi,
Thomas> In order to move forward on this, can we start discussing this
Thomas> with the osuosl.org people?
Peter> Yes, I've already mailed them to get asciidoc installed and get
Peter> control over the website update cronjob.
asciidoc (8.5.3) is now installed, and the update script can be changed
when we're ready.
Thomas, have you done any changes since you posted the patches? If so,
please repost.
--
Bye, Peter Korsgaard
^ permalink raw reply [flat|nested] 16+ messages in thread
* [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual
2011-08-08 18:20 ` Peter Korsgaard
@ 2011-08-09 15:02 ` Thomas Petazzoni
0 siblings, 0 replies; 16+ messages in thread
From: Thomas Petazzoni @ 2011-08-09 15:02 UTC (permalink / raw)
To: buildroot
Le Mon, 08 Aug 2011 20:20:57 +0200,
Peter Korsgaard <jacmet@sunsite.dk> a ?crit :
> Thomas, have you done any changes since you posted the patches? If so,
> please repost.
No, I haven't done any changes since I posted the patches.
N.B: I am on holidays, with an intermittent access to an Internet
connection.
Thomas
--
Thomas Petazzoni, Free Electrons
Kernel, drivers, real-time and embedded Linux
development, consulting, training and support.
http://free-electrons.com
^ permalink raw reply [flat|nested] 16+ messages in thread
end of thread, other threads:[~2011-08-09 15:02 UTC | newest]
Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-08-04 21:23 [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 1/5] manual: convert existing documentation to the asciidoc format Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 2/5] manual: provide make targets to build the documentation Thomas Petazzoni
2011-08-04 23:05 ` Yann E. MORIN
2011-08-04 21:23 ` [Buildroot] [PATCH 3/5] remove the old buildroot.html documentation Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 4/5] remove Glibc_vs_uClibc document Thomas Petazzoni
2011-08-04 21:23 ` [Buildroot] [PATCH 5/5] manual: ignore generated files Thomas Petazzoni
2011-08-04 22:56 ` [Buildroot] [RFC] Using AsciiDoc for the Buildroot manual Grant Edwards
2011-08-05 5:42 ` Thomas De Schampheleire
2011-08-05 6:39 ` Thomas Petazzoni
2011-08-05 7:44 ` Peter Korsgaard
2011-08-05 8:22 ` Thomas Petazzoni
2011-08-07 19:18 ` Peter Korsgaard
2011-08-07 19:24 ` Yann E. MORIN
2011-08-08 18:20 ` Peter Korsgaard
2011-08-09 15:02 ` Thomas Petazzoni
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.