summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoranatoly techtonik <techtonik@gmail.com>2014-06-01 09:46:44 (GMT)
committeranatoly techtonik <techtonik@gmail.com>2014-06-01 09:46:44 (GMT)
commit2df3e0774d35b0685523dbbe89549d22d59cdde7 (patch)
treec6a7d681d675e555d445b843230e5d293a5c454d
parentf920678b73f0e0a09cbbd8977a54f915c661279d (diff)
downloadSCons-2df3e0774d35b0685523dbbe89549d22d59cdde7.zip
SCons-2df3e0774d35b0685523dbbe89549d22d59cdde7.tar.gz
SCons-2df3e0774d35b0685523dbbe89549d22d59cdde7.tar.bz2
Attempt to describe what SConf actually does for non-C programmers
-rw-r--r--src/engine/SCons/SConf.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/engine/SCons/SConf.py b/src/engine/SCons/SConf.py
index 068af3a..6cc8de8 100644
--- a/src/engine/SCons/SConf.py
+++ b/src/engine/SCons/SConf.py
@@ -1,6 +1,15 @@
"""SCons.SConf
Autoconf-like configuration support.
+
+In other words, this package allows to run series of tests to detect
+capabilities of current system and generate config files (header files
+in C/C++) that turn on system-specific options and optimizations.
+
+For example, it is possible to detect if optional libraries are present
+on current system and generate config that makes compiler include them.
+C compilers do not have ability to catch ImportError if some library is
+not found, so these checks should be done externally.
"""
#