docs/manual: document both user-facing br2-external variables
commit29673c8b1e5d5764fce58b2dcef839d412286552
authorYann E. MORIN <yann.morin.1998@free.fr>
Wed, 19 Oct 2016 20:56:05 +0000 (19 22:56 +0200)
committerThomas Petazzoni <thomas.petazzoni@free-electrons.com>
Wed, 19 Oct 2016 21:20:43 +0000 (19 23:20 +0200)
tree00ba7959ed2740520b030de06b4353da4482e940
parente30fa61d80b957fea9e22667bf83a2ccc3f35726
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>
docs/manual/customize-outside-br.txt