[rtems commit] rtems: Clarify IO manager documentation

Sebastian Huber sebh at rtems.org
Wed Feb 17 19:26:41 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Feb 15 13:57:37 2021 +0100

rtems: Clarify IO manager documentation

Unify the wording across similar directives of other managers.

Update #3993.

---

 cpukit/include/rtems/io.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h
index f80d2ce..d8ce527 100644
--- a/cpukit/include/rtems/io.h
+++ b/cpukit/include/rtems/io.h
@@ -195,8 +195,8 @@ typedef struct {
  * @param driver_table is the device driver address table.
  *
  * @param[out] registered_major is the pointer to a device major number
- *   variable.  The device major number of the registered device will be stored
- *   in this variable, in case of a successful operation.
+ *   variable.  When the directive call is successful, the device major number
+ *   of the registered device will be stored in this variable.
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *



More information about the vc mailing list