|
|
It is important to recognize that any
support provided by Do178Builder or other tools for automatically
creating traceability cross-reference data only exposes the
interrelationships among the data you've created. It cannot of
itself guarantee that your structuring of the data has created correct
interrelationships. It's always your responsibility to do
that. So our discussion here relates entirely to construction of
a sensible representation of the cross-reference data. |
A general rule for any use of
Do178Builder-utility to create stand-alone trace matrices is that you
should use Do178Builder itself with its --no-trace switch in order to
prevent it from embedding traceability cross-references within the
requirements, design, and test-case document it creates. |
Option |
Description |
Notes |
--combine-srd-sdd |
Like the Do178Builder option of the same
name. Causes the processing to assume that the SRD and SDD (or
HRD and HDRD) form a single integrated document rather than two
separate documents. |
|
"--delimiter-implement=C" |
When --trace-implement (see
below is used), chooses the delimiter for the implementation data
(source code, CAD files) appearing in the XML project database within <trace></trace>
tags. Usually, either space or a comma. For any delimiter
that is not a space, spaces surrounding the delimiter within the <trace></trace>
tags is discarded. The default is ','. |
The quotation marks shown are
necessary if the delimiter is a space or punctuation. Not yet implemented. |
"--delimiter-system=C" |
When --trace-system (see below
is used), chooses the delimiter for the system requirements appearing
in the XML project database within <trace></trace>
tags. Usually, either space or a comma. For any delimiter
that is not a space, spaces surrounding the delimiter within the <trace></trace>
tags are discarded. The default is ','. |
The quotation marks shown are
necessary if the delimiter is a space or punctuation. Not yet implemented. |
--display |
Display to the standard output a
structural representation of the project database, in terms of all of
the section headings and the documents they appear in. (Not
useful if any of the --trace-XXXX switches are used, since they output
messages to stdout as well.) |
|
--DO-254 |
The default assumption is that
the input XML file contains DO-178B data. This command-line
switch (similarly to the identical switch in Do178Builder) changes the assumption
to DO-254 (hardware) data instead, so the output trace matrices refer
to the HRD, HDRD, and HTPR documents instead of the SRD, SDD, and SVCP
documents. |
|
--help |
Displays a list of options. |
|
"--high-label-pattern=P" |
Defines a pattern (regular
expression) used with the --trace-XXXX switches to identify labels for
high-level software (hardware) requirements in the SRD (HRD). The default is "--high-label-pattern=\[SR[0-9]+\]", meaning that strings of the form "[SRn]" (where any decimal number, possibly multiple-digit) are counted as high-level requirements. The rationale for this default is simply that it's the identification I happen to be using right now in my work for high-level requirements. |
The quotation marks shown are necessary if the contains a space or punctuation. |
"--high-section-pattern=P" | Defines a pattern (regular
expression) used with the --trace-XXXX
switches to identify sections in the SRD (HRD) containing unique
high-level software (hardware) requirements identified by section
number. The default is "--high-section-pattern=[[:space:]]shall[[:space:]]", meaning that if the word "shall" is found, and it is both preceded and followed by a space, then it is considered to be a requirement. |
The quotation marks shown are necessary if the contains a space or punctuation. |
"--high-section-range=P" | Defines a pattern (regular
expression) used with the --trace-XXXX
switches to constrain the range of section numbers in which high-level
software (hardware)requirements are sought. The default is to match every section of the SRD (or HRD) document, which is not too realistic. |
The quotation marks shown are necessary if the contains a space or punctuation. |
"--low-label-pattern=P" | Defines a pattern (regular
expression) used with the --trace-XXXX switches to identify labels for
low-level software (hardware) requirements in the SDD (HDRD). The default is "--low-label-pattern=\[SL[0-9]+\]", meaning that strings of the form "[SLn]" (where any decimal number, possibly multiple-digit) are counted as low-level requirements. The rationale for this default is simply that it's the identification I happen to be using right now in my work for low-level requirements. |
The quotation marks shown are necessary if the contains a space or punctuation. |
"--low-section-pattern=P" | Defines a pattern (regular
expression) used with the --trace-XXXX switches to identify
sections in the SDD (HDRD) containing unique low-level software
(hardware) requirements identified by section number. The default is "--low-section-pattern=[[:space:]]shall[[:space:]]", meaning that if the word "shall" is found, and it is both preceded and followed by a space, then it is considered to be a requirement. |
The quotation marks shown are necessary if the contains a space or punctuation. |
"--low-section-range=P" | Defines a pattern (regular
expression) used with the --trace-XXXX switches to constrain the range
of section numbers in which low-level software (hardware) requirements
are sought. The default is to match every section of the SDD (or HDRD) document, which is not too realistic. |
The quotation marks shown are necessary if the contains a space or punctuation. |
--no-sed |
Do NOT run 'sed' to translate
the entity names in the input file. This is for debugging only,
and if you use it will undoubtedly cause the program to abort with an
error message when it tries to parse the input file. |
|
--regex-basic |
Use POSIX Basic Regular
Expression syntax rather than POSIX Extended Regular Expression
syntax, which is the default. |
|
--regex-case-insensitive |
Make regular-expression matching
insensitive to upper/lower case distinction. |
|
--sortable=N |
With this switch, all numerical
fields in a section number are left-padded with zeroes so that the
fields are the same width N.
N must be 2 or 3.
For example, instead of document section 3.10.4.5, the output trace
matrices would refer to section 03.10.04.05 (if the field-width is
2). The motivation for such a step is to allow the trace tables
to be more reasonably sorted when imported into spreadsheet
programs. For example, section "10.1.3" would precede section
"6.5" in ASCII sort order, but section "06.05" would (more reasonably)
precede section "10.01.03". However, this is not without cost, as
it affects all of the --XXXX-section-range command-line switches, and
is unlikely to be understood easily be DERs or customers. If you
use this switch, you'll likely want to perform some post-processing to
remove the padding afterward. |
|
"--system-section-range=P" |
Defines a pattern (regular
expression) used with the --trace-system switches to constrain the
range of section numbers in which system-requirements cross-references
are sought. In other
words, only system-requirement cross-references in sections of
the SRD whose numbers match the
pattern will appear in the output table. There is no default, meaning that every SRD/HRD section is eligible, which is not a realistic assumption. |
|
--trace |
Activate all of the --trace-XXXX options
listed below. |
|
--trace-design |
Output traceability data between
SRD and SDD (or HRD and HDRD) into the file
Do178Builder-trace-design.csv. When using this switch, you may also want to use the --high-label-pattern, --high-section-pattern, --high-section-range, --low-label-pattern, --low-section-pattern, and --low-section-range switches (see above). |
|
--trace-design-full |
Same as --trace-design, but adds
SRD/SDD (HRD/HDRD) section numbers, and creates the output file
Do178Builder-trace-design-full.csv. When using this switch, you may also want to use the --high-label-pattern, --high-section-pattern, --high-section-range, --low-label-pattern, --low-section-pattern, and --low-section-range switches (see above). |
|
--trace-implement | Output traceability data between SDD (or HDRD) and source code (or CAD), into Do178Builder-trace-implement.csv. | Not yet implemented |
--trace-system |
Output traceability data between
system requirements and SRD, into the file
Do178Builder-trace-system.csv. When using this switch, you may also want to use the --high-label-pattern, --high-section-pattern, --high-section-range, --system-section-range, and --delimiter-system switches (see above). Using this switch requires special preparation of the Do178Builder project database, because system requirements are generally maintained in external documents (such as customer-supplied specs) rather than within the Do178Builder project database. Cross-references to the system requirements have to be manually added to the project database, using appropriate tags. This is process is described below. |
|
--trace-verify |
Output traceability data between
SRD/SDD (or HRD/HDRD) and SVCP (or HTPR), in
Do178Builder-trace-verify.csv. When using this switch, you may also want to use the --high-label-pattern, --high-section-pattern, --high-section-range, --low-label-pattern, --low-section-pattern, --low-section-range, and --verify-section-range switches. |
|
"--verify-section-range=P" |
Defines a pattern (regular
expression) used with the --trace-verify switches to constrain the
range of section numbers in which test cases are sought. In other
words, only test cases in sections of the SVCP whose numbers match the
pattern will appear in the output table. |
The quotation marks shown are
necessary if the contains a space or punctuation. This switch has
no default setting, so if you use --trace-verify (or --trace) without
it, the program will abort. |