[Xenomai-core] [patch] minor doc clarification

[Xenomai-core] [patch] minor doc clarification

[Jan Kiszka]

[-- Attachment #1.1: Type: text/plain, Size: 222 bytes --]

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

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: join_nrt-doc.patch --]
[-- Type: text/x-patch; name="join_nrt-doc.patch", Size: 1365 bytes --]

Index: ChangeLog
===================================================================
--- ChangeLog	(Revision 219)
+++ ChangeLog	(Arbeitskopie)
@@ -1,3 +1,7 @@
+2005-12-01  Jan Kiszka  <jan.kiszka@domain.hid>
+
+	* ksrc/skins/rtdm/drvlib.c (rtdm_task_join_nrt): Clarify doc.
+
 2005-11-30  Philippe Gerum  <rpm@xenomai.org>
 
 	* 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 <iggarpe@domain.hid>
+2005-11-30  Ignacio Garcia Perez <iggarpe@domain.hid>
 
 	* ksrc/nucleus/timer.c: Make internal routines static.
 
Index: ksrc/skins/rtdm/drvlib.c
===================================================================
--- ksrc/skins/rtdm/drvlib.c	(Revision 219)
+++ ksrc/skins/rtdm/drvlib.c	(Arbeitskopie)
@@ -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:

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 256 bytes --]

Re: [Xenomai-core] [patch] minor doc clarification

[Philippe Gerum]

Jan Kiszka wrote:
> Hi,
> 
> this patch clarifies the usage of rtdm_task_join_nrt.

Applied, thanks.

> 
> 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	(Revision 219)
> +++ ChangeLog	(Arbeitskopie)
> @@ -1,3 +1,7 @@
> +2005-12-01  Jan Kiszka  <jan.kiszka@domain.hid>
> +
> +	* ksrc/skins/rtdm/drvlib.c (rtdm_task_join_nrt): Clarify doc.
> +
>  2005-11-30  Philippe Gerum  <rpm@xenomai.org>
>  
>  	* 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 <iggarpe@domain.hid>
> +2005-11-30  Ignacio Garcia Perez <iggarpe@domain.hid>
>  
>  	* ksrc/nucleus/timer.c: Make internal routines static.
>  
> Index: ksrc/skins/rtdm/drvlib.c
> ===================================================================
> --- ksrc/skins/rtdm/drvlib.c	(Revision 219)
> +++ ksrc/skins/rtdm/drvlib.c	(Arbeitskopie)
> @@ -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
> Xenomai-core@domain.hid
> https://mail.gna.org/listinfo/xenomai-core


-- 

Philippe.