[rtems commit] rtems: Clarify invalid identifier descriptions

Sebastian Huber sebh at rtems.org
Wed Dec 2 07:34:26 UTC 2020


Module:    rtems
Branch:    master
Commit:    1af4493bdb20cda2879af65e92bc97bf9c60c3b5
Changeset: http://git.rtems.org/rtems/commit/?id=1af4493bdb20cda2879af65e92bc97bf9c60c3b5

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Dec  2 08:32:44 2020 +0100

rtems: Clarify invalid identifier descriptions

Update #3993.

---

 cpukit/include/rtems/rtems/event.h |  3 ++-
 cpukit/include/rtems/rtems/part.h  | 12 ++++++------
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h
index 2a58b98..78d8421 100644
--- a/cpukit/include/rtems/rtems/event.h
+++ b/cpukit/include/rtems/rtems/event.h
@@ -622,7 +622,8 @@ static inline rtems_status_code rtems_event_transient_send( rtems_id id )
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *
- * @retval ::RTEMS_INVALID_ID There was no task with the specified identifier.
+ * @retval ::RTEMS_INVALID_ID There was no task associated with the identifier
+ *   specified by ``id``.
  */
 rtems_status_code rtems_event_send( rtems_id id, rtems_event_set event_in );
 
diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
index 83c8e5a..aeb4de6 100644
--- a/cpukit/include/rtems/rtems/part.h
+++ b/cpukit/include/rtems/rtems/part.h
@@ -292,8 +292,8 @@ rtems_status_code rtems_partition_ident(
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *
- * @retval ::RTEMS_INVALID_ID There was no partition with the specified
- *   identifier.
+ * @retval ::RTEMS_INVALID_ID There was no partition associated with the
+ *   identifier specified by ``id``.
  *
  * @retval ::RTEMS_ILLEGAL_ON_REMOTE_OBJECT The partition resided on a remote
  *   node.
@@ -333,8 +333,8 @@ rtems_status_code rtems_partition_delete( rtems_id id );
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *
- * @retval ::RTEMS_INVALID_ID There was no partition with the specified
- *   identifier.
+ * @retval ::RTEMS_INVALID_ID There was no partition associated with the
+ *   identifier specified by ``id``.
  *
  * @retval ::RTEMS_INVALID_ADDRESS The ``buffer`` parameter was NULL.
  *
@@ -368,8 +368,8 @@ rtems_status_code rtems_partition_get_buffer( rtems_id id, void **buffer );
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *
- * @retval ::RTEMS_INVALID_ID There was no partition with the specified
- *   identifier.
+ * @retval ::RTEMS_INVALID_ID There was no partition associated with the
+ *   identifier specified by ``id``.
  *
  * @retval ::RTEMS_INVALID_ADDRESS The buffer referenced by ``buffer`` was not
  *   in the partition.



More information about the vc mailing list