Utils/Logger: Implement targets
[senf.git] / SConstruct
index 449ab7c..9870f20 100644 (file)
@@ -6,6 +6,12 @@ import SENFSCons
 
 ###########################################################################
 
+# This hack is needed for SCons V 0.96.1 compatibility. In current SCons versions
+# we can just use 'env.AlwaysBuild(env.Alias(target), [], action)'
+def PhonyTarget(env, target, action):
+    env.AlwaysBuild(env.Command(target + '.phony', 'SConstruct', env.Action(action)))
+    env.Alias(target, target + '.phony')
+
 def updateRevision(target, source, env):
     rev = env['ENV']['REVISION'][1:]
     if ':' in rev:
@@ -35,12 +41,16 @@ def nonemptyFile(f):
 def checkLocalConf(target, source, env):
     if [ True for f in env['CONFIG_FILES'] if nonemptyFile(f) ]:
         print
-        print "You have made local modifications to 'SConfig' and/or 'Doxyfile.local'."
+        print "You have made local modifications to one of the following local configuration"
+        print "files:"
+        for f in env['CONFIG_FILES']:
+            print "    ",f
+        print
         print "Building a debian package would remove those files."
         print
         print "To continue, remove the offending file(s) and try again. Alternatively,"
         print "build a source package using 'scons debsrc' and may then build debian"
-        print "binary packages from this source-package without disrupting your print local"
+        print "binary packages from this source-package without disrupting your local"
         print "configuration."
         print
         return 1
@@ -55,6 +65,7 @@ env = SENFSCons.MakeEnvironment()
 env.Help("""
 Additional top-level build targets:
 
+prepare      Create all source files not part of the repository
 all_tests    Build and run unit tests for all modules
 all_docs     Build documentation for all modules
 all          Build everything
@@ -63,6 +74,7 @@ deb          Build debian source and binary package
 debsrc       Build debian source package
 debbin       Build debian binary package
 linklint     Check links of doxygen documentation with 'linklint'
+fixlinks     Fix broken links in doxygen documentation
 """)
 
 if os.environ.get('debian_build'):
