lsst.sconsUtils  15.0-1-gcea188a
Public Member Functions | List of all members
lsst.sconsUtils.dependencies.ExternalConfiguration Class Reference

A Configuration subclass for external (third-party) packages. More...

Inheritance diagram for lsst.sconsUtils.dependencies.ExternalConfiguration:
lsst.sconsUtils.dependencies.Configuration

Public Member Functions

def __init__ (self, cfgFile, headers=(), libs=None, eupsProduct=None)
 Initialize the configuration object. More...
 
- Public Member Functions inherited from lsst.sconsUtils.dependencies.Configuration
def __init__ (self, cfgFile, headers=(), libs=None, hasSwigFiles=True, includeFileDirs=["include"], libFileDirs=["lib"], hasDoxygenInclude=False, hasDoxygenTag=True, eupsProduct=None)
 Initialize the configuration object. More...
 
def addCustomTests (self, tests)
 Add custom SCons configuration tests to the Configure Context passed to the configure() method. More...
 
def configure (self, conf, packages, check=False, build=True)
 Update an SCons environment to make use of the package. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.sconsUtils.dependencies.Configuration
def parseFilename (cfgFile)
 
def getEupsData (eupsProduct)
 
- Public Attributes inherited from lsst.sconsUtils.dependencies.Configuration
 root
 
 eupsProduct
 
 version
 
 doxygen
 
 libs
 
 paths
 
 provides
 

Detailed Description

A Configuration subclass for external (third-party) packages.

Aliased as lsst.sconsUtils.ExternalConfiguration.

ExternalConfiguration doesn't assume the package uses SWIG or Doxygen, and tells SCons not to consider header files this package provides as dependencies (by setting XCPPPATH instead of CPPPATH). This means things SCons won't waste time looking for changes in it every time you build. Header files in external packages are treated as "system headers": that is, most warnings generated when they are being compiled are suppressed.

Constructor & Destructor Documentation

◆ __init__()

def lsst.sconsUtils.dependencies.ExternalConfiguration.__init__ (   self,
  cfgFile,
  headers = (),
  libs = None,
  eupsProduct = None 
)

Initialize the configuration object.

Parameters
cfgFileThe name of the calling .cfg file, usually just passed in with the special variable file. This will be parsed to extract the package name and root.
headersA list of headers provided by the package, to be used in autoconf-style tests.
libsA list or dictionary of libraries provided by the package. If a dictionary is provided, libs["main"] should contain a list of regular libraries provided by the library. Other keys are "python" and "test", which refer to libraries that are only linked against compiled Python modules and unit tests, respectively. If a list is provided, the list is used as "main". These are used both for autoconf-style tests and to support env.getLibs(...), which recursively computes the libraries a package must be linked with.

References lsst.sconsUtils.dependencies.Configuration.paths.


The documentation for this class was generated from the following file: