Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



CDB settings and configuration options

CDB provides several options to support variety of development environments upon which the tool would run. Types of options that can be set are:

  1. Configuration options

  2. Command line options

  3. Global options


Configuration options

This table lists the options available to users of CDB to configure it for their needs in the properties file. The alternative keyboard shortcut is also provided, where available.

Option Name Keyboard Shortcut Explanation 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

[Top]


Command line options

This table below shows the full command syntax for CDB.

Command Description

cdb [global_options] help

Displays CDB help and lists 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>]

Extracts a release into the database. -a Location of API classification document.

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.

[Top]


Global options

This table summarises the global options which can be set regardless of the command being run.

Option Description

-e

Sets EPOCROOT for this run of the tool.

-t

Sets the path to the epoc32 directory.

-p

Sets the path to the correct properties file at start-up.

-d

Set the path to the database for this run of the tool.