@@ -79,13 +91,14 @@ def configFilesOpts(target, source, env, for_signature):
 
 env.Append(
    CPPPATH = [ '#/include' ],
-   LIBS = [ 'iberty', '$BOOSTREGEXLIB' ],
+   LIBS = [ 'iberty', '$BOOSTREGEXLIB', '$BOOSTFSLIB' ],
    DOXY_XREF_TYPES = [ 'bug', 'fixme', 'todo', 'idea' ],
    DOXY_HTML_XSL = '#/doclib/html-munge.xsl',
    ENV = { 'TODAY' : str(datetime.date.today()),
            'REVISION' : rev,
            'LOGNAME' : logname, # needed by the debian build scripts
-           'CONCURRENCY_LEVEL' : env.GetOption('num_jobs') or "1"
+           'CONCURRENCY_LEVEL' : env.GetOption('num_jobs') or "1",
+           'SCONS' : 1
            },
    CONFIG_FILES = [ 'Doxyfile.local', 'SConfig', 'local_config.hh' ],
    CONFIG_FILES_OPTS = configFilesOpts,
@@ -97,8 +110,7 @@ env.Append(
 
 Export('env')
 
-# Create Doxyfile.local if not cleaning and the file does not exist
-# otherwise doxygen will barf on this non-existent file
+# Create Doxyfile.local 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"))
 
@@ -109,6 +121,16 @@ if not env.GetOption('clean') and not os.path.exists("local_config.hh"):
 ###########################################################################
 # Define build targets
 
+# Before defining any targets, check wether this is the first build in
+# pristine directory tree. If so, call 'scons prepare' so the dependencies
+# created later are correct
+
+if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \
+   and not os.environ.get("SCONS"):
+    env.Execute([ "scons prepare" ])
+
+env.Clean('all', '.prepare-stamp')
+
 SConscript(glob.glob("*/SConscript"))
 
 SENFSCons.StandardTargets(env)
@@ -125,34 +147,51 @@ libsenf = env.Library(
     SENFSCons.LibPath('senf'),
     Flatten([ env.File(SENFSCons.LibPath(lib)).sources for lib in env['ALLLIBS'] ]))
 env.Default(libsenf)
-env.Alias('install_all', env.Install('$LIBINSTALLDIR', libsenf))
-
-env.AlwaysBuild(
-    env.Alias('deb', [], [ checkLocalConf,
-                           updateRevision,
-                           "$BUILDPACKAGE_COMMAND" ]))
-
-env.AlwaysBuild(
-    env.Alias('debsrc', [], [ updateRevision,
-                              "$BUILDPACKAGE_COMMAND -S" ]))
+env.Clean('all', 'libsenf.a')
+env.Alias('default', 'libsenf.a')
 
-env.AlwaysBuild(
-    env.Alias('debbin', [], [ checkLocalConf,
-                              updateRevision,
-                              "$BUILDPACKAGE_COMMAND -nc" ]))
+env.Alias('install_all', env.Install('$LIBINSTALLDIR', libsenf))
 
 env.Clean('all', [ os.path.join(path,f)
                    for path, subdirs, files in os.walk('.')
                    for pattern in env['CLEAN_PATTERNS']
                    for f in fnmatch.filter(files,pattern) ])
 
-env.AlwaysBuild(env.Alias('linklint', [ 'all_docs' ], [
+PhonyTarget(env, 'deb', [
+    checkLocalConf,
+    updateRevision,
+    "$BUILDPACKAGE_COMMAND",
+])
+
+PhonyTarget(env, 'debsrc', [
+    updateRevision,
+    "$BUILDPACKAGE_COMMAND -S",
+])
+
+PhonyTarget(env, 'debbin', [
+    checkLocalConf,
+    updateRevision,
+    "$BUILDPACKAGE_COMMAND -nc",
+])
+
+PhonyTarget(env, 'linklint', [
     'rm -rf linklint',
-    'linklint -doc linklint -net -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
-    '[ -r linklint/errorX.html ] && python linklint_addnames.py <linklint/errorX.html >linklint/errorX.html.new',
-    '[ -r linklint/errorX.html.new ] && mv linklint/errorX.html.new linklint/errorX.html',
-    '[ -r linklint/errorAX.html ] && python linklint_addnames.py <linklint/errorAX.html >linklint/errorAX.html.new',
-    '[ -r linklint/errorAX.html.new ] && mv linklint/errorAX.html.new linklint/errorAX.html',
-    '@echo -e "\\nLokal link check results: linklint/index.html"',
-    '@echo -e "Remote link check results: linklint/urlindex.html\\n"'
-]))
+    'linklint -doc linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
+    '[ ! -r linklint/errorX.html ] || python linklint_addnames.py <linklint/errorX.html >linklint/errorX.html.new',
+    '[ ! -r linklint/errorX.html.new ] || mv linklint/errorX.html.new linklint/errorX.html',
+    '[ ! -r linklint/errorAX.html ] || python linklint_addnames.py <linklint/errorAX.html >linklint/errorAX.html.new',
+    '[ ! -r linklint/errorAX.html.new ] || mv linklint/errorAX.html.new linklint/errorAX.html',
+    'echo -e "\\nLokal link check results: linklint/index.html\\nRemote link check results: linklint/urlindex.html\\n"',
+])
+
+PhonyTarget(env, 'fixlinks', [
+    'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt',
+])
+
+PhonyTarget(env, 'prepare', [])
+
+env.Clean('all', env.Dir('linklint'))
+
+env.Clean('all','.prepare-stamp')
+if not env.GetOption('clean') and not os.path.exists(".prepare-stamp"):
+    Execute(Touch(".prepare-stamp"))