From 7d4e00f503c79caafc53f931a094a57f144b123b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Micha=C5=82=20G=C3=B3rny?= Date: Fri, 1 Jan 2016 13:14:42 +0100 Subject: [PATCH] scons-utils.eclass: Describe common issues with scons --- eclass/scons-utils.eclass | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/eclass/scons-utils.eclass b/eclass/scons-utils.eclass index 2c52b5918e07..4b1fe497ca21 100644 --- a/eclass/scons-utils.eclass +++ b/eclass/scons-utils.eclass @@ -9,8 +9,23 @@ # @DESCRIPTION: # This eclass provides a set of function to help developers sanely call # dev-util/scons and pass parameters to it. -# @EXAMPLE: # +# Please note that SCons is more like a 'build system creation kit', +# and requires a lot of upstream customization to be used sanely. +# You will often need to request fixes upstream and/or patch the build +# system. In particular: +# +# 1. There are no 'standard' variables. To respect CC, CXX, CFLAGS, +# CXXFLAGS, CPPFLAGS, LDFLAGS, upstream needs to define appropriate +# variables explicitly. In some cases, upstreams respect envvars, +# in others you need to pass them as options. +# +# 2. SCons scrubs out environment by default and replaces it with some +# pre-defined values. To respect environment variables such as PATH, +# Upstreams need to explicitly get them from os.environ and copy them +# to the build environment. +# +# @EXAMPLE: # @CODE # inherit scons-utils toolchain-funcs # -- 2.26.2