summaryrefslogtreecommitdiffstats
path: root/posix_users/thread_cancellation.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-02-26 18:22:07 +1100
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:26 -0400
commitfa70fd20878e402610c263f129266593d31a0376 (patch)
treec609d33c7047b975cfe8e0ac0df020fb26dae255 /posix_users/thread_cancellation.rst
parent238bf991f236b10fb544b4efad80bed0fb6aa394 (diff)
downloadrtems-docs-fa70fd20878e402610c263f129266593d31a0376.tar.bz2
POSIX User clean up.
Diffstat (limited to 'posix_users/thread_cancellation.rst')
-rw-r--r--posix_users/thread_cancellation.rst96
1 files changed, 61 insertions, 35 deletions
diff --git a/posix_users/thread_cancellation.rst b/posix_users/thread_cancellation.rst
index 5a70c40..67c7a78 100644
--- a/posix_users/thread_cancellation.rst
+++ b/posix_users/thread_cancellation.rst
@@ -1,3 +1,7 @@
+.. COMMENT: COPYRIGHT (c) 1988-2002.
+.. COMMENT: On-Line Applications Research Corporation (OAR).
+.. COMMENT: All rights reserved.
+
Thread Cancellation Manager
###########################
@@ -9,17 +13,17 @@ thread cancellation manager is ...
The directives provided by the thread cancellation manager are:
-- ``pthread_cancel`` - Cancel Execution of a Thread
+- pthread_cancel_ - Cancel Execution of a Thread
-- ``pthread_setcancelstate`` - Set Cancelability State
+- pthread_setcancelstate_ - Set Cancelability State
-- ``pthread_setcanceltype`` - Set Cancelability Type
+- pthread_setcanceltype_ - Set Cancelability Type
-- ``pthread_testcancel`` - Create Cancellation Point
+- pthread_testcancel_ - Create Cancellation Point
-- ``pthread_cleanup_push`` - Establish Cancellation Handler
+- pthread_cleanup_push_ - Establish Cancellation Handler
-- ``pthread_cleanup_pop`` - Remove Cancellation Handler
+- pthread_cleanup_pop_ - Remove Cancellation Handler
Background
==========
@@ -34,10 +38,11 @@ There is currently no text in this section.
Directives
==========
-This section details the thread cancellation manager's directives.
-A subsection is dedicated to each of this manager's directives
-and describes the calling sequence, related constants, usage,
-and status codes.
+This section details the thread cancellation manager's directives. A
+subsection is dedicated to each of this manager's directives and describes the
+calling sequence, related constants, usage, and status codes.
+
+.. _pthread_cancel:
pthread_cancel - Cancel Execution of a Thread
---------------------------------------------
@@ -46,20 +51,25 @@ pthread_cancel - Cancel Execution of a Thread
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
int pthread_cancel(
);
**STATUS CODES:**
-*E*
- The
+.. list-table::
+ :class: rtems-table
+
+ * - ``E``
+ - The
**DESCRIPTION:**
**NOTES:**
+.. _pthread_setcancelstate:
+
pthread_setcancelstate - Set Cancelability State
------------------------------------------------
.. index:: pthread_setcancelstate
@@ -67,20 +77,25 @@ pthread_setcancelstate - Set Cancelability State
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
int pthread_setcancelstate(
);
**STATUS CODES:**
-*E*
- The
+.. list-table::
+ :class: rtems-table
+
+ * - ``E``
+ - The
**DESCRIPTION:**
**NOTES:**
+.. _pthread_setcanceltype:
+
pthread_setcanceltype - Set Cancelability Type
----------------------------------------------
.. index:: pthread_setcanceltype
@@ -88,20 +103,25 @@ pthread_setcanceltype - Set Cancelability Type
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
int pthread_setcanceltype(
);
**STATUS CODES:**
-*E*
- The
+.. list-table::
+ :class: rtems-table
+
+ * - ``E``
+ - The
**DESCRIPTION:**
**NOTES:**
+.. _pthread_testcancel:
+
pthread_testcancel - Create Cancellation Point
----------------------------------------------
.. index:: pthread_testcancel
@@ -109,20 +129,25 @@ pthread_testcancel - Create Cancellation Point
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
int pthread_testcancel(
);
**STATUS CODES:**
-*E*
- The
+.. list-table::
+ :class: rtems-table
+
+ * - ``E``
+ - The
**DESCRIPTION:**
**NOTES:**
+.. _pthread_cleanup_push:
+
pthread_cleanup_push - Establish Cancellation Handler
-----------------------------------------------------
.. index:: pthread_cleanup_push
@@ -130,20 +155,25 @@ pthread_cleanup_push - Establish Cancellation Handler
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
int pthread_cleanup_push(
);
**STATUS CODES:**
-*E*
- The
+.. list-table::
+ :class: rtems-table
+
+ * - ``E``
+ - The
**DESCRIPTION:**
**NOTES:**
+.. _pthread_cleanup_pop:
+
pthread_cleanup_pop - Remove Cancellation Handler
-------------------------------------------------
.. index:: pthread_cleanup_pop
@@ -151,23 +181,19 @@ pthread_cleanup_pop - Remove Cancellation Handler
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
int pthread_cleanup_push(
);
**STATUS CODES:**
-*E*
- The
+.. list-table::
+ :class: rtems-table
+
+ * - ``E``
+ - The
**DESCRIPTION:**
**NOTES:**
-
-.. COMMENT: COPYRIGHT (c) 1988-2002.
-
-.. COMMENT: On-Line Applications Research Corporation (OAR).
-
-.. COMMENT: All rights reserved.
-