manual: use one-line titles instead of two-line titles (trivial)
authorThomas De Schampheleire <patrickdepinguin@gmail.com>
Fri, 2 May 2014 05:47:30 +0000 (07:47 +0200)
committerPeter Korsgaard <peter@korsgaard.com>
Fri, 2 May 2014 08:27:59 +0000 (10:27 +0200)
Asciidoc supports two syntaxes for section titles: two-line titles (title
plus underline consisting of a particular symbol), and one-line titles
(title prefixed with a specific number of = signs).

The two-line title underlines are:
Level 0 (top level):     ======================
Level 1:                 ----------------------
Level 2:                 ~~~~~~~~~~~~~~~~~~~~~~
Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level):  ++++++++++++++++++++++

and the one-line title prefixes:
= Document Title (level 0) =
== Section title (level 1) ==

=== Section title (level 2) ===
==== Section title (level 3) ====
===== Section title (level 4) =====

The buildroot manual is currenly using the two-line titles, but this has
multiple disadvantages:

- asciidoc also uses some of the underline symbols for other purposes (like
  preformatted code, example blocks, ...), which makes it difficult to do
  mass replacements, such as a planned follow-up patch that needs to move
  all sections one level down.

- it is difficult to remember which level a given underline symbol (=-~^+)
  corresponds to, while counting = signs is easy.

This patch changes all two-level titles to one-level titles in the manual.
The bulk of the change was done with the following Python script, except for
the level 1 titles (-----) as these underlines are also used for literal
code blocks.
This patch only changes the titles, no other changes. In
adding-packages-directory.txt, I did add missing newlines between some
titles and their content.

----------------------------------------------------------------------------
#!/usr/bin/env python

import sys
import mmap
import re

for input in sys.argv[1:]:

    f = open(input, 'r+')
    f.flush()
    s = mmap.mmap(f.fileno(), 0)

    # Level 0 (top level):     ======================   =
    # Level 1:                 ----------------------   ==
    # Level 2:                 ~~~~~~~~~~~~~~~~~~~~~~   ===
    # Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^   ====
    # Level 4 (bottom level):  ++++++++++++++++++++++   =====

    def replace_title(s, symbol, replacement):
        pattern = re.compile(r'(.+\n)\%s{2,}\n' % symbol, re.MULTILINE)
        return pattern.sub(r'%s \1' % replacement, s)

    new = s
    new = replace_title(new, '=', '=')
    new = replace_title(new, '+', '=====')
    new = replace_title(new, '^', '====')
    new = replace_title(new, '~', '===')
    #new = replace_title(new, '-', '==')

    s.seek(0)
    s.write(new)
    s.resize(s.tell())
    s.close()
    f.close()

----------------------------------------------------------------------------

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
56 files changed:
docs/manual/adding-packages-autotools.txt
docs/manual/adding-packages-cmake.txt
docs/manual/adding-packages-conclusion.txt
docs/manual/adding-packages-directory.txt
docs/manual/adding-packages-generic.txt
docs/manual/adding-packages-gettext.txt
docs/manual/adding-packages-hooks.txt
docs/manual/adding-packages-luarocks.txt
docs/manual/adding-packages-perl.txt
docs/manual/adding-packages-python.txt
docs/manual/adding-packages-tips.txt
docs/manual/adding-packages-virtual.txt
docs/manual/adding-packages.txt
docs/manual/advanced.txt
docs/manual/appendix.txt
docs/manual/beyond-buildroot.txt
docs/manual/ccache-support.txt
docs/manual/common-usage.txt
docs/manual/configure.txt
docs/manual/contribute.txt
docs/manual/customize-busybox-config.txt
docs/manual/customize-kernel-config.txt
docs/manual/customize-outside-br.txt
docs/manual/customize-packages.txt
docs/manual/customize-rootfs.txt
docs/manual/customize-store.txt
docs/manual/customize-toolchain.txt
docs/manual/customize-uclibc-config.txt
docs/manual/customize.txt
docs/manual/debugging-buildroot.txt
docs/manual/developer-guide.txt
docs/manual/download-infra.txt
docs/manual/download-location.txt
docs/manual/eclipse-integration.txt
docs/manual/faq-troubleshooting.txt
docs/manual/get-involved.txt
docs/manual/getting.txt
docs/manual/going-further.txt
docs/manual/how-buildroot-works.txt
docs/manual/introduction.txt
docs/manual/known-issues.txt
docs/manual/legal-notice.txt
docs/manual/make-tips.txt
docs/manual/makedev-syntax.txt
docs/manual/makeusers-syntax.txt
docs/manual/manual.txt
docs/manual/package-make-target.txt
docs/manual/patch-policy.txt
docs/manual/prerequisite.txt
docs/manual/rebuilding-packages.txt
docs/manual/starting-up.txt
docs/manual/using-buildroot-development.txt
docs/manual/using-buildroot-toolchain.txt
docs/manual/using.txt
docs/manual/working-with.txt
docs/manual/writing-rules.txt

index cc668b526c58c52f0734fd8c8162c997ba01687c..c7e797f87868d8b689fe93dea01a7329c88fbdaf 100644 (file)
@@ -1,13 +1,11 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for autotools-based packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Infrastructure for autotools-based packages
 
 [[autotools-package-tutorial]]
 
-+autotools-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +autotools-package+ tutorial
 
 First, let's see how to write a +.mk+ file for an autotools-based
 package, with an example :
@@ -67,8 +65,7 @@ package to be built.
 
 [[autotools-package-reference]]
 
-+autotools-package+ reference
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +autotools-package+ reference
 
 The main macro of the autotools package infrastructure is
 +autotools-package+. It is similar to the +generic-package+ macro. The ability to
index 29f2b8f12706d67db12b435fab228c1d1c27e80e..d648fee3520ee3ad8da3a6d4b72bea7ef0fed06b 100644 (file)
@@ -1,13 +1,11 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for CMake-based packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Infrastructure for CMake-based packages
 
 [[cmake-package-tutorial]]
 
-+cmake-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== +cmake-package+ tutorial
 
 First, let's see how to write a +.mk+ file for a CMake-based package,
 with an example :
@@ -66,8 +64,7 @@ package to be built.
 
 [[cmake-package-reference]]
 
-+cmake-package+ reference
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +cmake-package+ reference
 
 The main macro of the CMake package infrastructure is
 +cmake-package+. It is similar to the +generic-package+ macro. The ability to
