aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_cv_wake1.3supp.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-01 17:11:32 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-01 19:18:37 -0700
commit3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch)
treed670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_cv_wake1.3supp.adoc
parent1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff)
downloadnng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz
nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2
nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to make any text styling (generally literal characters) outside of the link, to avoid having the styling override the link color. (We prefer to have links colored for ease of use.) While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_cv_wake1.3supp.adoc')
-rw-r--r--docs/man/nng_cv_wake1.3supp.adoc6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/man/nng_cv_wake1.3supp.adoc b/docs/man/nng_cv_wake1.3supp.adoc
index 1938a702..29a4ed88 100644
--- a/docs/man/nng_cv_wake1.3supp.adoc
+++ b/docs/man/nng_cv_wake1.3supp.adoc
@@ -27,8 +27,8 @@ void nng_cv_wake1(nng_cv *cv);
The `nng_cv_wake1()` wakes at most one thread waiting for the condition
variable _cv_
-to be signaled in the <<nng_cv_wait.3supp#,`nng_cv_wait()`>> or
-<<nng_cv_until.3supp#,`nng_cv_until()`>> functions.
+to be signaled in the `<<nng_cv_wait.3supp#,nng_cv_wait()>>` or
+`<<nng_cv_until.3supp#,nng_cv_until()>>` functions.
The caller must have have ownership of the mutex that was used when
_cv_ was allocated.
@@ -39,7 +39,7 @@ will check, while holding the mutex.
TIP: While this function avoids the "`thundering herd`" problem, the
caller cannot predict which waiter will be woken, and so the design must
ensure that it is sufficient that _any_ waiter be woken.
-When in doubt, it is safer to use <<nng_cv_wake.3supp#,`nng_cv_wake()`>>.
+When in doubt, it is safer to use `<<nng_cv_wake.3supp#,nng_cv_wake()>>`.
== RETURN VALUES