Skip to content

Commit 6d1882b

Browse files
committed
hard-deprecate satisfies for feat_req/comp_req,
1 parent 1e90548 commit 6d1882b

4 files changed

Lines changed: 16 additions & 12 deletions

File tree

src/extensions/score_metamodel/metamodel.yaml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -294,9 +294,7 @@ needs_types:
294294
content: ^[\s\S]+$
295295
optional_links:
296296
# req-Id: tool_req__docs_req_link_satisfies_allowed
297-
# TODO: make derived_from mandatory once downstream repos migrate from satisfies
298297
derived_from: stkh_req
299-
satisfies: stkh_req # for backward compatibility - remove once downstream repos migrate to derived_from
300298
belongs_to: feat # for evaluation
301299
satisfied_by: feat # new preferred name for belongs_to
302300
# req-Id: tool_req__docs_req_link_covers_aou
@@ -331,9 +329,7 @@ needs_types:
331329
content: ^[\s\S]+$
332330
optional_links:
333331
# req-Id: tool_req__docs_req_link_satisfies_allowed
334-
# TODO: make derived_from mandatory once downstream repos migrate from satisfies
335332
derived_from: feat_req
336-
satisfies: feat_req # for backward compatibility - remove once downstream repos migrate to derived_from
337333
belongs_to: comp # for backward compatibility
338334
satisfied_by: comp # new preferred name for belongs_to
339335
# TODO: make satisfied_by mandatory once downstream repos migrate from belongs_to
@@ -1006,8 +1002,7 @@ needs_extra_links:
10061002
incoming: satisfies
10071003
outgoing: satisfied by
10081004

1009-
# TODO: hard-deprecate satisfies in a follow-up PR once score + module_template migrate to
1010-
# derived_from. Tracked in https://github.com/eclipse-score/docs-as-code/issues/594
1005+
# kept for backward compatibility - still used by tool_req and gd_req
10111006
satisfies:
10121007
incoming: satisfied by
10131008
outgoing: satisfies
@@ -1077,7 +1072,6 @@ graph_checks:
10771072
condition: safety == QM
10781073
check:
10791074
derived_from: safety == QM
1080-
satisfies: safety == QM
10811075
explanation: QM requirements cannot be derived from ASIL requirements.
10821076

10831077
# req-Id: tool_req__docs_arch_link_qm_to_safety_req

src/extensions/score_metamodel/tests/rst/options/test_need_extends.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
.. feat_req:: Test Linkage Override
2626
:id: feat_req__test__linkage_override
27-
:satisfies: stkh_req__test__need_extends_1
27+
:derived_from: stkh_req__test__need_extends_1
2828

2929

3030
.. Replacing of options that are already set is not allowed.
@@ -53,7 +53,7 @@
5353
#EXPECT[+2]: Error when extending need: feat_req__test__linkage_override. Replace or Delete action is not allowed via needextends.
5454

5555
.. needextend:: feat_req__test__linkage_override
56-
:satisfies: stkh_req__test__need_extends_abc
56+
:derived_from: stkh_req__test__need_extends_abc
5757

5858

5959
#EXPECT[+2]: Error when extending need: stkh_req__test__need_extends_1. Delete action is not allowed via needextends.

src/extensions/score_metamodel/tests/rst/options/test_options_extra_option.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,13 @@
2525

2626
.. std_wp:: This is a test
2727
:id: std_wp__test__abce
28+
29+
.. stkh_req:: Test Stakeholder Requirement
30+
:id: stkh_req__test__abcd
31+
32+
.. `satisfies` is hard-deprecated for feat_req (issue #594) — only `derived_from` is allowed now
33+
#EXPECT[+2]: feat_req__test__satisfies_deprecated: has these extra options: `satisfies`.
34+
35+
.. feat_req:: Hard-deprecated satisfies test
36+
:id: feat_req__test__satisfies_deprecated
37+
:satisfies: stkh_req__test__abcd

src/extensions/score_metamodel/tests/rst/options/test_options_options.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@
3232

3333

3434

35-
.. Required link `satisfies` refers to wrong requirement type
36-
#EXPECT[+2]: feat_req__abce: references 'std_wp__test__abce' as 'satisfies', but it must reference Stakeholder Requirement (stkh_req).
35+
.. Required link `derived_from` refers to wrong requirement type
36+
#EXPECT[+2]: feat_req__abce: references 'std_wp__test__abce' as 'derived_from', but it must reference Stakeholder Requirement (stkh_req).
3737

3838
.. feat_req:: Child requirement
3939
:id: feat_req__abce
40-
:satisfies: std_wp__test__abce
40+
:derived_from: std_wp__test__abce
4141

4242

4343

0 commit comments

Comments
 (0)