index 8e1b2c6a73452e9a19a7b6b7bd38d5754b0a56a0..93f90a419d81f6a49d11df9771a08616d6266697 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Conclusion
-~~~~~~~~~~
+=== 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
index 52eb6539dbc74d3b80d1ca18655f8ca137e5a9e2..5d4d5d9f0b0d627c797b585b98eae842b17728b4 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Package directory
-~~~~~~~~~~~~~~~~~
+=== Package directory
 
 First of all, create a directory under the +package+ directory for
 your software, for example +libfoo+.
@@ -13,8 +12,7 @@ one of these categories, then create your package directory in these.
 New subdirectories are discouraged, however.
 
 
-+Config.in+ file
-~~~~~~~~~~~~~~~~
+=== +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
@@ -52,8 +50,7 @@ source "package/libfoo/Config.in"
 --------------------------
 
 [[depends-on-vs-select]]
-Choosing +depends on+ or +select+
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Choosing +depends on+ or +select+
 
 The +Config.in+ file of your package must also ensure that
 dependencies are enabled. Typically, Buildroot uses the following
@@ -164,8 +161,8 @@ Further formatting details: see xref:writing-rules-config-in[the
 coding style].
 
 [[dependencies-target-toolchain-options]]
-Dependencies on target and toolchain options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Dependencies on target and toolchain options
+
 Many packages depend on certain options of the toolchain: the choice of
 C library, C++ support, largefile support, thread support, RPC support,
 IPv6 support, wchar support, or dynamic library support. Some packages
@@ -268,8 +265,8 @@ use in the comment.
 ** Dependency symbol: +!BR2_PREFER_STATIC_LIB+
 ** Comment string: +dynamic library+
 
-Dependencies on a Linux kernel built by buildroot
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Dependencies on a Linux kernel built by buildroot
+
 Some packages need a Linux kernel to be built by buildroot. These are
 typically kernel modules or firmware. A comment should be added in the
 Config.in file to express this dependency, similar to dependencies on
@@ -285,8 +282,8 @@ kernel, use this format:
 foo needs a toolchain w/ featA, featB, featC and a Linux kernel to be built
 --------------------------
 
-Dependencies on udev /dev management
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Dependencies on udev /dev management
+
 If a package needs udev /dev management, it should depend on symbol
 +BR2_PACKAGE_HAS_UDEV+, and the following comment should be added:
 
@@ -301,8 +298,8 @@ management, use this format:
 foo needs udev /dev management and a toolchain w/ featA, featB, featC
 --------------------------
 
-The +.mk+ file
-~~~~~~~~~~~~~~
+=== The +.mk+ file
+
 [[adding-packages-mk]]
 
 Finally, here's the hardest part. Create a file named +libfoo.mk+. It
index faee3e9e697ffadd655681a60b4516b83c318a4c..1567487740dfc16ae02a1a5d78d7d573fddb3718 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for packages with specific build systems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== 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
@@ -11,8 +10,7 @@ system is based on hand-written Makefiles or shell scripts.
 
 [[generic-package-tutorial]]
 
-+generic-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +generic-package+ tutorial
 
 ------------------------------
 01: ################################################################################
@@ -159,8 +157,7 @@ Makefile code necessary to make your package working.
 
 [[generic-package-reference]]
 
-+generic-package+ reference
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +generic-package+ reference
 
 There are two variants of the generic target. The +generic-package+ macro is
 used for packages to be cross-compiled for the target.  The
index 98c994cdaf4198dacc4dc3c03ffab977ca0cf427..d265607672468708094d832370d548f0ded40709 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Gettext integration and interaction with packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Gettext integration and interaction with packages
 
 Many packages that support internationalization use the gettext
 library. Dependencies for this library are fairly complicated and
index d96c991cb04cfa0a3cec8aa2396eb8af784251e8..164315d9362c0fa1b8aa08104e6d1fd56f101481 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[hooks]]
-Hooks available in the various build steps
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Hooks available in the various build steps
 
 The generic infrastructure (and as a result also the derived autotools
 and cmake infrastructures) allow packages to specify hooks.
@@ -40,8 +39,7 @@ endef
 LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP
 ----------------------
 
-Using the +POST_RSYNC+ hook
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the +POST_RSYNC+ hook
 The +POST_RSYNC+ hook is run only for packages that use a local source,
 either through the +local+ site method or the +OVERRIDE_SRCDIR+
 mechanism. In this case, package sources are copied using +rsync+ from
index 6e68852d3f68ea5651d94a88b13cd98cb561bf3d..766a4fe2af1a77ab248b89a147278bae2021e616 100644 (file)
@@ -1,13 +1,11 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for LuaRocks-based packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Infrastructure for LuaRocks-based packages
 
 [[luarocks-package-tutorial]]
 
-+luarocks-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +luarocks-package+ tutorial
 
 First, let's see how to write a +.mk+ file for a LuaRocks-based package,
 with an example :
@@ -48,8 +46,7 @@ package to be built.
 
 [[luarocks-package-reference]]
 
-+luarocks-package+ reference
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +luarocks-package+ reference
 
 LuaRocks is a deployment and management system for Lua modules, and supports
 various +build.type+: +builtin+, +make+ and +cmake+. In the contetx of
index 53aacbd11c9eb52093a2d9bd8134012ded2e26ae..4062646f452d26a955de2df21ba6d816098d1562 100644 (file)
@@ -1,13 +1,11 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for Perl/CPAN packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Infrastructure for Perl/CPAN packages
 
 [[perl-package-tutorial]]
 
-+perl-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^
+==== +perl-package+ tutorial
 
 First, let's see how to write a +.mk+ file for a Perl/CPAN package,
 with an example :
@@ -67,8 +65,7 @@ following things should be checked.
 
 [[perl-package-reference]]
 
-+perl-package+ reference
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== +perl-package+ reference
 
 As a policy, packages that provide Perl/CPAN modules should all be
 named +perl-<something>+ in Buildroot.
index 8f78f8997361cd4febd585b5e05aad0cbd1ef53d..d7ce387778cbf3567556ce9d86ca9d51fe833fca 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for Python packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Infrastructure for Python packages
 
 This infrastructure applies to Python packages that use the standard
 Python setuptools mechanism as their build system, generally
@@ -10,8 +9,7 @@ recognizable by the usage of a +setup.py+ script.
 
 [[python-package-tutorial]]
 
