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_pull.adoc | 63 --------------------------------------------------
 1 file changed, 63 deletions(-)
 delete mode 100644 docs/man/nng_pull.adoc

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

diff --git a/docs/man/nng_pull.adoc b/docs/man/nng_pull.adoc
deleted file mode 100644
index f56afb5e..00000000
--- a/docs/man/nng_pull.adoc
+++ /dev/null
@@ -1,63 +0,0 @@
-= nng_pull(7)
-//
-// 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_pull - pull protocol
-
-== SYNOPSIS
-
-[source,c]
-----------
-#include <nng/protocol/pipeline0/pull.h>
-
-int nng_pull0_open(nng_socket *s);
-----------
-
-== DESCRIPTION
-
-The _nng_pull_ protocol is one half of a pipeline pattern. The other half
-is the <<nng_push#,nng_push(7)>> protocol.
-
-In the pipeline pattern, pushers distribute messages to pullers. 
-Each message sent
-by a pusher will be sent to one of its peer pullers,
-chosen in a round-robin fashion
-from the set of connected peers available for receiving.
-This property makes this pattern useful in load-balancing scenarios.
-
-=== Socket Operations
-
-The `nng_pull0_open()` call creates a puller socket.  This socket
-may be used to receive messages, but is unable to send them.  Attempts
-to send messages will result in `NNG_ENOTSUP`.
-
-When receiving messages, the _nng_pull_ protocol accepts messages as
-they arrive from peers.  If two peers both have a message ready, the
-order in which messages are handled is undefined.
-
-=== Protocol Versions
-
-Only version 0 of this protocol is supported.  (At the time of writing,
-no other versions of this protocol have been defined.)
-
-=== Protocol Options
-
-The _nng_pull_ protocol has no protocol-specific options.
-
-=== Protocol Headers
-
-The _nng_pull_ protocol has no protocol-specific headers.
-    
-== SEE ALSO
-
-<<nng#,nng(7)>>,
-<<nng_push#,nng_push(7)>>
-- 
cgit v1.2.3-70-g09d2

