Package bitten :: Package build :: Module ctools

Module ctools

Recipe commands for build tasks commonly used for C/C++ projects.
Functions
 
configure(ctxt, file_='configure', enable=None, disable=None, with_=None, without=None, cflags=None, cxxflags=None, prefix=None, **kw)
Run a configure script.
 
autoreconf(ctxt, file_='configure', force=None, install=None, symlink=None, warnings=None, prepend_include=None, include=None)
Run the autotoll autoreconf.
 
make(ctxt, target=None, file_=None, keep_going=False, directory=None, jobs=None, args=None)
Execute a Makefile target.
 
cppunit(ctxt, file_=None, srcdir=None)
Collect CppUnit XML data.
 
cunit(ctxt, file_=None, srcdir=None)
Collect CUnit XML data.
 
gcov(ctxt, include=None, exclude=None, prefix=None, root='')
Run gcov to extract coverage data where available.
Variables
  log = logging.getLogger('bitten.build.ctools')
  __package__ = 'bitten.build'
Function Details

configure(ctxt, file_='configure', enable=None, disable=None, with_=None, without=None, cflags=None, cxxflags=None, prefix=None, **kw)

 
Run a configure script.
Parameters:
  • ctxt (Context) - the build context
  • file_ - name of the configure script
  • enable - names of the features to enable, seperated by spaces
  • disable - names of the features to disable, separated by spaces
  • with_ - names of external packages to include
  • without - names of external packages to exclude
  • cflags - CFLAGS to pass to the configure script
  • cxxflags - CXXFLAGS to pass to the configure script
  • prefix - install prefix to pass to the configure script, will be postfixed by the machine name from the build

autoreconf(ctxt, file_='configure', force=None, install=None, symlink=None, warnings=None, prepend_include=None, include=None)

 
Run the autotoll autoreconf.
Parameters:
  • ctxt (Context) - the build context
  • force - consider all files obsolete
  • install - copy missing auxiliary files
  • symlink - install symbolic links instead of copies
  • warnings - report the warnings falling in CATEGORY
  • prepend_include - prepend directories to search path
  • include - append directories to search path

make(ctxt, target=None, file_=None, keep_going=False, directory=None, jobs=None, args=None)

 
Execute a Makefile target.
Parameters:
  • ctxt (Context) - the build context
  • file_ - name of the Makefile
  • keep_going - whether make should keep going when errors are encountered
  • directory - directory in which to build; defaults to project source directory
  • jobs - number of concurrent jobs to run
  • args - command-line arguments to pass to the script

cppunit(ctxt, file_=None, srcdir=None)

 
Collect CppUnit XML data.
Parameters:
  • ctxt (Context) - the build context
  • file_ - path of the file containing the CppUnit results; may contain globbing wildcards to match multiple files
  • srcdir - name of the directory containing the source files, used to link the test results to the corresponding files

cunit(ctxt, file_=None, srcdir=None)

 
Collect CUnit XML data.
Parameters:
  • ctxt (Context) - the build context
  • file_ - path of the file containing the CUnit results; may contain globbing wildcards to match multiple files
  • srcdir - name of the directory containing the source files, used to link the test results to the corresponding files

gcov(ctxt, include=None, exclude=None, prefix=None, root='')

 
Run gcov to extract coverage data where available.
Parameters:
  • ctxt (Context) - the build context
  • include - patterns of files and directories to include
  • exclude - patterns of files and directories that should be excluded
  • prefix - optional prefix name that is added to object files by the build system
  • root - optional root path in which the build system puts the object files