-+python-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +python-package+ tutorial
 
 First, let's see how to write a +.mk+ file for a Python package,
 with an example :
@@ -61,8 +59,7 @@ built.
 
 [[python-package-reference]]
 
-+python-package+ reference
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +python-package+ reference
 
 As a policy, packages that merely provide Python modules should all be
 named +python-<something>+ in Buildroot. Other packages that use the
index ceaba8e0c22d0f10fe21d94cafa068b9d74cefc0..9266af6755df1e9d9627f84472b38f663095156b 100644 (file)
@@ -1,12 +1,10 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Tips and tricks
-~~~~~~~~~~~~~~~
+=== Tips and tricks
 
 [[package-name-variable-relation]]
-Package name, config entry name and makefile variable relationship
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Package name, config entry name and makefile variable relationship
 
 In Buildroot, there is some relationship between:
 
@@ -36,8 +34,7 @@ using the following rules:
 
 
 [[github-download-url]]
-How to add a package from github
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How to add a package from github
 
 Packages on github often don't have a download area with release tarballs.
 However, it is possible to download tarballs directly from the repository
index c1b5a0a4ab5e71c07aabc80a4bb7d34c061e4761..1c1116f2bc23ea8a303a7823c31857813221cb8c 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Infrastructure for virtual packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Infrastructure for virtual packages
 
 [[virtual-package-tutorial]]
 
@@ -16,16 +15,14 @@ The implementation of this API is different for the 'Allwinner Tech Sunxi' and
 the 'Texas Instruments OMAP35xx' plaftorms. So +libgles+ will be a virtual
 package and +sunxi-mali+ and +ti-gfx+ will be the providers.
 
-+virtual-package+ tutorial
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== +virtual-package+ tutorial
 
 In the following example, we will explain how to add a new virtual package
 ('something-virtual') and a provider for it ('some-provider').
 
 First, let's create the virtual package.
 
-Virtual package's +Config.in+ file
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Virtual package's +Config.in+ file
 
 The +Config.in+ file of virtual package 'something-virtual' should contain:
 
@@ -42,8 +39,7 @@ In this file, we declare two options, +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+ and
 +BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+, whose values will be used by the
 providers.
 
-Virtual package's +*.mk+ file
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Virtual package's +*.mk+ file
 
 The +.mk+ for the virtual package should just evaluate the +virtual-package+ macro:
 
@@ -60,8 +56,7 @@ The +.mk+ for the virtual package should just evaluate the +virtual-package+ mac
 The ability to have target and host packages is also available, with the
 +host-virtual-package+ macro.
 
-Provider's +Config.in+ file
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Provider's +Config.in+ file
 
 When adding a package as a provider, only the +Config.in+ file requires some
 modifications. The +*.mk+ file should follow the Buildroot infrastructure with
@@ -92,8 +87,7 @@ provider, but only if it is selected.
 Of course, do not forget to add the proper build and runtime dependencies for
 this package!
 
-Notes on depending on a virtual package
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Notes on depending on a virtual package
 
 When adding a package that requires a certain +FEATURE+ provided by a virtual
 package, you have to use +depends on BR2_PACKAGE_HAS_FEATURE+, like so:
@@ -107,8 +101,7 @@ config BR2_PACKAGE_FOO
     depends on BR2_PACKAGE_HAS_FEATURE
 ---------------------------
 
-Notes on depending on a specific provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Notes on depending on a specific provider
 
 If your package really requires a specific provider, then you'll have to
 make your package +depends on+ this provider; you can _not_ +select+ a
index dbba93055f2e4b0c8811ac06c5fb71dd1314d1c6..31f92f42afe322c785dd0f9751cd9768d9b01707 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[adding-packages]]
-Adding new packages to Buildroot
---------------------------------
+== Adding new packages to Buildroot
 
 This section covers how new packages (userspace libraries or
 applications) can be integrated into Buildroot. It also shows how
index fb337f5f71166b5bd3ff8ff789eb9f68c865fe5e..0ad79f7b1b670fe556944f0dc18357fc4d9b9be4 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Advanced usage
---------------
+== Advanced usage
 
 include::using-buildroot-toolchain.txt[]
 
index a83ecea1a74b910dfdd3b04db6e7b9575fe17bb5..35328c679779f16bd03233b20858d8f74bae8adc 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Appendix
-========
+= Appendix
 
 include::makedev-syntax.txt[]
 include::makeusers-syntax.txt[]
@@ -11,22 +10,19 @@ include::makeusers-syntax.txt[]
 // Automatically generated lists:
 
 [[package-list]]
-List of target packages available in Buildroot
-----------------------------------------------
+== List of target packages available in Buildroot
 
 include::package-list.txt[]
 
 [[host-package-list]]
-List of host utilities available in Buildroot
----------------------------------------------
+== List of host utilities available in Buildroot
 
 The following packages are all available in the menu +Host utilities+.
 
 include::host-package-list.txt[]
 
 [[deprecated-list]]
-Deprecated features
--------------------
+== Deprecated features
 
 The following features are marked as _deprecated_ in Buildroot due to
 them being either too old or unmaintained. They will be removed at
index a0d4af0a74df99a5af5aea1b70ece4a33c428306..5b99613ee5b631b9c1c1eb4e5e93e3613db3fbde 100644 (file)
@@ -1,14 +1,11 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Beyond Buildroot
-================
+= Beyond Buildroot
 
-Boot the generated images
--------------------------
+== Boot the generated images
 
-NFS boot
-~~~~~~~~
+=== NFS boot
 
 To achieve NFS-boot, enable _tar root filesystem_ in the _Filesystem
 images_ menu.
@@ -24,8 +21,7 @@ Remember to add this path to +/etc/exports+.
 
 Then, you can execute a NFS-boot from your target.
 
-Chroot
-------
+== Chroot
 
 If you want to chroot in a generated image, then there are few thing
 you should be aware of:
index fe06a01fafd3ead26f41c7d6df119cb97011ed82..c6771bd1e4b35663c09f79176643561bb5a5e98d 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[ccache]]
-Using +ccache+ in Buildroot
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== 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
index c9d5eb967b608bae85124b4381ef5ad631a8680b..3d5842d333ddb069d204db57c5063be4154f7f97 100644 (file)
@@ -1,13 +1,11 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Daily use
----------
+== Daily use
 
 include::rebuilding-packages.txt[]
 
