From 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Thu, 15 Mar 2018 08:40:17 -0700
Subject: fixes #286 nng_pair0_open (and all others) need man page fixes #279
 consider restructuring man sections

This represents a rather significant rework, and major editing
effort, for the entire set of manual pages.

All of the pages now have a section number in their filename;
this assists in some other tooling, particularly ebook generation
as every link needs to be programmatically modified when combined
into an ebook.

Section 5 is introduced, and populated with pages for the main
types, and all options are now documented.

Numerous errors have been corrected, including rewriting certain
portions such as the header section of the surveyor protocol.

Much work has been done to facilitate index generation, although
certainly more work remains here.

Every internal link within these pages now resolves; there are no
more dead links.  (This is required to generate Kindle format books.)
---
 docs/man/nng_alloc.adoc | 52 -------------------------------------------------
 1 file changed, 52 deletions(-)
 delete mode 100644 docs/man/nng_alloc.adoc

(limited to 'docs/man/nng_alloc.adoc')

diff --git a/docs/man/nng_alloc.adoc b/docs/man/nng_alloc.adoc
deleted file mode 100644
index af81aff9..00000000
--- a/docs/man/nng_alloc.adoc
+++ /dev/null
@@ -1,52 +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 <<nng_send#,nng_send(3)>> using
-the flag `NNG_FLAG_ALLOC`.  Alternatively, it can be freed when no
-longer needed using <<nng_free#,nng_free(3)>>.
-
-WARNING: 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 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-`NNG_ENOMEM`:: Insufficient free memory exists.
-
-== SEE ALSO
-
-<<nng_free#,nng_free(3)>>,
-<<nng_send#,nng_send(3)>>,
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2