[rtems-central commit] Format specification items
Sebastian Huber
sebh at rtems.org
Mon Nov 30 11:25:35 UTC 2020
Module: rtems-central
Branch: master
Commit: 0a5afb3c22906c123cbd31d5e67aeaeb029d2f4d
Changeset: http://git.rtems.org/rtems-central/commit/?id=0a5afb3c22906c123cbd31d5e67aeaeb029d2f4d
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Mon Nov 30 12:19:30 2020 +0100
Format specification items
---
rtemsspec/tests/spec-validation/rpr.yml | 6 ++--
spec/rtems/basedefs/if/deconst.yml | 3 +-
spec/rtems/basedefs/if/dequalify.yml | 3 +-
spec/rtems/basedefs/if/devolatile.yml | 3 +-
spec/rtems/mode/if/interrupt-level.yml | 2 +-
spec/rtems/object/if/api-class-information.yml | 4 +--
spec/rtems/object/if/get-name.yml | 2 +-
spec/rtems/object/if/id-final-index.yml | 4 +--
spec/rtems/object/if/id-final.yml | 2 +-
spec/rtems/object/if/id-initial-index.yml | 4 +--
spec/rtems/object/if/set-name.yml | 2 +-
spec/rtems/part/req/perf-get-buffer.yml | 38 +++++++++++++-------------
spec/rtems/part/req/perf-get-no-buffer.yml | 6 ++--
spec/rtems/part/req/perf-return-buffer.yml | 6 ++--
spec/rtems/part/val/performance.yml | 2 +-
spec/spec/requirement-performance-runtime.yml | 20 +++++++-------
16 files changed, 55 insertions(+), 52 deletions(-)
diff --git a/rtemsspec/tests/spec-validation/rpr.yml b/rtemsspec/tests/spec-validation/rpr.yml
index edaa129..cd369c8 100644
--- a/rtemsspec/tests/spec-validation/rpr.yml
+++ b/rtemsspec/tests/spec-validation/rpr.yml
@@ -2,13 +2,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
+limits: {}
links:
- role: runtime-measurement-request
uid: rtm
-limits: {}
+non-functional-type: performance-runtime
params: {}
rationale: null
references: []
+requirement-type: non-functional
test-body:
brief: |
Body brief.
@@ -32,8 +34,6 @@ test-teardown:
/* Teardown code */
description: |
Teardown description.
-non-functional-type: performance-runtime
-requirement-type: non-functional
text: |
Text.
type: requirement
diff --git a/spec/rtems/basedefs/if/deconst.yml b/spec/rtems/basedefs/if/deconst.yml
index 5c98aba..e1035d6 100644
--- a/spec/rtems/basedefs/if/deconst.yml
+++ b/spec/rtems/basedefs/if/deconst.yml
@@ -6,7 +6,8 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
definition:
- default: ${dequalify-depthx:/name}( *, ${.:/params[0]/name}, ${.:/params[1]/name} )
+ default: |
+ ${dequalify-depthx:/name}( *, ${.:/params[0]/name}, ${.:/params[1]/name} )
variants: []
description: null
enabled-by: true
diff --git a/spec/rtems/basedefs/if/dequalify.yml b/spec/rtems/basedefs/if/dequalify.yml
index 41d3da9..40152c3 100644
--- a/spec/rtems/basedefs/if/dequalify.yml
+++ b/spec/rtems/basedefs/if/dequalify.yml
@@ -6,7 +6,8 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
definition:
- default: ${dequalify-depthx:/name}( *, ${.:/params[0]/name}, ${.:/params[1]/name} )
+ default: |
+ ${dequalify-depthx:/name}( *, ${.:/params[0]/name}, ${.:/params[1]/name} )
variants: []
description: null
enabled-by: true
diff --git a/spec/rtems/basedefs/if/devolatile.yml b/spec/rtems/basedefs/if/devolatile.yml
index 714c0ff..afcb902 100644
--- a/spec/rtems/basedefs/if/devolatile.yml
+++ b/spec/rtems/basedefs/if/devolatile.yml
@@ -6,7 +6,8 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
definition:
- default: ${dequalify-depthx:/name}( *, ${.:/params[0]/name}, ${.:/params[1]/name} )
+ default: |
+ ${dequalify-depthx:/name}( *, ${.:/params[0]/name}, ${.:/params[1]/name} )
variants: []
description: null
enabled-by: true
diff --git a/spec/rtems/mode/if/interrupt-level.yml b/spec/rtems/mode/if/interrupt-level.yml
index 23949c5..cd78c3f 100644
--- a/spec/rtems/mode/if/interrupt-level.yml
+++ b/spec/rtems/mode/if/interrupt-level.yml
@@ -28,7 +28,7 @@ params:
dir: null
name: _interrupt_level
return:
- return: null
+ return: |
Returns the processor-dependent task mode interrupt level associated with
the interrupt level.
return-values: []
diff --git a/spec/rtems/object/if/api-class-information.yml b/spec/rtems/object/if/api-class-information.yml
index 17da71e..553a69e 100644
--- a/spec/rtems/object/if/api-class-information.yml
+++ b/spec/rtems/object/if/api-class-information.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This structure is used to return information to the application about the
- objects configured for a specific API/Class combination.
+ This structure is used to return information to the application about the
+ objects configured for a specific API/Class combination.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/object/if/get-name.yml b/spec/rtems/object/if/get-name.yml
index de9592b..b900239 100644
--- a/spec/rtems/object/if/get-name.yml
+++ b/spec/rtems/object/if/get-name.yml
@@ -30,7 +30,7 @@ links:
- role: interface-ingroup
uid: group
name: rtems_object_get_name
-notes:
+notes: |
This directive may cause the calling task to be preempted due to an obtain
and release of the object allocator mutex.
params:
diff --git a/spec/rtems/object/if/id-final-index.yml b/spec/rtems/object/if/id-final-index.yml
index 15963a1..d646db3 100644
--- a/spec/rtems/object/if/id-final-index.yml
+++ b/spec/rtems/object/if/id-final-index.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant represents the highest value for the index component of an
- object identifier.
+ This constant represents the highest value for the index component of an
+ object identifier.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/object/if/id-final.yml b/spec/rtems/object/if/id-final.yml
index 8229256..5e22f24 100644
--- a/spec/rtems/object/if/id-final.yml
+++ b/spec/rtems/object/if/id-final.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant represents the highest object identifier value.
+ This constant represents the highest object identifier value.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/object/if/id-initial-index.yml b/spec/rtems/object/if/id-initial-index.yml
index 5af3890..f9a9517 100644
--- a/spec/rtems/object/if/id-initial-index.yml
+++ b/spec/rtems/object/if/id-initial-index.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant represents the lowest value for the index component of an
- object identifier.
+ This constant represents the lowest value for the index component of an
+ object identifier.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/object/if/set-name.yml b/spec/rtems/object/if/set-name.yml
index 3c5c2a4..677358c 100644
--- a/spec/rtems/object/if/set-name.yml
+++ b/spec/rtems/object/if/set-name.yml
@@ -27,7 +27,7 @@ name: rtems_object_set_name
notes: |
This directive may cause the calling task to be preempted due to an obtain
and release of the object allocator mutex.
-
+
This directive can be used to set the name of objects which do not have a
naming scheme per their API.
diff --git a/spec/rtems/part/req/perf-get-buffer.yml b/spec/rtems/part/req/perf-get-buffer.yml
index 09f84fe..43ee6bc 100644
--- a/spec/rtems/part/req/perf-get-buffer.yml
+++ b/spec/rtems/part/req/perf-get-buffer.yml
@@ -2,35 +2,37 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
-links:
-- role: runtime-measurement-request
- uid: ../val/performance
limits:
sparc/leon3:
DirtyCache:
- max-upper-bound: 0.000005
- mean-upper-bound: 0.000005
+ max-upper-bound: 5.0e-06
+ mean-upper-bound: 5.0e-06
FullCache:
- max-upper-bound: 0.000005
- mean-upper-bound: 0.000005
+ max-upper-bound: 5.0e-06
+ mean-upper-bound: 5.0e-06
HotCache:
- max-upper-bound: 0.000005
- mean-upper-bound: 0.000005
+ max-upper-bound: 5.0e-06
+ mean-upper-bound: 5.0e-06
Load/1:
- max-upper-bound: 0.00001
- mean-upper-bound: 0.00001
+ max-upper-bound: 1.0e-05
+ mean-upper-bound: 1.0e-05
Load/2:
- max-upper-bound: 0.00001
- mean-upper-bound: 0.00001
+ max-upper-bound: 1.0e-05
+ mean-upper-bound: 1.0e-05
Load/3:
- max-upper-bound: 0.00001
- mean-upper-bound: 0.00001
+ max-upper-bound: 1.0e-05
+ mean-upper-bound: 1.0e-05
Load/4:
- max-upper-bound: 0.00001
- mean-upper-bound: 0.00001
+ max-upper-bound: 1.0e-05
+ mean-upper-bound: 1.0e-05
+links:
+- role: runtime-measurement-request
+ uid: ../val/performance
+non-functional-type: performance-runtime
params: {}
rationale: null
references: []
+requirement-type: non-functional
test-body:
brief: |
Get a buffer.
@@ -59,6 +61,4 @@ text: |
${../val/performance:/params/sample-count} successful calls to
${../if/get-buffer:/name} in the ${.:/environment} shall be
${.:limit-condition}.
-non-functional-type: performance-runtime
-requirement-type: non-functional
type: requirement
diff --git a/spec/rtems/part/req/perf-get-no-buffer.yml b/spec/rtems/part/req/perf-get-no-buffer.yml
index 0115fbe..df7871f 100644
--- a/spec/rtems/part/req/perf-get-no-buffer.yml
+++ b/spec/rtems/part/req/perf-get-no-buffer.yml
@@ -2,13 +2,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
+limits: {}
links:
- role: runtime-measurement-request
uid: ../val/performance
-limits: {}
+non-functional-type: performance-runtime
params: {}
rationale: null
references: []
+requirement-type: non-functional
test-body:
brief: |
Try to get a buffer.
@@ -47,6 +49,4 @@ text: |
${../val/performance:/params/sample-count} unsatisfied calls to
${../if/get-buffer:/name} in the ${.:/environment} shall be
${.:limit-condition}.
-non-functional-type: performance-runtime
-requirement-type: non-functional
type: requirement
diff --git a/spec/rtems/part/req/perf-return-buffer.yml b/spec/rtems/part/req/perf-return-buffer.yml
index 0199c36..7654e10 100644
--- a/spec/rtems/part/req/perf-return-buffer.yml
+++ b/spec/rtems/part/req/perf-return-buffer.yml
@@ -2,13 +2,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
+limits: {}
links:
- role: runtime-measurement-request
uid: ../val/performance
-limits: {}
+non-functional-type: performance-runtime
params: {}
rationale: null
references: []
+requirement-type: non-functional
test-body:
brief: |
Return the buffer.
@@ -40,6 +42,4 @@ text: |
${../val/performance:/params/sample-count} successful calls to
${../if/return-buffer:/name} in the ${.:/environment} shall be
${.:limit-condition}.
-non-functional-type: performance-runtime
-requirement-type: non-functional
type: requirement
diff --git a/spec/rtems/part/val/performance.yml b/spec/rtems/part/val/performance.yml
index 110c724..348dc0e 100644
--- a/spec/rtems/part/val/performance.yml
+++ b/spec/rtems/part/val/performance.yml
@@ -4,8 +4,8 @@ copyrights:
enabled-by: true
links: []
params:
- sample-count: 1000
buffer-count: 100
+ sample-count: 1000
test-brief: |
This test case provides a context to run Partition Manager performance tests.
test-cleanup: null
diff --git a/spec/spec/requirement-performance-runtime.yml b/spec/spec/requirement-performance-runtime.yml
index 085c5ac..7a06809 100644
--- a/spec/spec/requirement-performance-runtime.yml
+++ b/spec/spec/requirement-performance-runtime.yml
@@ -124,13 +124,11 @@ spec-info:
It shall provide the code of the measure runtime body handler. In
contrast to other methods, this method is mandatory.
spec-type: test-support-method
- test-setup:
- description: |
- It may provide the code of the measure runtime setup handler.
- spec-type: test-support-method
- test-teardown:
+ test-cleanup:
description: |
- It may provide the code of the measure runtime teardown handler.
+ It may provide the code to clean up the measure runtime request.
+ This method is called before the cleanup method of the corresponding
+ ${runtime-measurement-test:/spec-name} item and after the request.
spec-type: test-support-method
test-prepare:
description: |
@@ -138,11 +136,13 @@ spec-info:
method is called after the prepare method of the corresponding
${runtime-measurement-test:/spec-name} item and before the request.
spec-type: test-support-method
- test-cleanup:
+ test-setup:
description: |
- It may provide the code to clean up the measure runtime request.
- This method is called before the cleanup method of the corresponding
- ${runtime-measurement-test:/spec-name} item and after the request.
+ It may provide the code of the measure runtime setup handler.
+ spec-type: test-support-method
+ test-teardown:
+ description: |
+ It may provide the code of the measure runtime teardown handler.
spec-type: test-support-method
description: |
This set of attributes specifies a runtime performance requirement.
More information about the vc
mailing list