-Offline builds
-~~~~~~~~~~~~~~
+=== Offline builds
 
 If you intend to do an offline build and just want to download
 all sources that you previously selected in the configurator
@@ -20,8 +18,7 @@ all sources that you previously selected in the configurator
 You can now disconnect or copy the content of your +dl+
 directory to the build-host.
 
-Building out-of-tree
-~~~~~~~~~~~~~~~~~~~~
+=== Building out-of-tree
 
 As default, everything built by Buildroot is stored in the directory
 +output+ in the Buildroot tree.
@@ -63,8 +60,7 @@ and +-C <...>+, simply run (in the output directory):
 
 [[env-vars]]
 
-Environment variables
-~~~~~~~~~~~~~~~~~~~~~
+=== Environment variables
 
 Buildroot also honors some environment variables, when they are passed
 to +make+ or set in the environment:
@@ -113,8 +109,7 @@ or +g+++ for building helper-binaries on your host, then do
  $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD
 --------------------
 
-Dealing efficiently with filesystem images
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Dealing efficiently with filesystem images
 
 Filesystem images can get pretty big, depending on the filesystem you choose,
 the number of packages, whether you provisioned free space... Yet, some
@@ -152,8 +147,7 @@ your filesystem, those parts may not be all-zeroes when read back). You
 should only use sparse files when handling files on the build machine, not
 when transferring them to an actual device that will be used on the target.
 
-Graphing the dependencies between packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Graphing the dependencies between packages
 
 [[graph-depends]]
 
@@ -204,8 +198,7 @@ supported.
 BR2_GRAPH_OUT=svg make graph-depends
 --------------------------------
 
-Graphing the build duration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Graphing the build duration
 
 [[graph-duration]]
 
index c1c9477a2ec6c34b6e47795b94aa2bd0ff5b812d..0f755fc122c4004070940b87e9319274e59223e0 100644 (file)
@@ -2,16 +2,14 @@
 // vim: set syntax=asciidoc:
 
 [[configure]]
-Details on Buildroot configuration
-----------------------------------
+== Details on Buildroot configuration
 
 All the configuration options in +make *config+ have a help text
 providing details about the option. However, a number of topics
 require additional details that cannot easily be covered in the help
 text and are there covered in the following sections.
 
-Cross-compilation toolchain
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Cross-compilation toolchain
 
 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+),
@@ -61,8 +59,7 @@ chosen, a number of configuration options appear, they are detailed in
 the following sections.
 
 [[internal-toolchain-backend]]
-Internal toolchain backend
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Internal toolchain backend
 
 The _internal toolchain backend_ is the backend where Buildroot builds
 by itself a cross-compilation toolchain, before building the userspace
@@ -128,8 +125,7 @@ Drawbacks of this backend:
   using the _External toolchain backend_.
 
 [[external-toolchain-backend]]
-External toolchain backend
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== External toolchain backend
 
 The _external toolchain backend_ allows to use existing pre-built
 cross-compilation toolchains. Buildroot knows about a number of
@@ -219,8 +215,7 @@ Drawbacks of this backend:
   fix from the toolchain vendor, unless you build your external
   toolchain by yourself using Crosstool-NG.
 
-/dev management
-~~~~~~~~~~~~~~~
+=== /dev management
 
 On a Linux system, the +/dev+ directory contains special files, called
 _device files_, that allow userspace applications to access the
@@ -309,8 +304,7 @@ needed, in which case *Dynamic using mdev* is usually a good solution.
 Note that if +systemd+ is chosen as init system, /dev management will
 be performed by the +udev+ program provided by +systemd+.
 
-init system
-~~~~~~~~~~~
+=== init system
 
 The _init_ program is the first userspace program started by the
 kernel (it carries the PID number 1), and is responsible for starting
index 47494cb3cad48f9ca133c42f6c68d790edc53cef..54da1028aea41041707bf9f02f80ee26196ff56f 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Contributing to Buildroot
-=========================
+= Contributing to Buildroot
 
 There are many ways in which you can contribute to Buildroot: analyzing
 and fixing bugs, analyzing and fixing package build failures detected by
@@ -23,8 +22,7 @@ source code tarball. Git is the easiest way to develop from and directly
 send your patches to the mailing list. Refer to xref:getting-buildroot[]
 for more information on obtaining a Buildroot git tree.
 
-Reproducing, analyzing and fixing bugs
---------------------------------------
+== Reproducing, analyzing and fixing bugs
 
 A first way of contributing is to have a look at the open bug reports in
 the https://bugs.busybox.net/buglist.cgi?product=buildroot[Buildroot bug
@@ -33,8 +31,7 @@ help in reproducing, analyzing and fixing reported bugs is more than
 welcome. Don't hesitate to add a comment to bug reports reporting your
 findings, even if you don't yet see the full picture.
 
-Analyzing and fixing autobuild failures
----------------------------------------
+== Analyzing and fixing autobuild failures
 
 The Buildroot autobuilders are a set of build machines that continuously
 run Buildroot builds based on random configurations. This is done for
@@ -79,8 +76,7 @@ basically two things that can be done:
 Fixes http://autobuild.buildroot.org/results/51000a9d4656afe9e0ea6f07b9f8ed374c2e4069
 ---------------------
 
-Reviewing and testing patches
------------------------------
+== Reviewing and testing patches
 
 With the amount of patches sent to the mailing list each day, the
 maintainer has a very hard job to judge which patches are ready to apply
@@ -146,8 +142,7 @@ Buildroot's Patchwork website can be used to pull in patches for testing
 purposes. Please see xref:apply-patches-patchwork[] for more
 information on using Buildroot's Patchwork website to apply patches.
 
-Work on items from the TODO list
---------------------------------
+== Work on items from the TODO list
 
 If you want to contribute to Buildroot but don't know where to start,
 and you don't like any of the above topics, you can always work on items
@@ -157,8 +152,7 @@ Do edit the wiki to indicate when you start working on an item, so we
 avoid duplicate efforts.
 
 [[submitting-patches]]
-Submitting patches
-------------------
+== Submitting patches
 
 [NOTE]
 _Please, do not attach patches to bugs, send them to the mailing list
@@ -202,8 +196,7 @@ If you do not use +git send-email+, make sure posted *patches are not
 line-wrapped*, otherwise they cannot easily be applied. In such a case,
 fix your e-mail client, or better yet, learn to use +git send-email+.
 
