Specifications

Specification With Image

rst:

.. spec:: SWA_example_abc
    :refs: SMD_example_xy
    :asil: ASIL_A
    :tags: integrity, covered, tested
    :verification_criteria: Do carefully abc...

    Example SWA content...

    .. image:: ../_static/example.png

    Please look at :ref:`SMD_example_xy`.

html:

[spec] SWA_example_abc   Status: draft

Asil: ASIL_A | Cal: not_set | Upstream Asil: - | Upstream Cal: -
Developer: MyCompany | Tester: [missing] | Verification Methods: on_target
Tags: integrity, covered, tested | Upstream Tags: -

Example SWA content…

../../_images/example.png

Please look at xy.

Verification Criteria: Do carefully abc…
Derived Feature: -
Derived Change Request: -
Custom Text: THIS IS THE DEFAULT VALUE
Custom Enum: x, y
Custom Refs: -

Upstream References: [missing]
Downstream References: SMD_example_xy

Unit With Source File

rst:

.. unit:: SMD_example_xy
    :sources: ../_static/module1/include/source2.h
    :asil: ASIL_A
    :tags: integrity, covered, tested

    This unit does xy.

html:

[unit] SMD_example_xy   Status: draft

Asil: ASIL_A | Cal: not_set | Upstream Asil: ASIL_A | Upstream Cal: not_set
Developer: [missing] | Tester: [missing] | Verification Methods: off_target
Tags: integrity, covered, tested | Upstream Tags: covered, integrity, tested

This unit does xy.

Verification Criteria: -
Derived Feature: -
Derived Change Request: -
Custom Text: THIS IS THE DEFAULT VALUE
Custom Enum: x, y

Upstream References: SWA_example_abc
Downstream References: -
Sources: ../_static/module1/include/source2.h

Invalid Specification

rst:

.. unit:: SMD_example_inv
    :status: invalid

    *invalid* and *rejected* specifications are struck through.

html:

[unit] SMD_example_inv   Status: invalid

Asil: not_set | Cal: not_set | Upstream Asil: - | Upstream Cal: -
Developer: - | Tester: - | Verification Methods: off_target
Tags: - | Upstream Tags: -

invalid and rejected specifications are struck through.

Verification Criteria: -
Derived Feature: -
Derived Change Request: -
Custom Text: THIS IS THE DEFAULT VALUE
Custom Enum: x, y

Upstream References: -
Downstream References: -
Sources: -

Information

rst:

.. information:: Input_example_info

    Some information.

html:

[information] Input_example_info   Status: draft

Asil: not_set | Cal: not_set
Tags: -

Some information.

Comment: -
Miscellaneous: -

Upstream References: -
Downstream References: -

Requirement Derivation

rst:

.. requirement:: Customer_DeriveParent_1
    :category: input
    :asil: ASIL_B
    :feature: F1
    :refs: SRS_DeriveParent_1
    :developer: Abc AG
    :status: valid
    :review_status: accepted

    Generated by Dim.

.. requirement:: SRS_DeriveParent_1
    :refs: SWA_DeriveParent_1
    :asil: ASIL_C
    :category: software
    :developer: Abc AG
    :status: valid

    Generated by Dim.

.. srs:: SRS_DeriveParent_2
    :refs: SWA_DeriveParent_1
    :asil: ASIL_D

    Self-written in RST.

.. spec:: SWA_DeriveParent_1
    :status: valid
    :refs: SMD_DeriveParent_1

    Self-written in RST.

    "Upstream Asil" only from direct parent, "Derived Feature" from complete tree.

.. unit:: SMD_DeriveParent_1
    :status: valid
    :sources: ../_static/module1/include/source2.h

    The unit description.

html:

[requirement] Customer_DeriveParent_1   Status: valid | Review Status: accepted

Asil: ASIL_B | Cal: not_set
Developer: Abc AG | Tester: [missing] | Verification Methods: -
Tags: -

Generated by Dim.

Verification Criteria: -
Comment: -
Feature: F1
Change Request: -
Miscellaneous: -
Custom Refs: -

Upstream References: -
Downstream References: SRS_DeriveParent_1

[requirement] SRS_DeriveParent_1   Status: valid

Asil: ASIL_C | Cal: not_set | Upstream Asil: ASIL_B | Upstream Cal: not_set
Developer: Abc AG | Tester: [missing] | Verification Methods: -
Tags: - | Upstream Tags: -

Generated by Dim.

Verification Criteria: [missing]
Derived Feature: F1
Derived Change Request: -

Upstream References: Customer_DeriveParent_1
Downstream References: SWA_DeriveParent_1

[srs] SRS_DeriveParent_2   Status: draft

Asil: ASIL_D | Cal: not_set | Upstream Asil: - | Upstream Cal: -
Developer: [missing] | Tester: [missing] | Verification Methods: on_target
Tags: - | Upstream Tags: -

Self-written in RST.

Verification Criteria: [missing]
Derived Feature: -
Derived Change Request: -

Upstream References: [missing]
Downstream References: SWA_DeriveParent_1

[spec] SWA_DeriveParent_1   Status: valid

Asil: not_set | Cal: not_set | Upstream Asil: ASIL_C, ASIL_D | Upstream Cal: not_set
Developer: MyCompany | Tester: [missing] | Verification Methods: on_target
Tags: - | Upstream Tags: -

Self-written in RST.

“Upstream Asil” only from direct parent, “Derived Feature” from complete tree.

Verification Criteria: -
Derived Feature: F1
Derived Change Request: -
Custom Text: THIS IS THE DEFAULT VALUE
Custom Enum: x, y
Custom Refs: -

Upstream References: SRS_DeriveParent_1, SRS_DeriveParent_2
Downstream References: SMD_DeriveParent_1

[unit] SMD_DeriveParent_1   Status: valid

Asil: not_set | Cal: not_set | Upstream Asil: not_set | Upstream Cal: not_set
Developer: [missing] | Tester: [missing] | Verification Methods: off_target
Tags: - | Upstream Tags: -

The unit description.

Verification Criteria: -
Derived Feature: F1
Derived Change Request: -
Custom Text: THIS IS THE DEFAULT VALUE
Custom Enum: x, y

Upstream References: SWA_DeriveParent_1
Downstream References: -
Sources: ../_static/module1/include/source2.h

Modules

rst:

.. mod:: SWA_mod_module1
    :location: pages/_static/module1
    :reuse: yes
    :usage: production
    :developer: Abc AG
    :status: valid

    Best module ever.

.. mod:: SWA_mod_module2
    :location: pages/_static/module2
    :reuse: no
    :usage: production
    :developer: Supplier X

    Does this and that.

html:

[mod] SWA_mod_module1   Status: valid

Asil: not_set | Cal: not_set | Reuse: yes | Usage: production | Upstream Asil: - | Upstream Cal: -
Developer: Abc AG

Best module ever.

Upstream References: [missing]
Location: pages/_static/module1

[mod] SWA_mod_module2   Status: draft

Asil: not_set | Cal: not_set | Reuse: no | Usage: production | Upstream Asil: - | Upstream Cal: -
Developer: Supplier X

Does this and that.

Upstream References: [missing]
Location: pages/_static/module2