minor doc clarification

PATCH Applied Jan Kiszka 2 participants 2 messages Dec 1, 2005

lore

Share & tools

lore

Jan Kiszka

author

2005-12-01 00:24 UTC #0 lore raw

PATCH 1/1 minor doc clarification

Hi,

this patch clarifies the usage of rtdm_task_join_nrt.

Typically, rtdm_task_join_nrt + target task wakeup should be preferred over rtdm_task_destroy during cleanup of drivers. It's now intensively used in RTnet.

Jan

ChangeLog +5 -1

Index: ChangeLog
===================================================================
@@ -1,3 +1,7 @@
+2005-12-01  Jan Kiszka  <[email protected]>
+
+	* ksrc/skins/rtdm/drvlib.c (rtdm_task_join_nrt): Clarify doc.
+
 2005-11-30  Philippe Gerum  <[email protected]>
 
 	* ksrc/nucleus/pod.c (xnpod_delete_thread): Prevent double-deletion.

@@ -10,7 +14,7 @@
 	* ksrc/arch/powerpc/patches: Upgrade to Adeos
 	2.4.25-denx-0.9-04, 2.6.10-ppc64-r3.patch.
 
-2005-11-30  Ignacio Garc�a P�rez <[email protected]>
+2005-11-30  Ignacio Garcia Perez <[email protected]>
 
 	* ksrc/nucleus/timer.c: Make internal routines static.

skins/rtdm/drvlib.c +5 -0

Index: ksrc/skins/rtdm/drvlib.c
===================================================================
@@ -250,6 +250,11 @@
  * @param[in,out] task Task handle as returned by rtdm_task_init()
  * @param[in] poll_delay Polling delay in milliseconds
  *
+ * @note It is not required to call rtdm_task_destroy() for a task which has
+ * been passed to rtdm_task_join_nrt(). Moreover, don't forget to inform the
+ * targeted task that it has to terminate. Otherwise, this function will never
+ * return.
+ *
  * Environments:
  *
  * This service can be called from:

Philippe Gerum

Applied

2005-12-01 07:53 UTC #1 lore raw

Quoted 3 lines · Jan Kiszka

Hi,
this patch clarifies the usage of rtdm_task_join_nrt.

Applied, thanks.

Quoted 55 lines

Typically, rtdm_task_join_nrt + target task wakeup should be preferred over rtdm_task_destroy during cleanup of drivers. It's now intensively used in RTnet.
Jan
------------------------------------------------------------------------
Index: ChangeLog
===================================================================
ChangeLog +5 -1
@@ -1,3 +1,7 @@
+2005-12-01  Jan Kiszka  <[email protected]>
+
+	* ksrc/skins/rtdm/drvlib.c (rtdm_task_join_nrt): Clarify doc.
+
 2005-11-30  Philippe Gerum  <[email protected]>
 
 	* ksrc/nucleus/pod.c (xnpod_delete_thread): Prevent double-deletion.
@@ -10,7 +14,7 @@
 	* ksrc/arch/powerpc/patches: Upgrade to Adeos
 	2.4.25-denx-0.9-04, 2.6.10-ppc64-r3.patch.
 
-2005-11-30  Ignacio García Pérez <[email protected]>
+2005-11-30  Ignacio Garcia Perez <[email protected]>
 
 	* ksrc/nucleus/timer.c: Make internal routines static.
 
Index: ksrc/skins/rtdm/drvlib.c
===================================================================
skins/rtdm/drvlib.c +5 -1
@@ -250,6 +250,11 @@
  * @param[in,out] task Task handle as returned by rtdm_task_init()
  * @param[in] poll_delay Polling delay in milliseconds
  *
+ * @note It is not required to call rtdm_task_destroy() for a task which has
+ * been passed to rtdm_task_join_nrt(). Moreover, don't forget to inform the
+ * targeted task that it has to terminate. Otherwise, this function will never
+ * return.
+ *
  * Environments:
  *
  * This service can be called from:
 
 
------------------------------------------------------------------------
_______________________________________________
Xenomai-core mailing list
[email protected]
https://mail.gna.org/listinfo/xenomai-core

Signature · 1 line

Philippe.