-Cover letter
-~~~~~~~~~~~~
+=== Cover letter
 
 If you want to present the whole patch set in a separate mail, add
 +--cover-letter+ to the +git format-patch+ command (see +man
@@ -222,8 +215,7 @@ in the following cases:
 * whenever you feel it will help presenting your work, your choices,
   the review process, etc.
 
-Patch revision changelog
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Patch revision changelog
 
 When improvements are requested, the new revision of each commit
 should include a changelog of the modifications between each
@@ -281,8 +273,7 @@ $ git format-patch --subject-prefix "PATCH v4" \
 ---------------------
 
 [[reporting-bugs]]
-Reporting issues/bugs or getting help
--------------------------------------
+== Reporting issues/bugs or getting help
 
 Before reporting any issue, please check
 xref:mailing-list-subscribe[the mailing list archive] in case someone has
index 981d534af7df85c14aa6ed1793c36b9296c13b23..ca1613d9ee42d35c58ab7a824e5c4a2dc1a9de07 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[busybox-custom]]
-Customizing the Busybox configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Customizing the Busybox configuration
 
 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
index a2d31ed8496424f5e874db3459840688019b2530..2cd58bc604927258c8efe1ead3dd4ed66c5ae5dc 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[kernel-custom]]
-Customizing the Linux kernel configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Customizing the Linux kernel configuration
 
 The Linux kernel configuration can be customized just like
 xref:busybox-custom[BusyBox] and xref:uclibc-custom[uClibc] using
index 6ee55a358ecf059465f8caa8f0bfce510f42f34e..f80ba704422534fb4714fb6fd1d71247f5a3b938 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc -*- ;
 
 [[outside-br-custom]]
-Keeping customizations outside Buildroot
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Keeping customizations outside Buildroot
 
 The Buildroot community recommends and encourages upstreaming to the
 official Buildroot version the packages and board support that are
index f141b7e045471b2ed46297b168910f5690544fd4..6f70bdb43f6d4f0deb763f978ad9764fc8abc333 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc -*- ;
 
 [[packages-custom]]
-Customizing packages
-~~~~~~~~~~~~~~~~~~~~
+=== Customizing packages
 
 It is sometimes useful to apply 'extra' patches to packages - over and
 above those provided in Buildroot. This might be used to support custom
index 2cbae99cfcd7371d8de0860143e1deff5370163c..8ae14035870f0505d456fb01eddcc562cf7bf0a4 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[rootfs-custom]]
-Customizing the generated target filesystem
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Customizing the generated target filesystem
 
 Besides changing one or another configuration through +make *config+,
 there are a few ways to customize the resulting target filesystem.
index 8fb5b57bb5dacf70722b91059e0318ab05efcd41..6db8ec78128519d9242b49fcd2ad20688016d07d 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[customize-store]]
-Storing the configuration
--------------------------
+== Storing the configuration
 
 When you have a buildroot configuration that you are satisfied with and
 you want to share it with others, put it under revision control or move
@@ -15,13 +14,11 @@ modifications.
 
 
 [[customize-store-basics]]
-Basics for storing the configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Basics for storing the configuration
 
 
 [[customize-store-buildroot-config]]
-Buildroot configuration
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Buildroot configuration
 
 For storing the buildroot configuration itself, buildroot offers the
 following command: +make savedefconfig+.
@@ -39,8 +36,7 @@ Alternatively, you can copy the file to any other place and rebuild with
 
 
 [[customize-store-package-config]]
-Other package configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Other package configuration
 
 The configuration files for busybox, the linux kernel, barebox and
 uClibc should be stored as well if changed. For each of these, a
@@ -76,8 +72,7 @@ configuration files easier.
 
 
 [[customize-store-board-support]]
-Creating your own board support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== 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
@@ -112,8 +107,7 @@ and configurations in these directories, and reference them from the main
 Buildroot configuration.
 
 
-Step-by-step instructions for storing configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Step-by-step instructions for storing configuration
 
 To store the configuration for a specific product, device or
 application, it is advisable to use the same conventions as for the
index 55a0480890b5684ab2d2362840f9b964c8a88b18..55114315a2500654802a903877e2cfebc589246c 100644 (file)
@@ -2,14 +2,12 @@
 // vim: set syntax=asciidoc:
 
 [[toolchain-custom]]
-Customizing the toolchain
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Customizing the toolchain
 
 There are three distinct types of toolchain backend supported in Buildroot,
 available under the menu +Toolchain+, invoking +make menuconfig+.
 
-Using the external toolchain backend
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the external toolchain backend
 
 There is no way of tuning an external toolchain since Buildroot does not
 generate it.
@@ -29,8 +27,7 @@ set the environment variable +BR2_DEBUG_WRAPPER+ to either one of:
 
 * +2+: trace one argument per line
 
-Using the internal Buildroot toolchain backend
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the internal Buildroot toolchain backend
 
 The internal Buildroot toolchain backend allows to generate toolchains
 based on http://www.uclibc.org/[uClibc],
index 53dea92db3c0ee19c88887b35546543f18249380..51330b0e2ca6f5fb101faedb55bf15547881d6cc 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[uclibc-custom]]
-Customizing the uClibc configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Customizing the uClibc configuration
 
 Just like xref:busybox-custom[BusyBox], http://www.uclibc.org/[uClibc]
 offers a lot of configuration options. They allow you to select
index 7e46fd8f353c3766681afa5a0285e3c506639515..48a32ea37066906d5362e616160376d75267c2d5 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Customization
--------------
+== Customization
 
 include::customize-rootfs.txt[]
 
index e558fcf3d10fb076a280702cdb3c3e867d7646cf..b97f633bef4012bf1404297f810ef5bb587d3323 100644 (file)
@@ -3,8 +3,7 @@
 
 [[debugging-buildroot]]
 
-Debugging Buildroot
--------------------
+== Debugging Buildroot
 
 It is possible to instrument the steps +Buildroot+ does when building
 packages. Define the variable +BR2_INSTRUMENTATION_SCRIPTS+ to contain
index 9054deef801005837e8e7afb8035480940112947..8c2b96cc9f7fadf50f93836e55d7379ca4b18b39 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Developer Guidelines
-====================
+= Developer Guidelines
 
 include::writing-rules.txt[]
 
index fe031a640ecccf7336e450968906220d7accbf9f..f2ccd149d6fb30ca860add2fa5e09ba0ab64ed5d 100644 (file)
@@ -3,7 +3,6 @@
 
 [[download-infra]]
 
