aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_strdup.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_strdup.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_strdup.3.adoc')
-rw-r--r--docs/man/nng_strdup.3.adoc6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/man/nng_strdup.3.adoc b/docs/man/nng_strdup.3.adoc
index 23e23a43..6efacc37 100644
--- a/docs/man/nng_strdup.3.adoc
+++ b/docs/man/nng_strdup.3.adoc
@@ -26,14 +26,14 @@ char *nng_strdup(const char *src);
The `nng_strdup()` duplicates the string _src_ and returns it.
-This is logically equiavlent to using <<nng_alloc.3#,`nng_alloc()`>>
+This is logically equiavlent to using `<<nng_alloc.3#,nng_alloc()>>`
to allocate a region of memory of `strlen(s) + 1` bytes, and then
using `strcpy()` to copy the string into the destination before
returning it.
The returned string should be deallocated with
-<<nng_strfree.3#,`nng_strfree()`>>, or may be deallocated using the
-<<nng_free.3#,`nng_free()`>> using the length of the returned string plus
+`<<nng_strfree.3#,nng_strfree()>>`, or may be deallocated using the
+`<<nng_free.3#,nng_free()>>` using the length of the returned string plus
one (for the `NUL` terminating byte).
IMPORTANT: Do not use the system `free()` or similar functions to deallocate