Go to file
Yann E. MORIN 29673c8b1e docs/manual: document both user-facing br2-external variables
While BR2_EXTERNAL_<NAME>_PATH was already documented, it was not
made obvious that it could be reused in post-biuld, post-image and
in-fakeroot scripts.

The BR2_EXTERNAL_<NAME>_DESC variable was not documented at all.

Update the manual to fix this.

Note: a2x chokes on this:

    .Note:
    Both +BR2_EXTERNAL_$(NAME)_PATH+ and +BR2_EXTERNAL_$(NAME)_DESC+ are
      available [...]

and spits out a totally useless error message:

    a2x: ERROR: "xsltproc" --stringparam toc.section.depth 1 --stringparam
    callout.graphics 0 --stringparam navig.graphics 0 --stringparam
    admon.textlabel 1 --stringparam admon.graphic 0 --stringparam
    chunk.section.depth 0 --output "/home/ymorin/dev/buildroot/O/docs/manual/manual.html"
    "/etc/asciidoc/docbook-xsl/xhtml.xsl"
    "/home/ymorin/dev/buildroot/O/docs/manual/manual.xml" returned
    non-zero exit status 6

So, we had to resort to using different quoting styles for each
variables. They are not semantically equivalent, but the rendering
is the same with the default CSS (which we are using). That's gonna
be good-enough for now...

Reported-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Benoît Allard <benoit.allard@greenbone.net>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2016-10-19 23:20:43 +02:00
arch MIPS: add support for P6600 cores 2016-10-15 13:22:17 +02:00
board configs/freescale_mpc8315erdb: remove U-Boot build 2016-10-15 23:14:44 +02:00
boot core: introduce per br2-external NAME 2016-10-16 13:01:02 +02:00
configs beaglebone: defconfigs: u-boot needs dtc 2016-10-19 17:54:22 +02:00
docs docs/manual: document both user-facing br2-external variables 2016-10-19 23:20:43 +02:00
fs fs/common: add option to execute custom scripts under fakeroot 2016-07-03 20:58:46 +02:00
linux linux: bump default to version 4.8.2 2016-10-18 22:15:41 +02:00
package docker-engine: add iptables runtime dependency 2016-10-19 23:18:45 +02:00
support core/br2-external: fix link to manual for converting old trees 2016-10-19 23:20:18 +02:00
system system: fix typo 2016-10-13 08:06:11 +02:00
toolchain toolchain/external: remove unused Linaro symlink hook 2016-10-16 13:08:21 +02:00
.defconfig arch: remove support for sh64 2016-09-08 22:15:15 +02:00
.gitignore
CHANGES CHANGES: fix typo in 2016.08 release line 2016-09-21 23:06:11 +02:00
Config.in core: do not hard-code inclusion of br2-external in Kconfig 2016-10-16 13:01:02 +02:00
Config.in.legacy wvstreams: remove deprecated package 2016-10-15 23:14:45 +02:00
COPYING
DEVELOPERS DEVELOPERS: add entry for libite 2016-10-16 18:04:22 +02:00
Makefile core: re-enter make if $(CURDIR) or $(O) are not canonical paths 2016-10-19 23:11:06 +02:00
Makefile.legacy Remove BR2_DEPRECATED 2016-10-15 23:14:45 +02:00
README

Buildroot is a simple, efficient and easy-to-use tool to generate embedded
Linux systems through cross-compilation.

The documentation can be found in docs/manual. You can generate a text
document with 'make manual-text' and read output/docs/manual/manual.text.
Online documentation can be found at http://buildroot.org/docs.html

To build and use the buildroot stuff, do the following:

1) run 'make menuconfig'
2) select the target architecture and the packages you wish to compile
3) run 'make'
4) wait while it compiles
5) find the kernel, bootloader, root filesystem, etc. in output/images

You do not need to be root to build or run buildroot.  Have fun!

Buildroot comes with a basic configuration for a number of boards. Run
'make list-defconfigs' to view the list of provided configurations.

Please feed suggestions, bug reports, insults, and bribes back to the
buildroot mailing list: buildroot@buildroot.org
You can also find us on #buildroot on Freenode IRC.

If you would like to contribute patches, please read
https://buildroot.org/manual.html#submitting-patches