summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-02-27 09:27:23 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-02 08:11:42 +0100
commit834dcf57e71b3a4ae73d329066ee3af7c6cf5a4d (patch)
treea01d0f5afc12c7e73b48bdb9d1634cb7da88c4fc
parentc-user: Use four spaces per indent level (diff)
downloadrtems-docs-834dcf57e71b3a4ae73d329066ee3af7c6cf5a4d.tar.bz2
c-user: Clarify return code related terms
Remove duplicate "return code" definition. Add all related terms and use references. Update #3853.
-rw-r--r--c-user/glossary.rst18
1 files changed, 12 insertions, 6 deletions
diff --git a/c-user/glossary.rst b/c-user/glossary.rst
index 67dce76..9a88b5e 100644
--- a/c-user/glossary.rst
+++ b/c-user/glossary.rst
@@ -177,6 +177,9 @@ Glossary
The address at which a function or task begins to execute. In C, the
entry point of a function is the function's name.
+ error code
+ This term has the same meaning as :term:`status code`.
+
events
A method for task communication and synchronization. The directives
provided by the event manager are used to service events.
@@ -540,9 +543,6 @@ Glossary
The manipulation of an object which does not reside on the same node as
the calling task.
- return code
- Also known as error code or return value.
-
resource
A hardware or software entity to which access must be controlled.
@@ -552,8 +552,11 @@ Glossary
available for scheduling.
return code
- A value returned by RTEMS directives to indicate the completion status of
- the directive.
+ This term has the same meaning as :term:`status code`.
+
+ return value
+ The value returned by a function. A return value may be a
+ :term:`status code`.
RNCB
An acronym for :term:`Region Control Block`.
@@ -653,7 +656,10 @@ Glossary
store return information and local variables.
status code
- Also known as error code or return value.
+ A status code indicates the completion status of an operation. For
+ example most RTEMS directives return a status code through the
+ :term:`return value` to indicate a successful operation or error
+ conditions.
suspend
A term used to describe a task that is not competing for the CPU because it