kumquat-buildroot/docs/manual
Yann E. MORIN a930d9cef6 toolchain: linker options with a $ sign are not supported
As reported in bug #7172 [0], setting BR2_TARGET_LDFLAGS to a value
containing a $ sign can lead to unexpected results.

This is because it is very hard to know when the $ sign gets evaluated:
  - in the Buildroot-level make
  - in the shell called by the Buildroot-level make
  - in the package's own build-system, either at configure time, in the
    Makefile, in a shell in the Makefile...

So, it is very difficult to know how much escaping that would need.

A proposal is to use a shell variable to pass such values unmolested.
But it is not that simple either, since it still contains a $ sign, and
there is not much certainty as to when it would be evaluated.

Instead, just document this limitation, both in the help text for
BR2_TARGET_LDFLAGS, and in the known-issues section in the manual.

Does not really fix #7172, but at least the limitation is documented.

[0] https://bugs.buildroot.org/show_bug.cgi?id=7172

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Mike Zick <minimod@morethan.org>
Reviewed-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-07-31 23:51:39 +02:00
..
adding-packages-autotools.txt pkg-autotools: add support for <pkg>_AUTORECONF_ENV 2014-07-23 23:49:10 +02:00
adding-packages-cmake.txt
adding-packages-conclusion.txt
adding-packages-directory.txt docs/manual: enhance doc for BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_Y 2014-07-27 15:06:44 +02:00
adding-packages-generic.txt
adding-packages-gettext.txt
adding-packages-hooks.txt
adding-packages-luarocks.txt
adding-packages-perl.txt manual/adding-packages-perl.txt: remove the trailing slash sign from description of PERL_SITE variable 2014-07-31 23:17:07 +02:00
adding-packages-python.txt pkg-python: add staging installation support 2014-07-16 22:27:34 +02:00
adding-packages-tips.txt
adding-packages-virtual.txt
adding-packages.txt
advanced.txt
appendix.txt
beyond-buildroot.txt
ccache-support.txt
common-usage.txt
configure.txt
contribute.txt docs/manual: add sob line for patch series 2014-07-29 20:23:58 +02:00
customize-busybox-config.txt
customize-kernel-config.txt
customize-outside-br.txt
customize-packages.txt
customize-rootfs.txt
customize-store.txt
customize-toolchain.txt
customize-uclibc-config.txt
customize.txt
debugging-buildroot.txt
developer-guide.txt
download-infra.txt
download-location.txt
eclipse-integration.txt
faq-troubleshooting.txt
get-involved.txt
getting.txt
going-further.txt
how-buildroot-works.txt
introduction.txt
known-issues.txt toolchain: linker options with a $ sign are not supported 2014-07-31 23:51:39 +02:00
legal-notice.txt
make-tips.txt
makedev-syntax.txt
makeusers-syntax.txt
manual.mk
manual.txt
package-make-target.txt
patch-policy.txt
prerequisite.txt
rebuilding-packages.txt
starting-up.txt
using-buildroot-debugger.txt
using-buildroot-development.txt
using-buildroot-toolchain.txt
using.txt
working-with.txt
writing-rules.txt