Reference for integration project and build properties
From current
Integration build analysis > Reference for integration project and build properties
Contents |
Project properties displayed by kwadmin
The following table provides a list of project properties displayed by the command kwadmin get-project-properties. Those properties that are editable can be set with kwadmin set-project-property.
| Property | Description | OK to edit? | Allowable values | Example value |
| auto_delete_threshold | specifies the number of builds to save when the auto delete feature is enabled | yes | Numerical value; pass a null value to turn off the retention policy | 10 |
| bug_tracker_schema | Used to replace {0} with id, and convert id to a hyperlink | N/A | url pattern that passes the information to the bug tracker url | https://bugs.example.com/project/id={0} |
| clef_options | options controlling creation of the C/C++ knowledge base | yes | comma-separated list of options for kwlef | --errors-config=problems_default.pconf.xml |
| compiler_options | compiler options used for C and C++ projects | yes | comma-separated list of compiler options for kwbuildproject | --windows,--errors-config=problems_default.pconf.xml,--honor-std |
| copy_sources | specifies whether project source files will be copied to projects_root by default | yes | true or false | false |
| copy_tables | specifies whether Klocwork tables will be copied to projects_root by kwadmin load | yes | true or false | true |
| creator | user ID under which the project was created | no | N/A | joebloggs |
| database.host | Database Server host name | no | N/A | myserver.acme.com |
| database.port | Database Server port | no | N/A | 3306 |
| database.started_by | user ID that started the Database Server | no | N/A | adminuser |
| db_schema | Database schema version. Appears only for projects converted from a previous release. | 07-01-00 | ||
| database.type | Database type | no | name of database type | mysql |
| database.user | the user who started the Database Server | no | N/S | kw |
| description | project description | yes (editable in Klocwork Review) | N/A | This project contains toolbus source code. |
| incompatible_server_versions | server versions that are incompatible with the current projects_root directory | no | N/A | 6.1,7.0 |
| java.sembase | Java-language semantic base | no | path to semantic base | C:\Source_files\Apache_binary\apache-tomcat-5.5.15\server\webapps\manager\WEB-INF\lib\commons-fileupload-1.0.jar |
| java_compiler_options | compiler options used for Java projects | yes | comma-separated list of options for kwjava | -source,1.4 |
| javadoc.url | specifies one or more a Java documentation locations, usually a URL, that can be accessed by users of Klocwork Architect and Klocwork Review | yes | semi-colon separated list of URLs | http://java.sun.com/j2se/1.5.0/docs/api/ |
| language | programming language of the source files in the project | yes | comma-separated list. Acceptable values: c, cxx, java, csharp | c,cxx |
| lefjava_options | options controlling creation of Java knowledge base | yes | comma-separated list of options for Java logical error finder (kwjava) | --errors-config=java_default.jpconf.xml |
| linker_options | linker options | yes | comma-separated list of options for kwlinker | --object-oriented |
| license.host | License Server host name | no | N/A | myserver.acme.com |
| license.port | License Server port | no | N/A | 27000 |
| locale | overrides the locale for the project set during project creation. Should only be set before running an integration build analysis with kwbuildproject, so that the language of issue messages and traceback will be consistent in all builds | yes | en, ja | ja |
| project_creation_time_stamp | project creation timestamp; localized by Klocwork Review | no | N/A | 1136234753965 |
| project_creation_version | for internal use | no | N/A | 21.0 |
| project_host | name of the machine where the project was created | no | N/A | myserver.acme.com |
| project_version | for internal use | no | 21.0 | |
| projects_root_creation_version | for internal use | no | N/A | 21.0 |
| report_options | report options shared with desktop analysis tools | yes | comma-separated list. Acceptable values: all shared configuration files. | --error-config=problems_default.pconf.xml,--metrics-config=metrics_default.mconf,--usage-rules=usagerules_default.uconf |
| source.bsf | location of the build specifications used to analyze the project | no | comma-separated list of project build specification files | C:\klocwork\myproject.out |
| source.root | root directories of Java source files used in the project | no | N/A | C:\temp\Klocwork\sources\apache |
| source.tables | location of pre-built tables used for the project | no | N/A | C:\klocwork\projects_root\projects\MyProject\builds\build_4\tables |
| source.vs_file | location of Visual Studio .project or .sln file | yes | path to .project or .sln file | C:\Source_files\FileZilla\source\FileZilla.vcproj |
| source_encoding | language encoding of project source files. See kwadmin create-project. | yes | language encodings. Use the --list option of kwconv to find the list of acceptable values. | utf-8 |
| use_default_rt | specifies that the default rt.jar should be used for the project. Applicable only to Java language-level 1.4 projects. Automatically updated if language level is changed. | yes | true or false | false |
| vs_file.config | build configuration of Visual Studio project | yes | name of valid configuration for the Visual Studio project file | Debug Unicode |
| web.host | Klocwork Server host name | no | N/A | myserver.acme.com |
| web.port | Klocwork Server port number | no | N/A | 8080 |
| web.started_by | user ID that started the Klocwork Server | no | N/A | adminuser |
Build properties displayed by kwadmin
You can display a list of build properties with the command kwadmin get-build-properties.
The following information is provided:
| Property | Description | Example value |
| build_version | version of Klocwork used to create the project | 9.6 |
| build_work_dir | current work directory | C:\Documents and Settings\jsmith\Local Settings\Temp\klocwork_dir\build_work_dir_1 |
| clef_options | kwlef options (controlling creation of C/C++ function behavior knowledge base) | --errors-config=problems_default.pconf.xml |
| compiler_options | C/C++ compiler options for the analysis | --windows,--use-fbkb=generated.kb |
| copy_sources | specifies whether project source files were copied to projects_root for this analysis | true |
| copy_tables | specifies whether Klocwork tables were copied to projects_root by kwadmin load | true |
| creator | user ID under which the project was created | jsmith |
| database.host | Database server host name | myserver.acme.com |
| database.name | Name of the build database | Toolbus_build_1 |
| database.port | Database server port | 3306 |
| database.type | Database type | mysql |
| fbkb_generated | indicates whether or not a knowledge base was created (true or false) | true |
| incompatible_server_versions | server versions that are incompatible with the current projects_root directory | 6.1,7.0 |
| java.sembase | Java sembases defined for this analysis | C:\klocwork\jre14\lib\rt.jar |
| java_compiler_options | Java compiler option specifies whether the use of assert as an identifier is allowed. See Java language-level compatibility. | -source,1.3 |
| language | programming language of the source files in the project | c,cxx |
| last_modified_version | for internal use | 9.6 |
| latestBuildNumber | for internal use | 3 |
| lefjava_options | kwjava options (controlling creation of Java knowledge base) | --errors-config=java_default.jpconf.xml |
| license.host | License Server host name | myserver.acme.com |
| license.port | License Server port | 27000 |
| locs | Total lines of code in build | 4635 |
| log_file | Path to the build log file | C:\klocwork\60038\projects_root\projects\Toolbus\builds\build_1\build.log |
| models_dir | Directory in which models based on this build are stored | C:\klocwork\60038\projects_root\projects\Toolbus\builds\build_1\models |
| name | build name | build_1 |
| project_creation_time_stamp | project creation timestamp; localized by Klocwork Review | 1141063209323 |
| project_host | name of machine where project was created | myserver01.acme.com |
| project_name | name of the project to which this build belongs | MyProject |
| project_version | version of Klocwork used to create the project | 9.6 |
| report_dir | Reports directory | C:\klocwork\60038\projects_root\projects\Toolbus\builds\build_1\reports |
| report_options | Report options shared with Klocwork developer tools | --architecture-report,--coding-report,--includes-report,--interface-report,--metrics-report,--security-report,--error-config=problems_default.pconf.xml,--metrics-config=metrics_default.mconf,--usagerules=usagerules_default.uconf,--replacepath,C:\temp\Klocwork\sources\toolbus=toolbus |
| short_log_file | Path to the brief build log file | C:\Klocwork\projects_root\projects\Toolbus\builds\build_1\build_short.log |
| source.bsf | location of the build specification used to analyze the project | C:\klocwork\bin\myproject.out |
| source.root | root directories of Java source files used in the project | C:\Source_files\Apache\source |
| source.tables | location of pre-built tables used for the project | C:\klocwork\projects_root\projects\MyProject\builds\build_4\tables |
| source.vs_file | location of Visual Studio .project or .sln file | C:\Source_files\FileZilla\source\FileZilla.vcproj |
| source_dir | location of source files copied to server | C:\Klocwork\projects_root\projects\Toolbus\builds\build_1\source |
| source_encoding | language encoding of source files used in build | utf-8 |
| stage.* | For internal use | done |
| status | Status of the build. See Build states. | active |
| tables_dir | Path to the tables directory | C:\klocwork\tables |
| timeStamp | For internal use | 1086025799678 |
| vs_file.config | build configuration of Visual Studio project | Debug Unicode |
| web.host | Klocwork Server host name | myserver01.acme.com |
| web.port | Klocwork Server port number | 8080 |
Build states
The state of a build is indicated in the project list of Klocwork Review.
Tip: You can also check build status with the command kwadmin get-build-properties. Look for the "status" property.
A project build can be in the following states:
- Successful: indicates that all of the requested information has been successfully created and is available to the Klocwork applications. The equivalent build status in kwadmin is active.
- Inactive: indicates that the build was successful, but the database was not loaded. The equivalent build status in kwadmin is inactive.
- Failed: indicates that for some reason Klocwork Truepath™ did not successfully complete. This could because the build was stopped, or some type of error occurred. Failed analyses are not visible to Klocwork applications. The equivalent build status in kwadmin is failed.
- In Progress: indicates that a build is being created. "In Progress" analyses are not visible to Klocwork applications. The equivalent build status in kwadmin is inconsistent.
Java language-level compatibility
There are three possible language levels for a Java project: 1.5, 1.4, and 1.3. The default level is 1.3.
Java 1.5 provides support for features such as the enum keyword and autoboxing.
In Java 1.3 and earlier, assert was not a reserved keyword. In Java 1.4, the assert statement was added, and assert is considered a reserved keyword, so it can no longer be used as a regular identifier. To keep the old code valid (compilable), two source compatibility modes exist in JDK 1.4:
- In source mode 1.3, the compiler accepts programs that use assert as an identifier. In this mode, programs are not permitted to use the assert statement.
- In source mode 1.4, the compiler generates an error message if the program uses assert as an identifier. In this mode, programs are permitted to use the assert statement.
You specify the language level with the java_compiler_options project property, using kwadmin set-project-property:
kwadmin set-project-property <project_name> java_compiler_options <existing_options> -source,1.4
where
- <project_name> is the name of the project you want to modify
- <existing_options> are all of the default and user-defined Java compiler options for this project besides -source. If you do not include the entire list of existing options, you will overwrite them.