summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 08:31:46 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 08:32:08 +0100
commitc3193cc178cbed469704ad85add339ea01713bd1 (patch)
tree87c805386dfc7ca3507201fa12ebd58a218202b9
parentspec: Fix Doxygen group identifiers (diff)
downloadrtems-central-c3193cc178cbed469704ad85add339ea01713bd1.tar.bz2
spec: Clarify invalid identifier descriptions
-rw-r--r--spec/rtems/event/if/send.yml3
-rw-r--r--spec/rtems/part/if/delete.yml3
-rw-r--r--spec/rtems/part/if/get-buffer.yml3
-rw-r--r--spec/rtems/part/if/return-buffer.yml3
-rw-r--r--spec/rtems/scheduler/if/add-processor.yml3
-rw-r--r--spec/rtems/scheduler/if/get-maximum-priority.yml3
-rw-r--r--spec/rtems/scheduler/if/get-processor-set.yml3
-rw-r--r--spec/rtems/scheduler/if/map-priority-from-posix.yml3
-rw-r--r--spec/rtems/scheduler/if/map-priority-to-posix.yml3
-rw-r--r--spec/rtems/scheduler/if/remove-processor.yml3
10 files changed, 20 insertions, 10 deletions
diff --git a/spec/rtems/event/if/send.yml b/spec/rtems/event/if/send.yml
index a2ff4d4f..f0615030 100644
--- a/spec/rtems/event/if/send.yml
+++ b/spec/rtems/event/if/send.yml
@@ -71,6 +71,7 @@ return:
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
- There was no task with the specified identifier.
+ There was no task associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
type: interface
diff --git a/spec/rtems/part/if/delete.yml b/spec/rtems/part/if/delete.yml
index 2b4d8f16..5dad046b 100644
--- a/spec/rtems/part/if/delete.yml
+++ b/spec/rtems/part/if/delete.yml
@@ -52,7 +52,8 @@ return:
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
- There was no partition with the specified identifier.
+ There was no partition associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The partition resided on a remote node.
diff --git a/spec/rtems/part/if/get-buffer.yml b/spec/rtems/part/if/get-buffer.yml
index adced27f..b2b13bd6 100644
--- a/spec/rtems/part/if/get-buffer.yml
+++ b/spec/rtems/part/if/get-buffer.yml
@@ -55,7 +55,8 @@ return:
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
- There was no partition with the specified identifier.
+ There was no partition associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
diff --git a/spec/rtems/part/if/return-buffer.yml b/spec/rtems/part/if/return-buffer.yml
index 7f312031..db67b5c9 100644
--- a/spec/rtems/part/if/return-buffer.yml
+++ b/spec/rtems/part/if/return-buffer.yml
@@ -49,7 +49,8 @@ return:
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
- There was no partition with the specified identifier.
+ There was no partition associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The buffer referenced by ${.:/params[1]/name} was not in the
diff --git a/spec/rtems/scheduler/if/add-processor.yml b/spec/rtems/scheduler/if/add-processor.yml
index 31522a56..c7aa80b2 100644
--- a/spec/rtems/scheduler/if/add-processor.yml
+++ b/spec/rtems/scheduler/if/add-processor.yml
@@ -43,7 +43,8 @@ return:
was not online.
value: ${../../status/if/incorrect-state:/name}
- description: |
- The scheduler instance identifier was invalid.
+ There was no scheduler associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The processor was not configured to be used by the application.
diff --git a/spec/rtems/scheduler/if/get-maximum-priority.yml b/spec/rtems/scheduler/if/get-maximum-priority.yml
index fa0c06da..002d3a94 100644
--- a/spec/rtems/scheduler/if/get-maximum-priority.yml
+++ b/spec/rtems/scheduler/if/get-maximum-priority.yml
@@ -43,6 +43,7 @@ return:
The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
- The scheduler instance identifier was invalid.
+ There was no scheduler associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
type: interface
diff --git a/spec/rtems/scheduler/if/get-processor-set.yml b/spec/rtems/scheduler/if/get-processor-set.yml
index 7e9dc1f3..9a942fc5 100644
--- a/spec/rtems/scheduler/if/get-processor-set.yml
+++ b/spec/rtems/scheduler/if/get-processor-set.yml
@@ -51,7 +51,8 @@ return:
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
- The scheduler instance identifier was invalid.
+ There was no scheduler associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The provided processor set was too small for the set of processors owned
diff --git a/spec/rtems/scheduler/if/map-priority-from-posix.yml b/spec/rtems/scheduler/if/map-priority-from-posix.yml
index adb7eaac..4b8bbe0f 100644
--- a/spec/rtems/scheduler/if/map-priority-from-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-from-posix.yml
@@ -47,7 +47,8 @@ return:
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
- The scheduler instance identifier was invalid.
+ There was no scheduler associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The POSIX thread priority was invalid.
diff --git a/spec/rtems/scheduler/if/map-priority-to-posix.yml b/spec/rtems/scheduler/if/map-priority-to-posix.yml
index 3780f00a..50d6b8d9 100644
--- a/spec/rtems/scheduler/if/map-priority-to-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-to-posix.yml
@@ -47,7 +47,8 @@ return:
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
- The scheduler instance identifier was invalid.
+ There was no scheduler associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The Classic API task priority was invalid.
diff --git a/spec/rtems/scheduler/if/remove-processor.yml b/spec/rtems/scheduler/if/remove-processor.yml
index 82d7907f..9db5152b 100644
--- a/spec/rtems/scheduler/if/remove-processor.yml
+++ b/spec/rtems/scheduler/if/remove-processor.yml
@@ -40,7 +40,8 @@ return:
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
- The scheduler instance identifier was invalid.
+ There was no scheduler associated with the identifier specified by
+ ${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The processor was not owned by the specified scheduler instance.