Complete SENFSCons documentation

[senf.git] / SConstruct

diff --git a/SConstruct b/SConstruct
index 87c1beb..8198009 100644 (file)
--- a/SConstruct
+++ b/SConstruct
@@ -6,16 +6,19 @@ import SENFSCons
 
 ###########################################################################
 
+# Load subversion information
 svninfo = dict(
     [ map(lambda y:y.strip(),x.split(":",1))
       for x in os.popen("svn info").read().split("\n")
       if ':' in x ] )
 svninfo['commited'] = not(os.popen("svn status -q").read())
 
+# Load utilities and setup libraries
 SENFSCons.UseBoost()
 SENFSCons.UseSTLPort()
 env = SENFSCons.MakeEnvironment()
 
+# Configure build
 env.Append(
    CPPPATH = [ '#' ],
    LIBS = [ 'iberty' ],
@@ -28,6 +31,7 @@ env.Append(
 
 Export('env')
 
+# Build modules (that is, instruct to build ... the build happens later)
 SConscript(glob.glob("*/SConscript"))
 
 SENFSCons.StandardTargets(env)
@@ -37,5 +41,7 @@ SENFSCons.DoxyXRef(env,
                    HTML_HEADER = '#/doclib/doxy-header-overview.html',
                    HTML_FOOTER = '#/doclib/doxy-footer.html')
 
+# Create Doxyfile.local if not cleaning and the file does not exist
+# otherwise doxygen will barf on this non-existent file
 if not env.GetOption('clean') and not os.path.exists("Doxyfile.local"):
     Execute(Touch("Doxyfile.local"))