-Download infrastructure
------------------------
+== Download infrastructure
 
 TODO
index db004496172df1ccc21283966a474c4d45780287..06a29a72a934c4f168fcc0d53fad210e1261dc02 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Location of downloaded packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Location of downloaded packages
 
 The various tarballs that are downloaded by Buildroot are all stored
 in +BR2_DL_DIR+, which by default is the +dl+ directory. If you want
index d1a42cf074cccbf5bf30a8ead22b0cb927247f08..17ccda5d71c6914b95d4075253c80ce47ec32b34 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Integration with Eclipse
-------------------------
+== Integration with Eclipse
 
 While a part of the embedded Linux developers like classical text
 editors like Vim or Emacs, and command-line based interfaces, a number
index 473b0e283b18cda6d50095300a0fcb1682f61870..2fdb53079d31e751e01ac136351eac6cc46e0f08 100644 (file)
@@ -1,12 +1,10 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Frequently Asked Questions & Troubleshooting
-============================================
+= Frequently Asked Questions & Troubleshooting
 
 [[faq-boot-hang-after-starting]]
-The boot hangs after 'Starting network...'
-------------------------------------------
+== The boot hangs after 'Starting network...'
 
 If the boot process seems to hang after the following messages
 (messages not necessarily exactly similar, depending on the list of
@@ -28,8 +26,7 @@ configuration+, and modify +Port to run a getty (login prompt) on+ and
 the correct serial port.
 
 [[faq-no-compiler-on-target]]
-Why is there no compiler on the target?
----------------------------------------
+== Why is there no compiler on the target?
 
 It has been decided that support for the _native compiler on the
 target_ would be stopped from the Buildroot-2012.11 release because:
@@ -53,8 +50,7 @@ distribution_ and you should opt for something like:
 * ...
 
 [[faq-no-dev-files-on-target]]
-Why are there no development files on the target?
--------------------------------------------------
+== Why are there no development files on the target?
 
 Since there is no compiler available on the target (see
 xref:faq-no-compiler-on-target[]), it does not make sense to waste
@@ -64,8 +60,7 @@ Therefore, those files are always removed from the target since the
 Buildroot-2012.11 release.
 
 [[faq-no-doc-on-target]]
-Why is there no documentation on the target?
---------------------------------------------
+== Why is there no documentation on the target?
 
 Because Buildroot mostly targets _small_ or _very small_ target
 hardware with limited resource onboard (CPU, ram, mass-storage), it
@@ -76,8 +71,7 @@ is not suitable for your purpose, and you should look for a _real
 distribution_ (see: xref:faq-no-compiler-on-target[]).
 
 [[faq-why-not-visible-package]]
-Why are some packages not visible in the Buildroot config menu?
----------------------------------------------------------------
+== Why are some packages not visible in the Buildroot config menu?
 
 If a package exists in the Buildroot tree and does not appear in the
 config menu, this most likely means that some of the package's
@@ -95,8 +89,7 @@ then you should certainly run a full rebuild (see xref:make-tips[] for
 more explanations).
 
 [[faq-why-not-use-target-as-chroot]]
-Why not use the target directory as a chroot directory?
--------------------------------------------------------
+== Why not use the target directory as a chroot directory?
 
 There are plenty of reasons to *not* use the target directory a chroot
 one, among these:
@@ -113,8 +106,7 @@ root, then use the tarball image generated in +images/+ and extract it
 as root.
 
 [[faq-no-binary-packages]]
-Why doesn't Buildroot generate binary packages (.deb, .ipkg...)?
-----------------------------------------------------------------
+== Why doesn't Buildroot generate binary packages (.deb, .ipkg...)?
 
 One feature that is often discussed on the Buildroot list is the
 general topic of "package management". To summarize, the idea
index 8475038d1899669e6eb6a9fedb36ddf62f0b7be9..4be88df165cc0979fe33a0a84bb873f5a9f737f2 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Getting involved
-================
+= Getting involved
 
 Like any open source project, Buildroot has different ways to share
 information in its community and outside.
@@ -12,8 +11,7 @@ One piece of it is the document you are currently reading ;-).
 Each of those ways may interest you if you are looking for some help,
 want to understand Buildroot or contribute to the project.
 
-Mailing List
-------------
+== Mailing List
 
 Buildroot has a mailing list
 http://lists.busybox.net/pipermail/buildroot[] for discussion and
@@ -21,8 +19,7 @@ development.
 
 [[mailing-list-subscribe]]
 
-Subscribing to the mailing list
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Subscribing to the mailing list
 
 You can subscribe by visiting
 http://lists.busybox.net/mailman/listinfo/buildroot[].
@@ -33,16 +30,14 @@ The list is also available through _Gmane_ http://gmane.org[], at
 +gmane.comp.lib.uclibc.buildroot+
 http://dir.gmane.org/gmane.comp.lib.uclibc.buildroot[].
 
-Searching the List Archives
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Searching the List Archives
 
 Please search the mailing list archives before asking questions on the
 mailing list, since there is a good chance someone else has asked the
 same question before. Checking the archives is a great way to avoid
 annoying everyone on the list with frequently asked questions...
 
-IRC
----
+== IRC
 
 The Buildroot IRC is irc://freenode.net/#buildroot[].
 The channel +#buildroot+ is hosted on Freenode
@@ -52,8 +47,7 @@ When asking for help on IRC, share relevant logs or pieces of code
 using a code sharing website.
 
 [[patchwork]]
-Patchwork
----------
+== Patchwork
 
 Patchwork is a web-based patch tracking system designed to facilitate
 the contribution and management of contributions to an open-source
@@ -72,8 +66,7 @@ The Buildroot patch management interface is available at
 http://patchwork.buildroot.org[].
 
 [[apply-patches-patchwork]]
-Applying Patches from Patchwork
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Applying Patches from Patchwork
 
 The main use of Buildroot's Patchwork website for a developer is for
 pulling in patches into their local git repository for testing
@@ -95,15 +88,13 @@ you can copy the +mbox+ link for the bundle and apply the bundle
 using the above commands.
 
 [[bugtracker]]
-Bugtracker
-----------
+== Bugtracker
 
 The Buildroot bugtracker is at https://bugs.busybox.net[].
 
 To open a bug, see xref:reporting-bugs[].
 
