kumquat-buildroot/docs/manual
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
..
adding-board-support.txt
adding-packages-asciidoc.txt docs/manual: document the br2-external NAME 2016-10-16 13:01:02 +02:00
adding-packages-autotools.txt
adding-packages-cmake.txt pkg-cmake: allow to build package in a subdirectory 2015-03-13 22:34:43 +01:00
adding-packages-conclusion.txt
adding-packages-directory.txt docs/manual: fix packages having a subdirectory 2016-09-21 17:08:49 +02:00
adding-packages-generic.txt docs/manual: Document the variable $(PKG)_DL_OPTS 2016-08-23 14:59:01 +02:00
adding-packages-gettext.txt
adding-packages-hooks.txt core/pkg-generic: allow packages to declare target-finalize hooks 2016-07-05 15:48:48 +02:00
adding-packages-kconfig.txt docs/manual: update pkg-kconfig doc about <pkg>_KCONFIG_DOTCONFIG 2016-09-17 14:46:04 +02:00
adding-packages-kernel-module.txt docs/manual: add documentation for linux-ext and linux-tools. 2015-07-14 23:35:58 +02:00
adding-packages-linux-kernel-spec-infra.txt docs/manual: update the linux tools section 2016-09-22 12:32:34 +02:00
adding-packages-luarocks.txt
adding-packages-perl.txt docs/manual: document the br2-external NAME 2016-10-16 13:01:02 +02:00
adding-packages-python.txt docs/manual: document the br2-external NAME 2016-10-16 13:01:02 +02:00
adding-packages-rebar.txt
adding-packages-tips.txt docs/manual: Modify GitHub FOO_SITE explanation 2015-07-28 23:37:39 +02:00
adding-packages-virtual.txt manual: get rid of the lists of packages 2016-09-19 19:32:59 +02:00
adding-packages.txt docs/manual: add documentation for linux-ext and linux-tools. 2015-07-14 23:35:58 +02:00
advanced.txt
appendix.txt docs/manual: add appendix to convert old br2-external trees 2016-10-16 13:01:02 +02:00
beyond-buildroot.txt docs/manual/beyond-buildroot: additional minor fixes 2015-07-10 19:17:02 +02:00
br2-external-converting.txt docs/manual: document multi br2-external 2016-10-16 13:01:02 +02:00
ccache-support.txt ccache: support changing the output directory 2015-10-04 18:22:21 +02:00
common-usage.txt docs/manual: update graph-depends documentation about --stop-on 2016-02-08 21:29:38 +01:00
configure-other-components.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
configure.txt docs: update URL to uClibc-ng homepage 2016-10-14 16:49:35 +02:00
contribute.txt docs/manual: add new section about the DEVELOPERS file and get-developer 2016-09-21 09:17:58 +02:00
customize-configuration.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
customize-device-permission-tables.txt
customize-directory-structure.txt docs/manual: document the br2-external NAME 2016-10-16 13:01:02 +02:00
customize-outside-br.txt docs/manual: document both user-facing br2-external variables 2016-10-19 23:20:43 +02:00
customize-packages.txt docs/manual: document the br2-external NAME 2016-10-16 13:01:02 +02:00
customize-patches.txt docs/manual: update documentation about applying patches 2015-04-06 11:05:16 +02:00
customize-post-image.txt
customize-quick-guide.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
customize-rootfs.txt docs/manual: document BR2_ROOTFS_POST_FAKEROOT_SCRIPT 2016-07-04 15:22:57 +02:00
customize-users-tables.txt
customize.txt
debugging-buildroot.txt docs/manual: add list of instrumentation steps 2015-05-05 22:47:32 +02:00
developers.txt docs/manual: fix typo 2016-09-22 00:02:52 +02:00
download-infra.txt
download-location.txt docs/manual: fix bash export syntax in example code 2015-11-11 23:12:30 +01:00
eclipse-integration.txt
faq-troubleshooting.txt
getting.txt docs/manual: misc improvements to Vagrant usage documentation 2016-02-08 13:33:43 +01:00
how-buildroot-works.txt
introduction.txt
known-issues.txt docs/manual/known-issues: remove occurrences of eglibc 2016-06-28 22:27:27 +02:00
legal-notice.txt docs/manual: no warranty on output of legal-info 2016-10-03 23:19:07 +02:00
make-tips.txt docs/manual: add U-Boot configuration 2015-07-19 14:47:11 +02:00
makedev-syntax.txt makedevs: add capability support 2016-06-30 12:13:38 +02:00
makeusers-syntax.txt scripts/mkusers: allow users with no password value set 2015-06-09 23:13:41 +02:00
manual.mk manual: get rid of the lists of packages 2016-09-19 19:32:59 +02:00
manual.txt docs/manual: add new section about the DEVELOPERS file and get-developer 2016-09-21 09:17:58 +02:00
package-make-target.txt docs/manual: reinstall target 2015-02-03 18:08:32 +01:00
patch-policy.txt docs/manual: fix patch naming convention 2016-08-09 15:45:32 +02:00
prerequisite.txt docs/manual: relax python version requirement 2015-07-14 23:56:35 +02:00
quickstart.txt
rebuilding-packages.txt
resources.txt docs: use lists.buildroot.org to refer to the mailman archives 2015-09-14 14:50:40 +02:00
using-buildroot-debugger.txt
using-buildroot-development.txt manual: fix typo 2016-08-19 11:25:39 +02:00
using-buildroot-toolchain.txt
writing-rules.txt Document the 72 char limit on package description. 2015-07-13 12:16:45 +02:00