You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by xi...@apache.org on 2020/04/17 08:48:46 UTC
[incubator-nuttx] 01/02: doc: Fix semaphore related function names
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git
commit 781bf68b5c6f7613310ce39fbe6eac40674594fd
Author: YAMAMOTO Takashi <ya...@midokura.com>
AuthorDate: Fri Apr 17 16:08:07 2020 +0900
doc: Fix semaphore related function names
---
Documentation/NuttxUserGuide.html | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html
index e88017d..ee4f1c7 100644
--- a/Documentation/NuttxUserGuide.html
+++ b/Documentation/NuttxUserGuide.html
@@ -3920,7 +3920,7 @@ interface of the same name.
<pre>
#include <semaphore.h>
#include <time.h>
- 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>