-Buildroot wikipage
-------------------
+== Buildroot wikipage
 
 After the Buildroot developer day on February 3, 2012,
 a page dedicated to Buildroot has been created on
@@ -114,21 +105,17 @@ This page is reachable at http://elinux.org/Buildroot[].
 Currently, this page is mainly used as a _todo-list_.
 
 [[events]]
-Events
-------
+== Events
 
-Buildroot Developer Days aside ELC-E 2012 (November 3-4, 2012 - Barcelona)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Buildroot Developer Days aside ELC-E 2012 (November 3-4, 2012 - Barcelona)
 
 * Event page: http://elinux.org/Buildroot:DeveloperDaysELCE2012[]
 
-Buildroot presentation at LSM 2012 (July 12-14, 2012 - Geneva)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Buildroot presentation at LSM 2012 (July 12-14, 2012 - Geneva)
 
 * Announcement: http://lists.busybox.net/pipermail/buildroot/2012-May/053845.html[]
 
-Buildroot Developer Days aside FOSDEM 2012 (February 3, 2012 - Brussels)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Buildroot Developer Days aside FOSDEM 2012 (February 3, 2012 - Brussels)
 
 * Announcement & agenda thread: http://lists.busybox.net/pipermail/buildroot/2012-January/049340.html[]
 * Report: http://lists.busybox.net/pipermail/buildroot/2012-February/050371.html[]
index 6b2a824f9da1997d71c78a80014aa4260f226389..d10ac4355e15ba324c09ed2827b024f2a8a8c203 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[getting-buildroot]]
-Getting Buildroot
------------------
+== Getting Buildroot
 
 Buildroot releases are made approximately every 3 months. Direct Git
 access and daily snapshots are also available, if you want more
index d3f183037a993f55016127b4cf7d2ed341b54a00..ac1c071f25c7050c28e9399710c8098cd82c0341 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Going further in Buildroot's innards
-====================================
+= Going further in Buildroot's innards
 
 include::how-buildroot-works.txt[]
 
index 5ef6e0ff3628456bd9981a8168b5123bf7c6855f..1204d1ecab4facf45fbcc7cf4c8983649345d8d6 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-How Buildroot works
--------------------
+== How Buildroot works
 
 As mentioned above, Buildroot is basically a set of Makefiles that
 download, configure, and compile software with the correct options. It
index c014565ab1cee6934dd485f9c5cb9e3079093f44..6a0b54b76d4e5a01849cfae70aa155e1ba433592 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-About Buildroot
-===============
+= About Buildroot
 
 Buildroot is a tool that simplifies and automates the process of
 building a complete Linux system for an embedded system, using
index 22710fb136f1bb022ff4c21a5218a6341fb3eac4..08469e937098d0b472d6e401b631b0eca003c21d 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Known issues
-============
+= Known issues
 
 * The +ltp-testsuite+ package does not build with the default uClibc
   configuration used by the Buildroot toolchain backend. The LTP
index c21012d089519802485c6d736224cde3dcc1f2e1..d4344b9fbe91c31b869970fc75ccc32f76a7f807 100644 (file)
@@ -3,11 +3,9 @@
 
 [[legal-info]]
 
-Legal notice and licensing
-==========================
+= Legal notice and licensing
 
-Complying with open source licenses
------------------------------------
+== Complying with open source licenses
 
 All of the end products of Buildroot (toolchain, root filesystem, kernel,
 bootloaders) contain open source software, released under various licenses.
@@ -71,8 +69,7 @@ When you run +make legal-info+, Buildroot produces warnings in the +README+
 file to inform you of relevant material that could not be saved.
 
 [[legal-info-list-licenses]]
-License abbreviations
----------------------
+== License abbreviations
 
 Here is a list of the licenses that are most widely used by packages in
 Buildroot, with the name used in the manifest files:
@@ -126,8 +123,7 @@ Buildroot, with the name used in the manifest files:
   http://apache.org/licenses/LICENSE-2.0.html[
   Apache License, version 2.0];
 
-Complying with the Buildroot license
-------------------------------------
+== Complying with the Buildroot license
 
 Buildroot itself is an open source software, released under the
 http://www.gnu.org/licenses/old-licenses/gpl-2.0.html[GNU General Public
index 81edae3e496207290cb7f74ab1c2fbb3efda73ac..13609434e86942d7391e74e25dbe21b1997a0d77 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[make-tips]]
-'make' tips
------------
+== 'make' tips
 
 This is a collection of tips that help you make the most of Buildroot.
 
index 2c985312b4aa6a2820aa5a8c186d93ccf409ebdc..2fd7b591511485766035df18f3fdf907d4b2f470 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[makedev-syntax]]
-Makedev syntax documentation
-----------------------------
+== Makedev syntax documentation
 
 The makedev syntax is used in several places in Buildroot to
 define changes to be made for permissions, or which device files to
index 21996546c774fc5480e803aa4bdc3b948e0909e2..9c616043b349751ce9c3b8850c9622519d4ff46d 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc -*- ;
 
 [[makeuser-syntax]]
-Makeuser syntax documentation
------------------------------
+== Makeuser syntax documentation
 
 The syntax to create users is inspired by the makedev syntax, above, but
 is specific to Buildroot.
index 958afae8a66daa126c949cab364d9007c65b8b50..94259f70eb304b2008e6e7b20c7644db68594650 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-The Buildroot user manual
-=========================
+= The Buildroot user manual
 :toc:
 
 Buildroot usage and documentation by Thomas Petazzoni. Contributions
index bd514f40e888ed41b2081b947cbc6ef7121f6ea6..61fecb484c2918b2580e336964c628137ff4df71 100644 (file)
@@ -3,8 +3,7 @@
 
 [[pkg-build-steps]]
 
-Package-specific _make_ targets
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Package-specific _make_ targets
 
 Running +make <package>+ builds and installs that particular package
 and its dependencies.
index c67d684fb2312c8e3ff419dd7a005481da9b5a17..cb39821492f3bdc4868cebbde85cb4be28abca35 100644 (file)
@@ -3,8 +3,7 @@
 
 [[patch-policy]]
 
-Patching a package
-------------------
+== Patching a package
 
 While integrating a new package or updating an existing one, it may be
 necessary to patch the source of the software to get it cross-built within
@@ -15,11 +14,9 @@ the builds. It supports three ways of applying patch sets: downloaded patches,
 patches supplied within buildroot and patches located in a user-defined
 global patch directory.
 
