sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Fix semaphore related function names

Browse Source
This commit is contained in:
YAMAMOTO Takashi 2020-04-17 16:08:07 +09:00 committed by Xiang Xiao
parent e855a1b25c
commit 781bf68b5c
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/NuttxUserGuide.html
View File

@ -3920,7 +3920,7 @@ interface of the same name.
<pre>
#include &lt;semaphore.h&gt;
#include &lt;time.h&gt;
int sem_wait(sem_t *sem, const struct timespec *abstime);
int sem_timedwait(sem_t *sem, const struct timespec *abstime);
</pre>
<p>
@ -3948,7 +3948,7 @@ interface of the same name.
<li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) is unsuccessful
</ul>
<p>
If <code>sem_wait</code> returns -1 (<code>ERROR</code>) then the cause of the failure
If <code>sem_timedwait</code> returns -1 (<code>ERROR</code>) then the cause of the failure
will be indicated by the thread-specific <a href="#ErrnoAccess"><code>errno</code></a>.
The following lists the possible values for <a href="#ErrnoAccess"><code>errno</code></a>:
<p>
@ -4006,7 +4006,7 @@ returns without blocking.
<ul>
<li>0 (<code>OK</code>) or -1 (<code>ERROR</code>) if unsuccessful
</ul>
If <code>sem_wait</code> returns -1 (<code>ERROR</code>) then the cause of the failure
If <code>sem_trywait</code> returns -1 (<code>ERROR</code>) then the cause of the failure
will be indicated by the thread-specific <a href="#ErrnoAccess"><code>errno</code></a>.
The following lists the possible values for <a href="#ErrnoAccess"><code>errno</code></a>:
<p>
@ -4165,7 +4165,7 @@ Otherwise, an -1 (<code>ERROR</code>) will be returned and the <code>errno</code
<b>Returned Value:</b>
</p>
<p>
If successful, the <code>sem_getprotocol()</code> function will return zero (<code>OK</code>).
If successful, the <code>sem_setprotocol()</code> function will return zero (<code>OK</code>).
Otherwise, an -1 (<code>ERROR</code>) will be returned and the <code>errno</code> value will be set to indicate the nature of the error.
</p>
<p>