Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH] docs/manual: document both user-facing br2-external variables
Date: Wed, 19 Oct 2016 23:26:27 +0200	[thread overview]
Message-ID: <20161019232627.3e009bce@free-electrons.com> (raw)
In-Reply-To: <1476910565-11293-1-git-send-email-yann.morin.1998@free.fr>

Hello,

On Wed, 19 Oct 2016 22:56:05 +0200, Yann E. MORIN wrote:
> 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>
> ---
>  docs/manual/customize-outside-br.txt | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)

Applied to master, thanks.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

      reply	other threads:[~2016-10-19 21:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-19 20:56 [Buildroot] [PATCH] docs/manual: document both user-facing br2-external variables Yann E. MORIN
2016-10-19 21:26 ` Thomas Petazzoni [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20161019232627.3e009bce@free-electrons.com \
    --to=thomas.petazzoni@free-electrons.com \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox