summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2016-01-01 13:14:42 +0100
committerMichał Górny <mgorny@gentoo.org>2016-01-08 06:14:36 +0100
commit7d4e00f503c79caafc53f931a094a57f144b123b (patch)
tree96f5d46840d07403e38ae29389b6588c497adfdc /eclass
parentscons-utils.eclass: Modernize the example to use usex (diff)
downloadgentoo-7d4e00f503c79caafc53f931a094a57f144b123b.tar.gz
gentoo-7d4e00f503c79caafc53f931a094a57f144b123b.tar.bz2
gentoo-7d4e00f503c79caafc53f931a094a57f144b123b.zip
scons-utils.eclass: Describe common issues with scons
Diffstat (limited to 'eclass')
-rw-r--r--eclass/scons-utils.eclass17
1 files changed, 16 insertions, 1 deletions
diff --git a/eclass/scons-utils.eclass b/eclass/scons-utils.eclass
index 2c52b5918e0..4b1fe497ca2 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
#