Configuring Component Options
Once a component has been selected, the basic options for that component will be displayed. You can click Advanced to show the full list of options. Selecting an option will highlight in the window below more detailed information for the option, including:
Name | The option name, e.g. ‑namelength |
Shortcut | The shortened option name, e.g. ‑na |
Type | The type of option, such as a “string” or “file”. See Option Types for more information. |
Syntax | The syntax of the option and any parameters, e.g. ‑namelength value |
Cumulative | If cumulative is true then multiple values for this option can be supplied and all will be processed by the component. If false then multiple values may be supplied, but only the last value will be used. |
Inheritable | If the option has been set for a primary analysis component, then it will be inherited into secondary analysis components. For example, if set for QAC then it would be inherited by M3CM. |
Default value | If not specified, the value that will be used by the component, e.g. ‑namelength 63 |
Description | Full textual description of the option, usually with examples. |
More complete information is shown for each option in the respective component manuals, such as Helix QAC for C.
Option Types
Each component option can be one of the following types:
char | A single alphabetic character, such as “A” |
directory | A path to a directory 1 |
file | A path to a file 1 |
flag | Either + or -, indicating the option is set or not set |
numeric | A positive integer in the range 0-999999999 |
numeric_list | Several positive integer ranges separated by commas, for example: 1,2,300-400 |
path | A path to a file or a directory 1 |
password | A string, whose value is obfuscated when the user inputs it |
string | A string |
1 A path, directory or file follows the normal format for the OS. This can be absolute (e.g. C:\Temp\foo.c
or /home/trinity/foo.c
), relative (e.g. ..\foo.c
or ../foo.c
) and it can include root variables (e.g. ${SOURCE_ROOT}\foo.c
or ${SOURCE_ROOT}/foo.c
).
${PROJECT_ROOT}
, i.e. the location of the prqaproject.xml
file. This is except for the -i
option, then it will be relative to ${SOURCE_ROOT}
User Arguments
After you have selected a component option, you can double-click in the User Arguments list to add a new value for that option. Your input will be guided based upon the Option Type. The following options are available:
- Select File - Opens a file section dialog that enables you to select a file. The resultant location is then made relative to the best root variable.
- Select Directory - Opens a directory section dialog that enables you to select a directory. The resultant location is then made relative to the best root variable.
- Free Text - The Free Text option opens a text entry box that enables you to manually enter a path. You are encouraged to enter paths with rooted variables, such as
${SOURCE_ROOT}/foo.c
Detailed Options
When configuring component options, click this button to open a dialog providing a detailed view of each option and its setting at each stage of the configuration. i.e., in the CCT, Secondary Analyzer, and any User Overrides. You can use the search box to enter the full or partial option name and only options matching the search will be displayed.
Inherited Arguments
The Inherited Argument panel shows options that may be set by the Secondary Analyzer and inherited by the primary analyzer. For example, M3CM will set ‑namelength 31
for QAC.
The Ignore Inherited Arguments check box resets the previous configuration settings for the option (effectively adding an ‑f
option to the configuration). This would normally only be set when directed by support.