aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_alloc.3.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_alloc.3.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_alloc.3.adoc')
-rw-r--r--docs/man/nng_alloc.3.adoc4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/man/nng_alloc.3.adoc b/docs/man/nng_alloc.3.adoc
index a43140d1..3b6e27dd 100644
--- a/docs/man/nng_alloc.3.adoc
+++ b/docs/man/nng_alloc.3.adoc
@@ -29,9 +29,9 @@ at least _size_ bytes.
The memory will be 64-bit aligned.
The returned memory can be used to hold message buffers, in which
-case it can be directly passed to <<nng_send.3#,`nng_send()`>> using
+case it can be directly passed to `<<nng_send.3#,nng_send()>>` using
the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no
-longer needed using <<nng_free.3#,`nng_free()`>>.
+longer needed using `<<nng_free.3#,nng_free()>>`.
IMPORTANT: Do not use the system `free()` function to release this memory.
On some platforms this may work, but it is not guaranteed and may lead