From: g0dil Date: Wed, 19 Aug 2009 07:59:53 +0000 (+0000) Subject: Move debian and documentation specific parts of SConstruct into SConscript files X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=f214d8c456b57c851066b6dd437049938f8a91ee Move debian and documentation specific parts of SConstruct into SConscript files git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1302 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/.gitignore b/.gitignore index 4c0cac8..e32c449 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,11 @@ /local_config.hh /.prepare-stamp /libsenf.a +/build-arch-debug-stamp +/build-arch-final-stamp +/build-indep-stamp +/configure-stamp +/linklint # File name patters to ignore in all directories *.pyc @@ -10,6 +15,8 @@ *.o *.test.checked .sconsign* +*~ +#*# # File names to ignore in all directories all_includes.hh diff --git a/SConstruct b/SConstruct index a18c65e..2340272 100644 --- a/SConstruct +++ b/SConstruct @@ -3,71 +3,7 @@ import sys, glob, os.path, datetime, pwd, time, fnmatch, string sys.path.append(Dir('#/senfscons').abspath) sys.path.append(Dir('#/doclib').abspath) -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, sources=[]): - env.AlwaysBuild(env.Command(target + '.phony', [ 'SConstruct' ] + sources, env.Action(action))) - env.Alias(target, target + '.phony') - -def updateRevision(target, source, env): - rev = env['ENV']['REVISION'][1:] - if ':' in rev: - print - print "Working copy not clean. Run 'svn update'" - print - return 1 - if 'm' in rev and not ARGUMENTS.get('force_deb'): - print - print "Working copy contains local changes. Commit first" - print - return 1 - if 's' in rev: - rev = rev[:-1] - if 'm' in rev: - rev = rev[:-1] - url = None - for line in os.popen("svn info"): - elts=line.split(':',1) - if elts[0] == 'URL': - url = elts[1].strip() - version = None - if '/tags/' in url: - version = url.rsplit('/',1)[-1].split('_',1)[0] - if version[0] not in string.digits: - version = None - if version is None: - version = '1:0r%s' % rev - changelog = file('debian/changelog.template').read() % { - 'version': version, - 'rev': rev, - 'user': pwd.getpwuid(os.getuid()).pw_gecos.split(',')[0].strip(), - 'date': time.strftime("%a, %d %b %Y %H:%M:%S +0000", time.gmtime()) } - file('debian/changelog','w').write(changelog) - -def nonemptyFile(f): - try: return os.stat(f).st_size > 0 - except OSError: return False - -def checkLocalConf(target, source, env): - if [ True for f in env['LOCAL_CONFIG_FILES'] if nonemptyFile(f) ]: - print - print "You have made local modifications to one of the following local configuration" - print "files:" - for f in env['LOCAL_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 local" - print "configuration." - print - return 1 +import SENFSCons, senfutil ########################################################################### # Load utilities and setup libraries and configure build @@ -92,19 +28,6 @@ fixlinks Fix broken links in doxygen documentation valgrind Run all tests under valgrind/memcheck """) -if os.environ.get('debian_build'): - rev = os.popen("dpkg-parsechangelog | awk '/^Version:/{print $2}'").read().strip() -else: - rev = 'r' + os.popen("svnversion").read().strip().lower() - -logname = os.environ.get('LOGNAME') -if not logname: - logname = pwd.getpwuid(os.getuid()).pw_name - -def dpkgIgnoredFilesOpts(target, source, env, for_signature): - return [ '-I%s' % (('/' in f) and (os.path.split(os.getcwd())[1])+f or f) - for f in env.subst('$DPKG_IGNORED_FILES').split() ] - # Options used to debug inlining: # # INLINE_OPTS = [ '-finline-limit=20000', '--param','large-function-growth=10000', @@ -112,58 +35,26 @@ def dpkgIgnoredFilesOpts(target, source, env, for_signature): # '-fvisibility-inlines-hidden', '-fno-inline-functions', '-Winline' ] # # BEWARE: You need lots of ram to compile with these settings (approx 1G) -# INLINE_OPTS = [ '-finline-limit=5000' ] env.Append( - CPPPATH = [ '#/include' ], - CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ] + INLINE_OPTS, - LIBS = [ 'rt', '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB', - '$BOOSTFSLIB' ], + CPPPATH = [ '#/include' ], + CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ] + INLINE_OPTS, + LIBS = [ 'rt', '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB', + '$BOOSTFSLIB' ], TEST_EXTRA_LIBS = [ ], - ENV = { 'TODAY' : str(datetime.date.today()), - 'REVISION' : rev, - 'LOGNAME' : logname, # needed by the debian build scripts - 'CONCURRENCY_LEVEL' : env.GetOption('num_jobs') or "1", - 'SCONS' : 1, - 'PATH' : os.environ.get('PATH'), - 'TEXINPUTS' : os.environ.get('TEXINPUTS',env.Dir('#/doclib').abspath + ':'), - 'DOXYGEN' : os.environ.get('DOXYGEN', 'doxygen'), - }, - LOCAL_CONFIG_FILES = [ '/Doxyfile.local', '/SConfig', '/local_config.hh' ], - DPKG_IGNORED_FILES = [ '$LOCAL_CONFIG_FILES', '.svn', '/_templates' ], - DPKG_IGNORED_FILES_OPTS = dpkgIgnoredFilesOpts, - CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign', '.sconsign.dblite' ], - BUILDPACKAGE_COMMAND = "dpkg-buildpackage -us -uc -rfakeroot $DPKG_IGNORED_FILES_OPTS", - TOP_INCLUDES = [ 'Packets', 'PPI', 'Scheduler', 'Socket', 'Utils', 'Console', - 'config.hh', 'local_config.hh' ], - ALL_TAGFILES = [] + ENV = { 'PATH' : os.environ.get('PATH') }, + CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign', '.sconsign.dblite' ], ) -env.Replace( - DOXYGENCOM = "doclib/doxygen.sh $DOXYOPTS $SOURCE", -) - -def parseLogOption(value): - stream, area, level = ( x.strip() for x in value.strip().split('|') ) - if stream : stream = ''.join('(%s)' % x for x in stream.split('::') ) - else : stream = '(_)' - if area : area = ''.join( '(%s)' % x for x in area.split('::') ) - else : area = '(_)' - return '(( %s,%s,%s ))' % (stream,area,level) - -def expandLogOption(target, source, env, for_signature): - return ' '.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() ) - -if env.subst('$LOGLEVELS'): - env.Append( expandLogOption=expandLogOption ) - env.Append( CPPDEFINES = { 'SENF_LOG_CONF': '$expandLogOption' } ) - env.SetDefault( - LIBSENF = "senf" + LIBSENF = "senf" ) +# Parse the log option command line parameter into the SENF_LOG_CONF macro +senfutil.setLogOption(env) + Export('env') # Create Doxyfile.local otherwise doxygen will barf on this non-existent file @@ -185,23 +76,25 @@ if not env.GetOption('clean') and not os.path.exists("local_config.hh"): if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \ and not os.environ.get("SCONS") and COMMAND_LINE_TARGETS != [ 'prepare' ]: env.Execute([ "scons prepare" ]) - env.Clean('all', '.prepare-stamp') -SConscript(glob.glob("*/SConscript")) +# Load SConscripts. Need to load debian and doclib first (they change the global environment) +SConscript("debian/SConscript") +SConscript("doclib/SConscript") +SConscript(list(set(glob.glob("*/SConscript")) - set(("debian/SConscript", "doclib/SConscript")))) +# Define the main targets SENFSCons.StandardTargets(env) SENFSCons.GlobalTargets(env) -env.Depends( SENFSCons.Doxygen(env), env.Value(rev) ) -SENFSCons.InstallIncludeFiles(env, [ 'config.hh' ]) +env.Depends( SENFSCons.Doxygen(env), env.Value(env['ENV']['REVISION']) ) -# Build combined library 'libsenf' libsenf = env.Library(env.subst("$LIBSENF$LIBADDSUFFIX"), env['ALLOBJECTS']) env.Default(libsenf) env.Clean('all', libsenf) env.Alias('default', libsenf) +SENFSCons.InstallIncludeFiles(env, [ 'config.hh' ]) env.Alias('install_all', env.Install('$LIBINSTALLDIR', libsenf)) if env.GetOption('clean'): @@ -210,47 +103,19 @@ if env.GetOption('clean'): for pattern in env['CLEAN_PATTERNS'] for f in fnmatch.filter(files,pattern) ]) -PhonyTarget(env, 'deb', [ - checkLocalConf, - updateRevision, - "$BUILDPACKAGE_COMMAND", - "fakeroot ./debian/rules debclean" -]) - -PhonyTarget(env, 'debsrc', [ - updateRevision, - "$BUILDPACKAGE_COMMAND -S", -]) - -PhonyTarget(env, 'debbin', [ - checkLocalConf, - updateRevision, - "$BUILDPACKAGE_COMMAND -b", - "fakeroot ./debian/rules debclean" -]) - -PhonyTarget(env, 'linklint', [ - 'rm -rf linklint', - 'linklint -doc linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`', - '[ ! -r linklint/errorX.html ] || python doclib/linklint_addnames.py linklint/errorX.html.new', - '[ ! -r linklint/errorX.html.new ] || mv linklint/errorX.html.new linklint/errorX.html', - '[ ! -r linklint/errorAX.html ] || python doclib/linklint_addnames.py 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', [ 'true' ]) - -PhonyTarget(env, 'valgrind', [ - 'find -name .test.bin | while read test; do echo; echo "Running $$test"; echo; valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup $$test $BOOSTTESTARGS; [ $$? -ne 99 ] || exit 1; done' - ], [ 'all_tests' ]) +SENFSCons.PhonyTarget(env, 'prepare', [ 'true' ]) -env.Clean('all', env.Dir('linklint')) +SENFSCons.PhonyTarget(env, 'valgrind', [ """ + find -name .test.bin + | while read test; do + echo; + echo "Running $$test"; + echo; + valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup + $$test $BOOSTTESTARGS; + [ $$? -ne 99 ] || exit 1; + done +""".replace("\n"," ") ], [ 'all_tests' ]) -env.Clean('all','.prepare-stamp') if not env.GetOption('clean') and not os.path.exists(".prepare-stamp"): Execute(Touch(".prepare-stamp")) diff --git a/debian/SConscript b/debian/SConscript new file mode 100644 index 0000000..7069259 --- /dev/null +++ b/debian/SConscript @@ -0,0 +1,109 @@ +# -*- python -*- + +Import('env') +import SENFSCons, os + +########################################################################### + +def updateRevision(target, source, env): + rev = env['ENV']['REVISION'][1:] + if ':' in rev: + print + print "Working copy not clean. Run 'svn update'" + print + return 1 + if 'm' in rev and not ARGUMENTS.get('force_deb'): + print + print "Working copy contains local changes. Commit first" + print + return 1 + if 's' in rev: + rev = rev[:-1] + if 'm' in rev: + rev = rev[:-1] + url = None + for line in os.popen("svn info"): + elts=line.split(':',1) + if elts[0] == 'URL': + url = elts[1].strip() + version = None + if '/tags/' in url: + version = url.rsplit('/',1)[-1].split('_',1)[0] + if version[0] not in string.digits: + version = None + if version is None: + version = '1:0r%s' % rev + changelog = file('debian/changelog.template').read() % { + 'version': version, + 'rev': rev, + 'user': pwd.getpwuid(os.getuid()).pw_gecos.split(',')[0].strip(), + 'date': time.strftime("%a, %d %b %Y %H:%M:%S +0000", time.gmtime()) } + file('debian/changelog','w').write(changelog) + +def nonemptyFile(f): + try: return os.stat(f).st_size > 0 + except OSError: return False + +def checkLocalConf(target, source, env): + if [ True for f in env['LOCAL_CONFIG_FILES'] if nonemptyFile(f) ]: + print + print "You have made local modifications to one of the following local configuration" + print "files:" + for f in env['LOCAL_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 local" + print "configuration." + print + return 1 + +if os.environ.get('debian_build'): + rev = os.popen("dpkg-parsechangelog | awk '/^Version:/{print $2}'").read().strip() +else: + rev = 'r' + os.popen("svnversion").read().strip().lower() + +logname = os.environ.get('LOGNAME') +if not logname: + logname = pwd.getpwuid(os.getuid()).pw_name + +def dpkgIgnoredFilesOpts(target, source, env, for_signature): + return [ '-I%s' % (('/' in f) and (os.path.split(os.getcwd())[1])+f or f) + for f in env.subst('$DPKG_IGNORED_FILES').split() ] + +env.Append( ENV = { + 'REVISION': rev, + 'LOGNAME' : logname, # needed by the debian build scripts + 'CONCURRENCY_LEVEL' : env.GetOption('num_jobs') or "1", + 'SCONS' : 1, +}) + +env.Replace( + LOCAL_CONFIG_FILES = [ '/Doxyfile.local', '/SConfig', '/local_config.hh' ], + DPKG_IGNORED_FILES = [ '$LOCAL_CONFIG_FILES', '.svn', '/_templates' ], + DPKG_IGNORED_FILES_OPTS = dpkgIgnoredFilesOpts, + BUILDPACKAGE_COMMAND = "dpkg-buildpackage -us -uc -rfakeroot $DPKG_IGNORED_FILES_OPTS", +) + +SENFSCons.PhonyTarget(env, 'deb', [ + checkLocalConf, + updateRevision, + "$BUILDPACKAGE_COMMAND", + "fakeroot ./debian/rules debclean" +]) + +SENFSCons.PhonyTarget(env, 'debsrc', [ + updateRevision, + "$BUILDPACKAGE_COMMAND -S", +]) + +SENFSCons.PhonyTarget(env, 'debbin', [ + checkLocalConf, + updateRevision, + "$BUILDPACKAGE_COMMAND -b", + "fakeroot ./debian/rules debclean" +]) + diff --git a/doclib/SConscript b/doclib/SConscript index ab5a009..097ec6b 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -39,11 +39,7 @@ # 2. Regenerating header and/or footer # # If needed, the doxy-header.html and/or doxy-footer.html file will be -# regenerated. The dependencies are *not* complete, just adding a new -# subdirectory sadly does not automatically update the header (which -# contains the menu) -# -# The header and/or footer are written are generated from templates +# regenerated. The header and/or footer are generated from templates # using a simple python based templating system called yaptu which is # included in doclib/. # @@ -121,7 +117,7 @@ Import('env') -import SENFSCons +import SENFSCons, datetime, os ########################################################################### @@ -186,7 +182,10 @@ def indices(): if doc.name == "search.idx" ] def writeTemplate(target = None, source = None, env = None): - file(target[0].abspath,"w").write(yaptu.process(str(env['TEMPLATE']), globals(), env.Dictionary())) + file(target[0].abspath,"w").write(processTemplate(env)) + +def processTemplate(env): + return yaptu.process(str(env['TEMPLATE']), globals(), env.Dictionary()) writeTemplate = env.Action(writeTemplate, varlist = [ 'TEMPLATE' ]) @@ -274,11 +273,42 @@ function paths() { } ?>""" -env.Command('doxy-header.html', 'SConscript', writeTemplate, - TEMPLATE = Literal(HEADER), - TITLE = "Documentation and API reference") -env.Command('doxy-footer.html', 'SConscript', writeTemplate, - TEMPLATE = Literal(FOOTER)) +env.Append( ENV = { + 'TODAY' : str(datetime.date.today()), + 'TEXINPUTS' : os.environ.get('TEXINPUTS',env.Dir('#/doclib').abspath + ':'), + 'DOXYGEN' : env.get('DOXYGEN', 'doxygen'), +}) + +env.Replace( + ALL_TAGFILES = [], + DOXYGENCOM = "doclib/doxygen.sh $DOXYOPTS $SOURCE", +) + +SENFSCons.PhonyTarget(env, 'linklint', [ + 'rm -rf linklint', + 'linklint -doc linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`', + '[ ! -r linklint/errorX.html ] || python doclib/linklint_addnames.py linklint/errorX.html.new', + '[ ! -r linklint/errorX.html.new ] || mv linklint/errorX.html.new linklint/errorX.html', + '[ ! -r linklint/errorAX.html ] || python doclib/linklint_addnames.py 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"', +]) + +env.Clean('all', env.Dir('linklint')) + +SENFSCons.PhonyTarget(env, 'fixlinks', [ + 'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt', +]) + + +header = env.Command('doxy-header.html', 'SConscript', writeTemplate, + TEMPLATE = Literal(HEADER), + TITLE = "Documentation and API reference") +env.Depends(header, env.Value(repr(list(modules())))) + +footer = env.Command('doxy-footer.html', 'SConscript', writeTemplate, + TEMPLATE = Literal(FOOTER)) + env.Alias('all_docs', env.Command('search.php', [ 'html-munge.xsl', 'SConscript' ], [ writeTemplate, diff --git a/senfscons/Doxygen.py b/senfscons/Doxygen.py index 2de1bee..2b4530b 100644 --- a/senfscons/Doxygen.py +++ b/senfscons/Doxygen.py @@ -274,9 +274,22 @@ def DoxySourceScan(node, env, path): any files used to generate docs to the list of source files. """ dep_add_keys = ( - 'LAYOUT_FILE', '@INCLUDE', 'HTML_HEADER', 'HTML_FOOTER', 'TAGFILES', 'INPUT_FILTER' + ('HTML', 'LAYOUT_FILE'), + (None, '@INCLUDE'), + ('HTML', 'HTML_HEADER'), + ('HTML', 'HTML_FOOTER'), + (None, 'TAGFILES'), + (None, 'INPUT_FILTER'), ) + output_formats = { + "HTML" : ("YES", "html"), + "LATEX" : ("YES", "latex"), + "RTF" : ("NO", "rtf"), + "MAN" : ("YES", "man"), + "XML" : ("NO", "xml"), + } + default_file_patterns = ( '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', @@ -309,8 +322,9 @@ def DoxySourceScan(node, env, path): and not reduce(lambda x, y: x or fnmatch(f, y), exclude_patterns, False) ): sources.append(filename) - for key in dep_add_keys: - if data.has_key(key): + for fmt, key in dep_add_keys: + if data.has_key(key) and \ + (fmt is None or data.get("GENERATE_%s" % fmt, output_formats[fmt][0]).upper() == "YES"): elt = env.Flatten(env.subst_list(data[key])) sources.extend([ os.path.normpath(os.path.join(basedir,f)) for f in elt if f ]) diff --git a/senfscons/SENFSCons.py b/senfscons/SENFSCons.py index b6862e5..90b51c8 100644 --- a/senfscons/SENFSCons.py +++ b/senfscons/SENFSCons.py @@ -556,3 +556,6 @@ def AllIncludesHH(env, headers): file(target.abspath,"w").write("".join([ '#include "%s"\n' % f for f in headers ])) env.Clean('all', target) + +def PhonyTarget(env, target, action, sources=[]): + env.AlwaysBuild(env.Alias(target, sources, env.Action(action))) diff --git a/senfscons/senfutil.py b/senfscons/senfutil.py index 69f18e0..d1a2808 100644 --- a/senfscons/senfutil.py +++ b/senfscons/senfutil.py @@ -1,6 +1,23 @@ import os.path from SCons.Script import * +def setLogOption(env): + # Parse LOGLEVELS parameter + def parseLogOption(value): + stream, area, level = ( x.strip() for x in value.strip().split('|') ) + stream = ''.join('(%s)' % x for x in stream.split('::') ) + if area : area = ''.join( '(%s)' % x for x in area.split('::') ) + else : area = '(_)' + return '(( %s,%s,%s ))' % (stream,area,level) + + def expandLogOption(target, source, env, for_signature): + return ' '.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() ) + + if env.subst('$LOGLEVELS'): + env.Append( expandLogOption=expandLogOption ) + env.Append( CPPDEFINES = { 'SENF_LOG_CONF': '$expandLogOption' } ) + + ########################################################################### # This looks much more complicated than it is: We do three things here: # a) switch between final or debug options @@ -25,17 +42,6 @@ def SetupForSENF(env): LINKFLAGS_debug = [ '-g', '-rdynamic' ], ) - # Parse LOGLEVELS parameter - def parseLogOption(value): - stream, area, level = ( x.strip() for x in value.strip().split('|') ) - stream = ''.join('(%s)' % x for x in stream.split('::') ) - if area : area = ''.join( '(%s)' % x for x in area.split('::') ) - else : area = '(_)' - return '(( %s,%s,%s ))' % (stream,area,level) - - def expandLogOption(target, source, env, for_signature): - return ' '.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() ) - # Add command-line options: 'LOGLEVELS' and 'final' opts = Options() opts.Add( 'LOGLEVELS', 'Special log levels. Syntax: |[]| ...', @@ -45,12 +51,10 @@ def SetupForSENF(env): opts.Add( BoolOption('profile', 'Add profile information', False) ) opts.Update(env) - if env.subst('$LOGLEVELS'): - env.Append( expandLogOption=expandLogOption ) - env.Append( CPPDEFINES = { 'SENF_LOG_CONF': '$expandLogOption' } ) - env.Help(opts.GenerateHelpText(env)) + setLogOption(env) + # If we have a symbolic link (or directory) 'senf', we use it as our # senf repository if os.path.exists('senf'):