From 670be3c6f2af83bb7375595e09416fdeb79e610d Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 9 Aug 2010 07:51:19 +0000 Subject: 2010-08-09 Sebastian Huber PR 1513/doc * user/chains.t: Added missing functions. Uniform text for unprotected functions. --- doc/user/chains.t | 80 +++++++++++-------------------------------------------- 1 file changed, 16 insertions(+), 64 deletions(-) (limited to 'doc/user/chains.t') diff --git a/doc/user/chains.t b/doc/user/chains.t index 44ac4f66c9..24b6390c32 100755 --- a/doc/user/chains.t +++ b/doc/user/chains.t @@ -34,8 +34,11 @@ provided by RTEMS is: @item @code{@value{DIRPREFIX}chain_is_head} - Is the node the head ? @item @code{@value{DIRPREFIX}chain_is_tail} - Is the node the tail ? @item @code{@value{DIRPREFIX}chain_extract} - Extract the node from the chain +@item @code{@value{DIRPREFIX}chain_extract_unprotected} - Extract the node from the chain (unprotected) @item @code{@value{DIRPREFIX}chain_get} - Return the first node on the chain +@item @code{@value{DIRPREFIX}chain_get_unprotected} - Return the first node on the chain (unprotected) @item @code{@value{DIRPREFIX}chain_insert} - Insert the node into the chain +@item @code{@value{DIRPREFIX}chain_insert_unprotected} - Insert the node into the chain (unprotected) @item @code{@value{DIRPREFIX}chain_append} - Append the node to chain @item @code{@value{DIRPREFIX}chain_append_unprotected} - Append the node to chain (unprotected) @item @code{@value{DIRPREFIX}chain_prepend} - Prepend the node to the end of the chain @@ -588,6 +591,9 @@ This routine extracts the node from the chain on which it resides. Interrupts are disabled while extracting the node to ensure the atomicity of the operation. +Use @code{@value{DIRPREFIX}chain_extract_unprotected()} to avoid disabling of +interrupts. + @c @c @c @@ -623,6 +629,9 @@ pointer to that node. If the chain is empty, then NULL is returned. Interrupts are disabled while obtaining the node to ensure the atomicity of the operation. +Use @code{@value{DIRPREFIX}chain_get_unprotected()} to avoid disabling of +interrupts. + @c @c @c @@ -657,6 +666,9 @@ specified node. Interrupts are disabled during the insert to ensure the atomicity of the operation. +Use @code{@value{DIRPREFIX}chain_insert_unprotected()} to avoid disabling of +interrupts. + @c @c @c @@ -690,38 +702,8 @@ This routine appends a node to the end of a chain. Interrupts are disabled during the append to ensure the atomicity of the operation. -@c -@c -@c -@page -@subsection Append a Node (unprotected) - -@cindex chain append a node unprotected - -@subheading CALLING SEQUENCE: - -@ifset is-C -@findex @value{DIRPREFIX}chain_append_unprotected -@example -void @value{DIRPREFIX}chain_append_unprotected( - @value{DIRPREFIX}chain_control *the_chain, - @value{DIRPREFIX}chain_node *the_node -); -@end example -@end ifset - -@subheading RETURNS - -Returns nothing. - -@subheading DESCRIPTION: - -This routine appends a node to the end of a chain. - -@subheading NOTES: - -Interrupts are NOT disabled during the append to ensure the atomicity of -the operation. +Use @code{@value{DIRPREFIX}chain_append_unprotected()} to avoid disabling of +interrupts. @c @c @@ -756,35 +738,5 @@ This routine prepends a node to the front of the chain. Interrupts are disabled during the prepend to ensure the atomicity of the operation. -@c -@c -@c -@page -@subsection Prepend a Node (unprotected) - -@cindex prepend node - -@subheading CALLING SEQUENCE: - -@ifset is-C -@findex @value{DIRPREFIX}chain_prepend_unprotected -@example -void @value{DIRPREFIX}chain_prepend_unprotected( - @value{DIRPREFIX}chain_control *the_chain, - @value{DIRPREFIX}chain_node *the_node -); -@end example -@end ifset - -@subheading RETURNS - -Returns nothing. - -@subheading DESCRIPTION: - -This routine prepends a node to the front of the chain. - -@subheading NOTES: - -Interrupts are NOT disabled during the prepend to ensure the atomicity of -the operation. +Use @code{@value{DIRPREFIX}chain_prepend_unprotected()} to avoid disabling of +interrupts. -- cgit v1.2.3