summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 09:09:18 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 09:16:49 +0100
commitf0d19f9749d813e8c2bbdab6383c4669a0829c4a (patch)
tree32e8db4c61d687d76d487c72a3eaf4b3d3134b7d
parent6a5957c1b206ccc7759dfb9bebfc9a0748614b39 (diff)
downloadrtems-central-f0d19f9749d813e8c2bbdab6383c4669a0829c4a.tar.bz2
spec: Review status codes API
-rw-r--r--spec/rtems/status/if/code-to-errno.yml2
-rw-r--r--spec/rtems/status/if/first.yml4
-rw-r--r--spec/rtems/status/if/group.yml3
-rw-r--r--spec/rtems/status/if/header.yml4
-rw-r--r--spec/rtems/status/if/invalid-clock.yml2
-rw-r--r--spec/rtems/status/if/io-error.yml2
-rw-r--r--spec/rtems/status/if/is-equal.yml7
-rw-r--r--spec/rtems/status/if/is-successful.yml7
-rw-r--r--spec/rtems/status/if/last.yml4
-rw-r--r--spec/rtems/status/if/successful.yml2
-rw-r--r--spec/rtems/status/if/task-exitted.yml2
-rw-r--r--spec/rtems/status/if/text.yml8
12 files changed, 26 insertions, 21 deletions
diff --git a/spec/rtems/status/if/code-to-errno.yml b/spec/rtems/status/if/code-to-errno.yml
index 127f31fc..24b6943c 100644
--- a/spec/rtems/status/if/code-to-errno.yml
+++ b/spec/rtems/status/if/code-to-errno.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Maps the specified RTEMS status code to a POSIX error number.
+ Maps the RTEMS status code to a POSIX error number.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
diff --git a/spec/rtems/status/if/first.yml b/spec/rtems/status/if/first.yml
index 452edca0..c695f1a6 100644
--- a/spec/rtems/status/if/first.yml
+++ b/spec/rtems/status/if/first.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant represents the lowest valid value for a Classic API status
- code.
+ This constant represents the lowest valid value for a Classic API directive
+ 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/group.yml b/spec/rtems/status/if/group.yml
index 541601df..2051ff4a 100644
--- a/spec/rtems/status/if/group.yml
+++ b/spec/rtems/status/if/group.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This group contains the Classic API status codes and support functions.
+ This group contains the Classic API directive status codes and support
+ functions.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
description: null
diff --git a/spec/rtems/status/if/header.yml b/spec/rtems/status/if/header.yml
index 7e80be0d..f4ca69b2 100644
--- a/spec/rtems/status/if/header.yml
+++ b/spec/rtems/status/if/header.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This header file defines the status codes and support functions of the
- Classic API.
+ This header file provides the status codes of Classic API directives and
+ support functions.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/rtems/status/if/invalid-clock.yml b/spec/rtems/status/if/invalid-clock.yml
index 316eaf0d..4d2f2772 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 a specified date/time was invalid.
+ This status code indicates that a specified date or 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/io-error.yml b/spec/rtems/status/if/io-error.yml
index d82d3c27..aa1afe5b 100644
--- a/spec/rtems/status/if/io-error.yml
+++ b/spec/rtems/status/if/io-error.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates an driver IO error.
+ This status code indicates a device driver IO error.
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-equal.yml b/spec/rtems/status/if/is-equal.yml
index 72fb4ae5..d8710e64 100644
--- a/spec/rtems/status/if/is-equal.yml
+++ b/spec/rtems/status/if/is-equal.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the left hand side status code is equal to the right hand
- side status code, otherwise returns false.
+ Checks if the status codes are equal.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
@@ -34,6 +33,8 @@ params:
dir: null
name: right_status_code
return:
- return: null
+ return: |
+ Returns true, if the left hand side status code is equal to the right hand
+ side status code, otherwise false.
return-values: []
type: interface
diff --git a/spec/rtems/status/if/is-successful.yml b/spec/rtems/status/if/is-successful.yml
index 52bfe520..579e6e7c 100644
--- a/spec/rtems/status/if/is-successful.yml
+++ b/spec/rtems/status/if/is-successful.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns true, if the status code is equal to ${successful:/name}, otherwise
- returns false.
+ Checks if the status code is ${successful:/name}.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
@@ -30,6 +29,8 @@ params:
dir: null
name: status_code
return:
- return: null
+ return: |
+ Returns true, if the status code is equal to ${successful:/name}, otherwise
+ false.
return-values: []
type: interface
diff --git a/spec/rtems/status/if/last.yml b/spec/rtems/status/if/last.yml
index fdd69d51..ecb246be 100644
--- a/spec/rtems/status/if/last.yml
+++ b/spec/rtems/status/if/last.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant represents the highest valid value for a Classic API status
- code.
+ This constant represents the highest valid value for a Classic API directive
+ 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/successful.yml b/spec/rtems/status/if/successful.yml
index e183e0c8..c78d4334 100644
--- a/spec/rtems/status/if/successful.yml
+++ b/spec/rtems/status/if/successful.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates successful completion.
+ This status code indicates successful completion of a 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/task-exitted.yml b/spec/rtems/status/if/task-exitted.yml
index a8bd16ec..9db24b19 100644
--- a/spec/rtems/status/if/task-exitted.yml
+++ b/spec/rtems/status/if/task-exitted.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This status code indicates that a thread exited.
+ This status code indicates that a thread exitted.
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 ffa2864d..3647b311 100644
--- a/spec/rtems/status/if/text.yml
+++ b/spec/rtems/status/if/text.yml
@@ -1,5 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: Returns a text describing the specified status code.
+brief: |
+ Maps the status code to a descriptive text.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -27,8 +28,9 @@ params:
dir: null
name: status_code
return:
- return: Otherwise, a text describing the status code.
+ return: |
+ Returns a text describing the status code, if the status code is valid.
return-values:
- - description: The specified status code is invalid.
+ - description: The status code is invalid.
value: '"?"'
type: interface