Changeset 3f9fa47 in rtems-docs


Ignore:
Timestamp:
Jul 27, 2020, 1:44:04 PM (2 weeks ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
1bb6947
Parents:
c259563
git-author:
Sebastian Huber <sebastian.huber@…> (07/27/20 13:44:04)
git-committer:
Sebastian Huber <sebastian.huber@…> (07/28/20 05:33:18)
Message:

eng: Add ability to skip action transitions

Sometimes the pre-conditions in an action requirement are not
independent and it is necessary skip a certain set of pre-condition
states. This should be used with care since no test code is run in
these cases. There shall be a reason given why skipping a transition is
justified.

Update #3715.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • eng/req/items.rst

    rc259563 r3f9fa47  
    16891689    The attribute value shall be a list. Each list element shall be an
    16901690    :ref:`SpecTypeActionRequirementCondition`.
     1691
     1692skip-reasons
     1693    The attribute value shall be an
     1694    :ref:`SpecTypeActionRequirementSkipReasons`.
    16911695
    16921696test-action
     
    18181822      test-prologue: null
    18191823    requirement-type: functional
     1824    skip-reasons: {}
    18201825    test-action: |
    18211826      /* Call the function of the action */
     
    22042209* :ref:`SpecTypeActionRequirementCondition`
    22052210
     2211* :ref:`SpecTypeActionRequirementSkipReasons`
     2212
    22062213* :ref:`SpecTypeActionRequirementState`
    22072214
     
    22092216
    22102217* :ref:`SpecTypeActionRequirementTransitionPreConditions`
     2218
     2219.. _SpecTypeActionRequirementSkipReasons:
     2220
     2221Action Requirement Skip Reasons
     2222^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     2223
     2224This set of attributes specifies skip reasons used to justify why transitions
     2225in the transition map are skipped. Generic attributes may be specified. Each
     2226generic attribute key shall be an :ref:`SpecTypeActionRequirementName`. Each
     2227generic attribute value shall be a string. The key defines the name of a skip
     2228reason.  The name can be used in
     2229:ref:`SpecTypeActionRequirementTransitionPostConditions` to skip the
     2230corresponding transitions.  The value shall give a reason why the transitions
     2231are skipped.
     2232
     2233This type is used by the following types:
     2234
     2235* :ref:`SpecTypeActionRequirementItemType`
    22112236
    22122237.. _SpecTypeActionRequirementState:
     
    24102435^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    24112436
    2412 This set of attributes defines for each post-condition the state after the
    2413 action for a transition in an action requirement. Generic attributes may be
    2414 specified. Each generic attribute key shall be an
    2415 :ref:`SpecTypeActionRequirementName`. Each generic attribute value shall be an
    2416 :ref:`SpecTypeActionRequirementName`. There shall be exactly one generic
    2417 attribute key for each post-condition.  The key name shall be the
    2418 post-condition name.  The value of each generic attribute shall be the state of
    2419 the post-condition.
     2437A value of this type shall be of one of the following variants:
     2438
     2439* The value may be a set of attributes. This set of attributes defines for each
     2440  post-condition the state after the action for a transition in an action
     2441  requirement. Generic attributes may be specified. Each generic attribute key
     2442  shall be an :ref:`SpecTypeActionRequirementName`. Each generic attribute
     2443  value shall be an :ref:`SpecTypeActionRequirementName`. There shall be
     2444  exactly one generic attribute key for each post-condition.  The key name
     2445  shall be the post-condition name.  The value of each generic attribute shall
     2446  be the state of the post-condition.
     2447
     2448* The value may be a string. It shall be the name of a skip reason.  If a skip
     2449  reason is given instead of a listing of post-condition states, then this
     2450  transition is skipped and no test code runs for this transition. The value
     2451
     2452  * shall match with the regular expression "``^[A-Z][a-zA-Z0-9]+$"``,
     2453
     2454  * and, shall be not equal to "``NA``".
    24202455
    24212456This type is used by the following types:
Note: See TracChangeset for help on using the changeset viewer.