ATLAS     Level 1     Calorimeter Trigger     Software    

L1Calo Software L1CaloPolicy

 

Introduction

The L1Calo CMT policy package (l1calo/L1CaloPolicy) is the base of our CMT package hierarchy. All other L1Calo packages use L1CaloPolicy. It defines our working model for using CMT and provides some useful CMT make fragments and patterns which can be used by our other packages.

L1CaloPolicy itself uses the OnlinePolicy package from the Online software group. So most aspects of our CMT working model are adopted from theirs which is described here.

In addition to the facilities defined by OnlinePolicy, L1CaloPolicy adds the following:

  • tarfile target. This is a makefile fragment which can be executed using make tarfile from the cmt directory. It creates a tar file, stored in l1calo/tarfiles containing all but the binary directories of the package. To make tar files of all our packages, use cmt broadcast make tarfile from our L1CaloRelease package.
  • veryclean target. This is a makefile fragment which can be executed using make veryclean from the cmt directory. It completely removes the CMT binary directory (ie $CMTCONFIG).
  • instclean target. This is a makefile fragment which can be executed using make instclean from the cmt directory. It removes most of (but not necessarily all of) the files which are installed by make install. It certainly removes all installed headers, libraries and applications, but it may not be able to remove files installed in non standard areas.
  • dox target. This runs the doxygen and javadoc makefile fragments.
  • doxygen makefile fragment and global pattern. This generates Doxygen documentation for the package. It expects to find a DoxyMainPage file in your dox subdirectory. By default it will use a common DoxyFile control file, but you can alternatively provide a customised one in your own dox subdirectory. The common DoxyFile supplies everything except the package title which must be set using the doxygen_title macro in your requirements file.
  • javadoc makefile fragment and global pattern. This generates Javadoc documentation for the package. It looks for java source files in your jsrc subdirectory and also for generated java code in the $CMTCONFIG/java subdirectory.
  • gdbinit global pattern. This is a makefile fragment which is executed automatically and updates the .gdbinit in the installed area with the directories in this package which contain source code.
  • moc makefile fragment. This can be used in document commands in your requirements file to invoke the Qt meta object compiler (moc) to generate the Qt support code for Qt subclasses.
  • uic makefile fragment. This can be used in document commands in your requirements file to invoke the Qt user interface compiler (uic) to generate the header and class files for user interface components created by the Qt designer.

Dependencies

The L1CaloPolicy package uses the OnlinePolicy from the Online software.

Source Code

Status

Under development...


Last updated on 22-Sep-2004 by Murrough Landon