CTBuild Instruction File Summary

The following instructions files are all of those found in and defined by the action in ctbuild/src/ctest_instructions.mk

*** Contents of instruction files are generally lists of file names *without* extensions or directory names ***

==    in top level of package only
LIBDEPS              external packages containing header files used by this package
HXXTYPE              header file extension (default .hpp)
CTEST_DIR            directory containing the components' test files

TXXTYPE              -obsolete- test file extension (default _t.cpp) top level only
CXXTYPE              -obsolete- source file extension (default .cpp) top level only
HEADER_DIR           -obsolete- directory containing the corresponding header files
INCLUDE_TYPES        -obsolete- additional header types (added to HXXTYPE)
INCLUDE_FILES        -obsolete- header files available to others, relative to top level

==    can be in any directory of package
SUBDIRS              list of subdirectories to process

CODEGEN              scripts to be run during the codegen phase

PYMODS               python modules to be copied to ${libdir}/
PYMOD_SUBDIR         subdirectory of ${libdir}/ to copy contents of PYMODS to
PYEXES               python files to be copied to ${bindir}
SCRIPTS              script files to be copied to ${bindir}

DBGEN_COMPONENTS     -d0omCORBA- dbgen components (need CD dbserver generator run)
PYIDL_COMPONENTS     -d0omCORBA- pyidl components (idl -> python)
IDL_COMPONENTS       -d0omCORBA- idl components (idl -> C++)
SQL_COMPONENTS       -d0omCORBA- sql components (embedded sql -> C)

D0OM_COMPONENTS      d0om components (C++ header files needing d0om dictionaries generated)
ROOT_COMPONENTS      root components (C++ header files needing root dictionaries generated)

OBJECT_COMPONENTS    bld *.o for components as C++ files
OBJECT_COMPONENTS_C  bld *.o for components as C files
OBJECT_COMPONENTS_F  bld *.o for components as Fortran files w/o preprocessing
OBJECT_COMPONENTS_FF bld *.o for components as Fortran files with preprocessing

COMPONENTS           bld lib*.a from components as C++ files
COMPONENTS_C         bld lib*.a from components as C files
COMPONENTS_F         bld lib*.a from components as Fortran files w/o preprocessing
COMPONENTS_FF        bld lib*.a from components as Fortran files with preprocessing

OBJECTS              list of objects on link line
BINARIES             binaries (exes) to build, C++ main
BINARIES_C           binaries (exes) to build, C main
BINARIES_F           binaries (exes) to build, Fortran main w/o preprocessing
BINARIES_FF          binaries (exes) to build, Fortran main with preprocessing

ITESTS               list of files to compile, link and run as integrated tests, C++
ITESTS_C             list of files to compile, link and run as integrated tests, C 
ITESTS_F             list of files to compile, link and run as integrated tests, Fortran w/o preproc
ITEST_FF             list of files to compile, link and run as integrated tests, Fortran /w preprocessing

INCLUDES             -obsolete- local header files available to others (not impl)
LIBRARIES            -obsolete- list of libraries on link line

test scripts search in following order:
  1) test specific:    <component>.sh or <itest>.sh
  2) package specific: run_component_test.sh or run_integrated_test.sh
  3) default script

• ROOT_COMPONENTS is a list of header files (without extensions) to have root dictionaries generated by rootcint. You must provide the corresponding linkdef files.
• If ROOT_COMPONENTS doesn't exist then the <header-name>_linkdef.h files in the source code directory are used to derive the list of header files which will have root dictionaries generated.
• rootcint will be run on <header-name>.hpp which must be in the package's header directory. It will use <header-name>_linkdef.h in the source code directory to determine which classes will have dictionaries generated. The file <header-name>_dict.cpp will be created in the package's ${tmpdir} and automatically compiled into the package's library.