From 1e7b955c9b1caa0262ea3d87d07eabf403927869 Mon Sep 17 00:00:00 2001 From: Jake Woltersdorf Date: Fri, 8 Feb 2019 15:25:23 +0800 Subject: fixes #867 Remove references to NNG_OPT_LINGER option and other minor typos --- docs/man/nng_close.3.adoc | 3 +-- docs/man/nng_ctx_close.3.adoc | 3 +-- docs/man/nng_dial.3.adoc | 2 +- docs/man/nng_pipe_close.3.adoc | 3 +-- docs/man/nng_pipe_getopt.3.adoc | 2 +- docs/man/nng_recv.3.adoc | 2 +- docs/man/nng_strfree.3.adoc | 2 +- 7 files changed, 7 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc index dcad5cd4..4456f1c0 100644 --- a/docs/man/nng_close.3.adoc +++ b/docs/man/nng_close.3.adoc @@ -26,8 +26,7 @@ int nng_close(nng_socket s); The `nng_close()` function closes the supplied socket, _s_. Messages that have been submitted for sending may be flushed or delivered, -depending upon the transport and the setting of the -`<>` option. +depending upon the transport. Further attempts to use the socket after this call returns will result in `NNG_ECLOSED`. diff --git a/docs/man/nng_ctx_close.3.adoc b/docs/man/nng_ctx_close.3.adoc index 2ac3b946..639515ba 100644 --- a/docs/man/nng_ctx_close.3.adoc +++ b/docs/man/nng_ctx_close.3.adoc @@ -26,8 +26,7 @@ int nng_ctx_close(nng_ctx ctx); The `nng_ctx_close()` function closes the context _ctx_. Messages that have been submitted for sending may be flushed or delivered, -depending upon the transport and the setting of the -`<>` option. +depending upon the transport. Further attempts to use the context after this call returns will result in `NNG_ECLOSED`. diff --git a/docs/man/nng_dial.3.adoc b/docs/man/nng_dial.3.adoc index 68fe5ac4..1605f08a 100644 --- a/docs/man/nng_dial.3.adoc +++ b/docs/man/nng_dial.3.adoc @@ -26,7 +26,7 @@ int nng_dial(nng_socket s, const char *url, nng_dialer *dp, int flags); The `nng_dial()` function creates a newly initialized `<>` object, -associated with socket _s_, and configured to listen at the +associated with socket _s_, and configured to dial the address specified by _url_, and starts it. If the value of _dp_ is not `NULL`, then the newly created dialer is stored at the address indicated by _dp_. diff --git a/docs/man/nng_pipe_close.3.adoc b/docs/man/nng_pipe_close.3.adoc index ea11c1d6..7dd12e7e 100644 --- a/docs/man/nng_pipe_close.3.adoc +++ b/docs/man/nng_pipe_close.3.adoc @@ -26,8 +26,7 @@ int nng_pipe_close(nng_pipe p); The `nng_pipe_close()` function closes the supplied pipe, _p_. Messages that have been submitted for sending may be flushed or delivered, -depending upon the transport and the setting of the -`<>` option. +depending upon the transport. Further attempts to use the pipe after this call returns will result in `NNG_ECLOSED`. diff --git a/docs/man/nng_pipe_getopt.3.adoc b/docs/man/nng_pipe_getopt.3.adoc index 9bc7529e..b5c9fcf8 100644 --- a/docs/man/nng_pipe_getopt.3.adoc +++ b/docs/man/nng_pipe_getopt.3.adoc @@ -21,7 +21,7 @@ nng_pipe_getopt - get pipe option int nng_pipe_getopt(nng_pipe p, const char *opt, void *val, size_t *valszp); -int nng_pipe_getopt_bool(nng_pipe p, const char *opt, int *bvalp); +int nng_pipe_getopt_bool(nng_pipe p, const char *opt, bool *bvalp); int nng_pipe_getopt_int(nng_pipe p, const char *opt, int *ivalp); diff --git a/docs/man/nng_recv.3.adoc b/docs/man/nng_recv.3.adoc index c86e9cdf..a0776ed8 100644 --- a/docs/man/nng_recv.3.adoc +++ b/docs/man/nng_recv.3.adoc @@ -19,7 +19,7 @@ nng_recv - recv data ---- #include -int nng_recv(nng_socket s, void *data, size_t *sizep int flags); +int nng_recv(nng_socket s, void *data, size_t *sizep, int flags); ---- == DESCRIPTION diff --git a/docs/man/nng_strfree.3.adoc b/docs/man/nng_strfree.3.adoc index e1d6617e..b923e8e0 100644 --- a/docs/man/nng_strfree.3.adoc +++ b/docs/man/nng_strfree.3.adoc @@ -11,7 +11,7 @@ == NAME -nng_free - free memory +nng_strfree - free memory == SYNOPSIS -- cgit v1.2.3-70-g09d2