-Providing patches
-~~~~~~~~~~~~~~~~~
+=== Providing patches
 
-Downloaded
-^^^^^^^^^^
+==== Downloaded
 
 If it is necessary to apply a patch that is available for download, then add it
 to the +<packagename>_PATCH+ variable. It is downloaded from the same site
@@ -28,8 +25,7 @@ patch series.
 
 This method is typically used for packages from Debian.
 
-Within Buildroot
-^^^^^^^^^^^^^^^^
+==== Within Buildroot
 
 Most patches are provided within Buildroot, in the package
 directory; these typically aim to fix cross-compilation, libc support,
@@ -46,8 +42,7 @@ application order.
 reference in their filename.
 - The field +<number>+ in the patch file name refers to the 'apply order'.
 
-Global patch directory
-^^^^^^^^^^^^^^^^^^^^^^
+==== Global patch directory
 
 The +BR2_GLOBAL_PATCH_DIR+ configuration file option can be
 used to specify a space separated list of one or more directories
@@ -55,8 +50,7 @@ containing global package patches. See xref:packages-custom[] for
 details.
 
 [[patch-apply-order]]
-How patches are applied
-~~~~~~~~~~~~~~~~~~~~~~~
+=== How patches are applied
 
 . Run the +<packagename>_PRE_PATCH_HOOKS+ commands if defined;
 
@@ -87,8 +81,7 @@ How patches are applied
 
 If something goes wrong in the steps _3_ or _4_, then the build fails.
 
-Format and licensing of the package patches
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Format and licensing of the package patches
 
 Patches are released under the same license as the software that is
 modified.
@@ -130,8 +123,7 @@ AC_PROG_MAKE_SET
 +AM_CONDITIONAL([CXX_WORKS], [test "x$rw_cv_prog_cxx_works" = "xyes"])
 ---------------
 
-Integrating patches found on the Web
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Integrating patches found on the Web
 
 When integrating a patch of which you are not the author, you have to
 add a few things in the header of the patch itself.
index adc23eec51834579c40fea266aadb55f00ba1321..c5d5442024cf5d26bddcb5e359d9b52abf6cdd97 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[requirement]]
-System requirements
--------------------
+== System requirements
 
 Buildroot is designed to run on Linux systems.
 
@@ -17,8 +16,7 @@ for the libraries that may be packaged in 2 distinct packages.
 
 [[requirement-mandatory]]
 
-Mandatory packages
-~~~~~~~~~~~~~~~~~~
+=== Mandatory packages
 
 * Build tools:
 
@@ -45,8 +43,7 @@ Mandatory packages
 
 [[requirement-optional]]
 
-Optional packages
-~~~~~~~~~~~~~~~~~
+=== Optional packages
 
 * Source fetching tools:
 +
index b2d10decc734eda9dde6b3f9239fb39204b7dd6a..6faa67adcb5171bd53c25dd049b87667683fa8bd 100644 (file)
@@ -2,8 +2,7 @@
 // vim: set syntax=asciidoc:
 
 [[full-rebuild]]
-Understanding when a full rebuild is necessary
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Understanding when a full rebuild is necessary
 
 Buildroot does not attempt to detect what parts of the system should
 be rebuilt when the system configuration is changed through +make
@@ -82,8 +81,7 @@ $ make clean all
 ---------------
 
 [[rebuild-pkg]]
-Understanding how to rebuild packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== 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
index 7326f60c77984dc1983e5d9d7ea42655b5d74e76..8cb3a3a8b6c2f8dd0a2b8920ece1df6774216875 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Starting up
-===========
+= Starting up
 
 include::prerequisite.txt[]
 
index eaebeaf9feb300330cdf9c01c1deaa3b28b38a4d..e51e1a6ad181f02a3d51f94efb39eb81c7cda4ef 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Using Buildroot during development
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Buildroot during development
 
 The normal operation of Buildroot is to download a tarball, extract
 it, configure, compile and install the software component found inside
index b4db686256a28d08aa506af2d396dbe56d6de9b5..3e30cd73ca96822eee2466fdd5a756f39d939985 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Using the generated toolchain outside Buildroot
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== 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
index 4a33f7ee28bb544e6be85662a49cd498c0e62284..3cd149936a9f9110a83b092d6ccef05be77fe317 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Using Buildroot
----------------
+== Using Buildroot
 
 Buildroot has a nice configuration tool similar to the one you can
 find in the http://www.kernel.org/[Linux kernel] or in
index 4432b548db855c22652ee6a856453b3ea7979aa5..460eb5339ab6a026d1dd42cfa3977444f189a996 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Working with Buildroot
-======================
+= Working with Buildroot
 
 This section explains how you can customize Buildroot to fit your
 needs.
@@ -17,8 +16,7 @@ include::common-usage.txt[]
 
 include::eclipse-integration.txt[]
 
-Hacking Buildroot
------------------
+== Hacking Buildroot
 
 If Buildroot does not yet fit all your requirements, you may be
 interested in hacking it to add:
index 376dbfd6112d7c04daa461fdcb4a9411c677acf2..757e1c6c20fd7839356f174e0db602e2fd2a2a31 100644 (file)
@@ -1,8 +1,7 @@
 // -*- mode:doc; -*-
 // vim: set syntax=asciidoc:
 
-Coding style
-------------
+== Coding style
 
 Overall, these coding style rules are here to help you to add new files in
 Buildroot or refactor existing ones.
@@ -17,8 +16,7 @@ file,
 
 [[writing-rules-config-in]]
 
-+Config.in+ file
-~~~~~~~~~~~~~~~~
+=== +Config.in+ file
 
 +Config.in+ files contain entries for almost anything configurable in
 Buildroot.
@@ -49,8 +47,7 @@ http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[].
 
 [[writing-rules-mk]]
 
-The +.mk+ file
-~~~~~~~~~~~~~~
+=== The +.mk+ file
 
 * Header: The file starts with a header. It contains the module name,
 preferably in lowercase, enclosed between separators made of 80 hashes. A
@@ -135,8 +132,7 @@ LIBFOO_POST_INSTALL_TARGET_HOOKS += LIBFOO_REMOVE_DATA
 endif
 ---------------------
 
-The documentation
-~~~~~~~~~~~~~~~~~
+=== The documentation
 
 The documentation uses the
 http://www.methods.co.nz/asciidoc/[asciidoc] format.