Skip to content

fix: Restore accidentally deleted requirements#730

Open
a-zw wants to merge 1 commit into
eclipse-score:mainfrom
etas-contrib:restore-diagram-reqs
Open

fix: Restore accidentally deleted requirements#730
a-zw wants to merge 1 commit into
eclipse-score:mainfrom
etas-contrib:restore-diagram-reqs

Conversation

@a-zw

@a-zw a-zw commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

The intention was to delete requirements related to unit tests. Attributes like "belongs_to" are also relevant on a higher-levels though.

The intention was to delete requirements related to unit tests.
Attributes like "belongs_to" are also relevant on a higher-levels
though.
Comment on lines +116 to +117
- SW Unit
- SW Unit Interface

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure the first two requirements should be restored, but I'm not sure about the other two since these seem to be quite specifically about units.

On the other hand, docs-as-code currently implements relations like "mod_view_sta includes comp".

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above

Image

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

:complies: std_req__iso26262__support_6421[version==1], std_req__iso26262__support_6425[version==1]
:satisfies: wf__sw_detailed_design[version==1]

Each diagram shall be automatically linked (inverse direction) to the corresponding component id via the "belongs by" linkage.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

belongs by sounds a bit strange to me.
Options: contains, owns, has.
Eventually also "consists of" may be an option.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is according meta model, thus fine, should not be changed


.. _detailed_design_linkage:

Diagram Linkage

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compared it with https://eclipse-score.github.io/process_description/main/general_concepts/score_building_blocks_concept.html
seems ok, but the word Diagram is somehow misleading, should that not be called Detailed Design?

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:complies: std_req__iso26262__support_6421[version==1], std_req__iso26262__support_6425[version==1]
:satisfies: wf__sw_detailed_design[version==1]

Each diagram shall be linked to the corresponding component id via the attribute belongs_to.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In detail design / implementation exists no sphinx elements anymore. There this requirement should be moved into the architecture process requirements.

:complies: std_req__iso26262__support_6421[version==1], std_req__iso26262__support_6425[version==1]
:satisfies: wf__sw_detailed_design[version==1]

Each diagram shall be automatically linked (inverse direction) to the corresponding

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be removes. See above.

:complies: std_req__iso26262__support_6421[version==1], std_req__iso26262__support_6425[version==1]
:satisfies: wf__sw_detailed_design[version==1]

Each diagram shall be linked to the corresponding

@RolandJentschETAS RolandJentschETAS Jun 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requirement can be removed. We have no sphinx needs in implementation / detail design anymore. Existing (optional) implementation diagrams (plantuml or drawio) are linked by path / filename to the unit. They are located in the docs folder of the component. The units are mentioned in the diagram as names of "boxes". There is no automation needed.


Each diagram shall be linked to the corresponding component id via the attribute belongs_to.

.. gd_req:: Diagram Linkage Component ID

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above. Shall be moved to architecture process requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants