CDB2.2 tool settings and configuration options in CDB2.2 userguide

The following table lists the options available to the users to configure the CDB for their needs in the properties file. The alternative switch (keyboard shortcut) is also provided, where available.

Option Name	Switch	Description	Default Value	Example
`cdb.env.epocroot`	`-e`	Set the EPOCROOT for the tool	EPOCROOT environment variable on system.	`cdb.env.epocroot = "p:\\" cdb -e p:\\ extractrelease some_release`
`cdb.env.epoc32tree`	`-t`	Set the path to epoc32	${cdb.env.epocroot}epoc32\\	`cdb.env.epoc32tree = "q:\\epoc32\\"`
`cdb.env.cppfilt`	None	The path to c++filt.exe for GCC DEF files	${cdb.env.epoc32tree}gcc\\bin\\c++filt.exe
`cdb.env.cppfilt.eabi`	None	The path to c++filt.exe for EABI DEF files	${cdb.env.epoc32tree}tools\\cdb\\c++filt.exe
`cdb.env.debug`	-debug	Sets debug mode on	False	If debug mode is on, the log level is adjusted automatically to capture more data, file logging is enabled. This is to assist in defect fixing.
`cdb.db.script`	None	The path to the DDL for the database	${cdb.env.epoc32tree}tools\\cdb\\cdb.sql
`cdb.db.path`	-d	The path to the Database	${cdb.env.epoc32tree}data\\cdb.db	`cdb.db.path = q:\\ cdb -d q:\\ extractrelease some_release`
`cdb.db.type`	None	The type of database to use	HSQLDB	No other database types are supported at present.
`cdb.extract.gxp.path`	None	The path to the GXP files	${cdb.env.epoc32tree}release\\gccxml\\urel\\
`cdb.extract.def.type`	None	The type of DEF file to expect	EABI
`cdb.log.file.enabled`	None	Enables or Disables the log file	FALSE	File logging should only be turned on where necessary as it slows performance.
`cdb.log.file.format`	None	Sets the pattern for the Log File logging	%-5p [%-20.20C{1}] %-8r %4L - %m%n	see Log4j documentation for a guide to patterns in Log4j
`cdb.log.file.path`	None	Path to the Log file	${cdb.env.epoc32tree}tools\\cdb\\cdb.log
`cdb.log.file.level`	None	Controls the Log level for the file	INFO	One of DEBUG, INFO, WARN, ERROR or CRITICAL.
`cdb.log.console.format`	None	Formats the console output	%-5p %m%n	See Log4j documentation for a guide to patterns in Log4j
`cdb.log.console.level`	None	Sets the debugging level for the console	INFO	One of DEBUG, INFO, WARN, ERROR or CRITICAL.
`cdb.report.stylesheet`	None	The XSL stylesheet for the report	${cdb.env.epoc32tree}tools\\cdb\\bcstyle.xsl
`cdb.extract.classifier.plugins`	`i`	Specifies the directory containing the classifier plug-in.	`${cdb.env.epoc32tree}plugins\\`
`cdb.extract.classifier.descriptor`	`C`	Specifies the plug-in to be used. Corresponds to a jar in the plugins directory.	`symbianclassifier`
`cdb.extract.classifier.init`	`a`	This is to specify the classifier plug-in specific information, for example, document location, DB login.	`${cdb.env.epoc32tree}data\\apiclassdoc.xml`
`cdb.extract.classifier.failonpluginerror`	None	If the plug-in has an error, then core cdb will either stop (if this equals true) or continue without API classification if this is set to false.	`FALSE`
`cdb.extract.report.comparepluginid`	None	During extraction, the ID of the plugin will be stored in the database created. During comparison, If IDs in the reference and the derived databases do not match, then the comparison will stop. To avoid this, set this property to false.	`FALSE`
`cdb.extract.report.classificationtightening`	None	If you change the classification method (including the classifier plugin) the classification values stored in the reference and deriver DBs may not correspond. In this case you can use this property to disable API classification checking.	`TRUE`

The following table shows the full command syntax for CDB.

-i <plugins_dir> is the plug-ins directory containing the plug-ins to be used for API classification. For example, the command for plug-ins in c:\example\: would be -i c:\example\.
-s <plugin_des> is the name of the plug-in to be used for API classification. For example, the command to use example.jar plug-in, would be -s example.

Command	Description
`cdb [global_options] help`	Displays CDB help and lists the available commands
`cdb [global_options] checkconfig`	Displays the configuration details of CDB, as set by the property file and command line (see configuration options)
`cdb [global_options] extractrelease <config_name> [-a <api_doc>][-i <plugins_dir>] [-s <plugin_des>]`	Extracts a release into the database. -a -location of API classification document. -i -directory containing the plug-ins. -s -name of the plug-in to be used.
`cdb [global_options] comparerelease <ref_config> -a <path_to_alt_db> <alt_config> [-r <report>] [-x <xsl_doc>] [-f <api_filter>]`	Compares two releases. `ref_config` Name of the reference (baseline) configuration. `path_to_alt_db` Path to the database containing the derived configuration. `alt_config` Name of the derived configuration. `-r <report>` Name of (and path to) the generated report. `-x <xsl_doc>` The stylesheet to use. `-f <api_filter>` The filter level for breaks; sets the minimum level a break requires in order to appear on the report.
`cdb [global_options] releaseinfo`	Displays the name of the configuration in the database, and the release of OS with which the configuration is associated.
`cdb version`	Displays the version of the CDB being used
`[global_options]`	The possible options which can control the way CDB operates. See Global options, for details.

CDB settings and configuration options

Configuration options

Command line options

Global options