Better initial explanation of SConscript files; fix a misformatted table in the Stati...

git-svn-id: http://scons.tigris.org/svn/scons/trunk@540 fdb21ef1-2011-0410-befe-b5e4ea1792b1

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index a2f265f65d73962838cfff58cde5c063e9658cbd..3d5691ee58262e7a84756207f2773c2c28280b2c 100644 (file)
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -71,10 +71,25 @@ in the local directory,
 will internally change its working
 directory (chdir) to the directory containing the file.
 
+The
+.I SConstruct
+file can specify subsidiary
+configuration files using the
+.B SConscript()
+function.
+By convention,
+these subsidiary files are named
+.IR SConscript ,
+although any name may be used.
+(Because of this naming convention,
+the term "SConscript files"
+is sometimes used to refer
+generically to all
+.B scons
+configuration files,
+regardless of actual file name.)
+
 The configuration files
-(generically referred to as
-.I SConscript
-files)
 specify the target files to be built, and
 (optionally) the rules to build those targets.  Reasonable default
 rules exist for building common software components (executable
@@ -913,6 +928,7 @@ function:
 .ES
 bar_obj = env.StaticObject('bar.c', CCFLAGS='-DBAR')
 print "The path to bar_obj is:", str(bar_obj)
+.EE
 
 .B scons
 provides the following builders:

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 4e1ffec0b446537c0d214686a526ad60b54b13e0..48c7e089fd13f9245524c26780f40d9a4b66e1aa 100644 (file)
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -44,6 +44,9 @@ RELEASE 0.10 - XXX
     multiple source files specified; the target is now deduced from just
     the first source file in the list.
 
+  - Documentation fixes: better initial explanation of SConscript files;
+    fix a misformatted "table" in the StaticObject explanation.
+
   From Steve Leblanc:
 
   - Add a Clean() method to support removing user-specified targets