aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-06 21:15:31 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 21:15:31 -0700
commit415c04a43804cd0e0a4d3f0d49743aedd0ee4cce (patch)
tree758b1d95774d52e920238e955a7bb69527ec42df /docs/man
parent11309ac51b9502334fa97f7a565b62d9ef5f2d3c (diff)
downloadnng-415c04a43804cd0e0a4d3f0d49743aedd0ee4cce.tar.gz
nng-415c04a43804cd0e0a4d3f0d49743aedd0ee4cce.tar.bz2
nng-415c04a43804cd0e0a4d3f0d49743aedd0ee4cce.zip
Convert nng_alloc and nng_free to mdbook.
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/libnng.3.adoc4
-rw-r--r--docs/man/nng_alloc.3.adoc56
-rw-r--r--docs/man/nng_free.3.adoc53
3 files changed, 2 insertions, 111 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index becffaa9..14ba6d69 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -31,8 +31,8 @@ It provides a C language API.
The following common functions exist in _libnng_.
|===
-|xref:nng_alloc.3.adoc[nng_alloc()]|allocate memory
-|xref:nng_free.3.adoc[nng_free()]|free memory
+//|xref:nng_alloc.3.adoc[nng_alloc()]|allocate memory
+//|xref:nng_free.3.adoc[nng_free()]|free memory
|xref:nng_strdup.3.adoc[nng_strdup()]|duplicate string
|xref:nng_strerror.3.adoc[nng_strerror()]|return an error description
|xref:nng_strfree.3.adoc[nng_strfree()]|free string
diff --git a/docs/man/nng_alloc.3.adoc b/docs/man/nng_alloc.3.adoc
deleted file mode 100644
index 93c03111..00000000
--- a/docs/man/nng_alloc.3.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-= nng_alloc(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// This document is supplied under the terms of the MIT License, a
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt). A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_alloc - allocate memory
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void *nng_alloc(size_t size);
-----
-
-== DESCRIPTION
-
-The `nng_alloc()` function allocates a contiguous memory region of
-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 xref:nng_send.3.adoc[`nng_send()`] using
-the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no
-longer needed using xref:nng_free.3.adoc[`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
-to a crash or other undesirable and unpredictable behavior.
-
-== RETURN VALUES
-
-This function returns a pointer to the allocated memory on success,
-and `NULL` otherwise.
-
-== ERRORS
-
-No errors are returned, but a `NULL` return value should be
-treated the same as `NNG_ENOMEM`.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_free.3.adoc[nng_free(3)],
-xref:nng_send.3.adoc[nng_send(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_free.3.adoc b/docs/man/nng_free.3.adoc
deleted file mode 100644
index b4fdc249..00000000
--- a/docs/man/nng_free.3.adoc
+++ /dev/null
@@ -1,53 +0,0 @@
-= nng_free(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// This document is supplied under the terms of the MIT License, a
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt). A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_free - free memory
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_free(void *ptr, size_t size);
-----
-
-== DESCRIPTION
-
-The `nng_free()` function deallocates a memory region of size _size_,
-that was previously allocated by xref:nng_alloc.3.adoc[`nng_alloc()`] or
-xref:nng_recv.3.adoc[`nng_recv()`] with the `NNG_FLAG_ALLOC` flag.
-
-IMPORTANT: It is very important that _size_ match the allocation size
-used to allocate the memory.
-
-IMPORTANT: Do not attempt to use this function to deallocate memory
-obtained by a call to the system `malloc()` or `calloc()` functions,
-or the {cpp} `new` operator.
-Doing so may result in unpredictable
-behavior, including corruption of application memory.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_alloc.3.adoc[nng_alloc(3)],
-xref:nng_recv.3.adoc[nng_recv(3)],
-xref:nng.7.adoc[nng(7)]