[rtems-central commit] spec: Review status codes
Sebastian Huber
sebh at rtems.org
Fri Sep 25 12:00:07 UTC 2020
Module: rtems-central
Branch: master
Commit: 766be97acebdd5ab39dfeaf915a531b97b9f5e9a
Changeset: http://git.rtems.org/rtems-central/commit/?id=766be97acebdd5ab39dfeaf915a531b97b9f5e9a
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Sep 25 13:55:50 2020 +0200
spec: Review status codes
---
spec/rtems/status/if/code-to-errno.yml | 22 +++++++++++-----------
spec/rtems/status/if/first.yml | 3 ++-
spec/rtems/status/if/header.yml | 4 +++-
spec/rtems/status/if/illegal-on-remote-object.yml | 2 +-
spec/rtems/status/if/illegal-on-self.yml | 2 +-
spec/rtems/status/if/incorrect-state.yml | 4 ++--
spec/rtems/status/if/interrupted.yml | 5 +++--
spec/rtems/status/if/invalid-address.yml | 2 +-
spec/rtems/status/if/invalid-clock.yml | 2 +-
spec/rtems/status/if/invalid-id.yml | 2 +-
spec/rtems/status/if/invalid-name.yml | 2 +-
spec/rtems/status/if/invalid-node.yml | 2 +-
spec/rtems/status/if/invalid-number.yml | 2 +-
spec/rtems/status/if/invalid-size.yml | 2 +-
spec/rtems/status/if/is-successful.yml | 2 +-
spec/rtems/status/if/last.yml | 3 ++-
spec/rtems/status/if/mp-not-configured.yml | 2 +-
spec/rtems/status/if/not-owner-of-resource.yml | 2 +-
spec/rtems/status/if/proxy-blocking.yml | 2 +-
spec/rtems/status/if/resource-in-use.yml | 2 +-
spec/rtems/status/if/text.yml | 2 +-
21 files changed, 38 insertions(+), 33 deletions(-)
diff --git a/spec/rtems/status/if/code-to-errno.yml b/spec/rtems/status/if/code-to-errno.yml
index 40547ff..30edb2c 100644
--- a/spec/rtems/status/if/code-to-errno.yml
+++ b/spec/rtems/status/if/code-to-errno.yml
@@ -28,23 +28,23 @@ return:
return: null
return-values:
- description: |
- The status code is ${successful:/name}.
+ The status code was ${successful:/name}.
value: '0'
- description: |
- The status code is ${invalid-number:/name}.
+ The status code was ${invalid-number:/name}.
value: EBADF
- description: |
- The status code is ${resource-in-use:/name}.
+ The status code was ${resource-in-use:/name}.
value: EBUSY
- description: |
- The status code is ${interrupted:/name}.
+ The status code was ${interrupted:/name}.
value: EINTR
- description: |
- The status code is ${invalid-clock:/name},
+ The status code was ${invalid-clock:/name},
${invalid-name:/name}, or ${invalid-node:/name}.
value: EINVAL
- description: |
- The status code is ${already-suspended:/name},
+ The status code was ${already-suspended:/name},
${called-from-isr:/name},
${illegal-on-remote-object:/name},
${illegal-on-self:/name}, ${incorrect-state:/name},
@@ -56,19 +56,19 @@ return:
${task-exitted:/name}, or ${too-many:/name}.
value: EIO
- description: |
- The status code is ${unsatisfied:/name}.
+ The status code was ${unsatisfied:/name}.
value: ENODEV
- description: |
- The status code is ${no-memory:/name}.
+ The status code was ${no-memory:/name}.
value: ENOMEM
- description: |
- The status code is ${not-configured:/name} or
+ The status code was ${not-configured:/name} or
${not-implemented:/name}.
value: ENOSYS
- description: |
- The status code is ${not-owner-of-resource:/name}.
+ The status code was ${not-owner-of-resource:/name}.
value: EPERM
- description: |
- The status code is ${timeout:/name}.
+ The status code was ${timeout:/name}.
value: ETIMEDOUT
type: interface
diff --git a/spec/rtems/status/if/first.yml b/spec/rtems/status/if/first.yml
index 5f704e9..9b9743d 100644
--- a/spec/rtems/status/if/first.yml
+++ b/spec/rtems/status/if/first.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is the lowest valid value for a Classic API status code.
+ This constant represents the lowest valid value for a Classic API status
+ code.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/header.yml b/spec/rtems/status/if/header.yml
index f3ed7d7..aedf095 100644
--- a/spec/rtems/status/if/header.yml
+++ b/spec/rtems/status/if/header.yml
@@ -1,5 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: This header file defines the status codes provided by API.
+brief: |
+ This header file defines the status codes and support functions of the
+ Classic API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/rtems/status/if/illegal-on-remote-object.yml b/spec/rtems/status/if/illegal-on-remote-object.yml
index 924c6e1..dadcf5f 100644
--- a/spec/rtems/status/if/illegal-on-remote-object.yml
+++ b/spec/rtems/status/if/illegal-on-remote-object.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the operation is illegal on a remote object.
+ This status code indicates that the operation was illegal on a remote object.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/illegal-on-self.yml b/spec/rtems/status/if/illegal-on-self.yml
index d747933..100a9ca 100644
--- a/spec/rtems/status/if/illegal-on-self.yml
+++ b/spec/rtems/status/if/illegal-on-self.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the operation is illegal on the calling
+ This status code indicates that the operation was illegal on the calling
thread.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
diff --git a/spec/rtems/status/if/incorrect-state.yml b/spec/rtems/status/if/incorrect-state.yml
index 9c30f28..b02c4ab 100644
--- a/spec/rtems/status/if/incorrect-state.yml
+++ b/spec/rtems/status/if/incorrect-state.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that an object is in wrong state for the requested
- operation.
+ This status code indicates that an object was in wrong state for the
+ requested operation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/interrupted.yml b/spec/rtems/status/if/interrupted.yml
index c79fa7f..dc09f08 100644
--- a/spec/rtems/status/if/interrupted.yml
+++ b/spec/rtems/status/if/interrupted.yml
@@ -1,7 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code is used internally to indicate a blocking device driver call
- has been interrupted and should be reflected to the caller as interrupted.
+ This status code is used internally by the implementation to indicate a
+ blocking device driver call has been interrupted and should be reflected to
+ the caller as interrupted.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2019 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-address.yml b/spec/rtems/status/if/invalid-address.yml
index e6cb921..2c2948d 100644
--- a/spec/rtems/status/if/invalid-address.yml
+++ b/spec/rtems/status/if/invalid-address.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the specified address is invalid.
+ This status code indicates that a specified address was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-clock.yml b/spec/rtems/status/if/invalid-clock.yml
index 6bcd728..c39e63b 100644
--- a/spec/rtems/status/if/invalid-clock.yml
+++ b/spec/rtems/status/if/invalid-clock.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the specified date/time was invalid.
+ This status code indicates that a specified date/time was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-id.yml b/spec/rtems/status/if/invalid-id.yml
index d51875e..7ae8c4c 100644
--- a/spec/rtems/status/if/invalid-id.yml
+++ b/spec/rtems/status/if/invalid-id.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the object identifier was invalid.
+ This status code indicates that an object identifier was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-name.yml b/spec/rtems/status/if/invalid-name.yml
index 980951f..665c53e 100644
--- a/spec/rtems/status/if/invalid-name.yml
+++ b/spec/rtems/status/if/invalid-name.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the object name was invalid.
+ This status code indicates that an object name was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-node.yml b/spec/rtems/status/if/invalid-node.yml
index 98bce39..5b9a2c4 100644
--- a/spec/rtems/status/if/invalid-node.yml
+++ b/spec/rtems/status/if/invalid-node.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the specified node identifier was invalid.
+ This status code indicates that a specified node identifier was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-number.yml b/spec/rtems/status/if/invalid-number.yml
index f4c3bd0..e7f9ec4 100644
--- a/spec/rtems/status/if/invalid-number.yml
+++ b/spec/rtems/status/if/invalid-number.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the specified number was invalid.
+ This status code indicates that a specified number was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/invalid-size.yml b/spec/rtems/status/if/invalid-size.yml
index fc42cae..56960da 100644
--- a/spec/rtems/status/if/invalid-size.yml
+++ b/spec/rtems/status/if/invalid-size.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the specified size was invalid.
+ This status code indicates that a specified size was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/is-successful.yml b/spec/rtems/status/if/is-successful.yml
index 71dce79..78f86dc 100644
--- a/spec/rtems/status/if/is-successful.yml
+++ b/spec/rtems/status/if/is-successful.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the status code is ${successful:/name}, otherwise
+ Returns true, if the status code is equal to ${successful:/name}, otherwise
returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
diff --git a/spec/rtems/status/if/last.yml b/spec/rtems/status/if/last.yml
index fdcebff..f5f96b7 100644
--- a/spec/rtems/status/if/last.yml
+++ b/spec/rtems/status/if/last.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is the highest valid value for a Classic API status code.
+ This constant represents the highest valid value for a Classic API status
+ code.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/mp-not-configured.yml b/spec/rtems/status/if/mp-not-configured.yml
index 47f3c25..abbfd6d 100644
--- a/spec/rtems/status/if/mp-not-configured.yml
+++ b/spec/rtems/status/if/mp-not-configured.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that multiprocessing is not configured.
+ This status code indicates that multiprocessing was not configured.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/not-owner-of-resource.yml b/spec/rtems/status/if/not-owner-of-resource.yml
index bd0697c..b83c6f7 100644
--- a/spec/rtems/status/if/not-owner-of-resource.yml
+++ b/spec/rtems/status/if/not-owner-of-resource.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the caller is not the owner of the resource.
+ This status code indicates that the caller was not the owner of the resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/proxy-blocking.yml b/spec/rtems/status/if/proxy-blocking.yml
index f588a6e..279aab0 100644
--- a/spec/rtems/status/if/proxy-blocking.yml
+++ b/spec/rtems/status/if/proxy-blocking.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This is the status is used internally to RTEMS when performing
+ This status code is used internally by the implementation when performing
operations on behalf of remote tasks.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
diff --git a/spec/rtems/status/if/resource-in-use.yml b/spec/rtems/status/if/resource-in-use.yml
index 21d609e..231f802 100644
--- a/spec/rtems/status/if/resource-in-use.yml
+++ b/spec/rtems/status/if/resource-in-use.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that the object still has resources in use.
+ This status code indicates that the object still had resources in use.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/status/if/text.yml b/spec/rtems/status/if/text.yml
index 6e0c9e4..1839add 100644
--- a/spec/rtems/status/if/text.yml
+++ b/spec/rtems/status/if/text.yml
@@ -27,6 +27,6 @@ params:
return:
return: Otherwise, a text describing the status code.
return-values:
- - description: The passed status code is invalid.
+ - description: The specified status code is invalid.
value: '"?"'
type: interface
More information about the vc
mailing list