From 6a630e375056c3fa65a8b39f01de7661a68ae411 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 23 Jan 2020 21:20:24 -0800 Subject: fix sections for stat man pages --- docs/man/nng_setopt.3.adoc | 3 +- docs/man/nng_stat.5.adoc | 5 ++- docs/man/nng_stat_find.3.adoc | 51 +++++++++++++++++++++++++++++++ docs/man/nng_stat_find.adoc | 52 ------------------------------- docs/man/nng_stat_find_dialer.3.adoc | 55 +++++++++++++++++++++++++++++++++ docs/man/nng_stat_find_dialer.adoc | 56 ---------------------------------- docs/man/nng_stat_find_listener.3.adoc | 55 +++++++++++++++++++++++++++++++++ docs/man/nng_stat_find_listener.adoc | 56 ---------------------------------- docs/man/nng_stat_find_socket.3.adoc | 55 +++++++++++++++++++++++++++++++++ docs/man/nng_stat_find_socket.adoc | 56 ---------------------------------- docs/man/nng_stat_name.3.adoc | 3 +- 11 files changed, 220 insertions(+), 227 deletions(-) create mode 100644 docs/man/nng_stat_find.3.adoc delete mode 100644 docs/man/nng_stat_find.adoc create mode 100644 docs/man/nng_stat_find_dialer.3.adoc delete mode 100644 docs/man/nng_stat_find_dialer.adoc create mode 100644 docs/man/nng_stat_find_listener.3.adoc delete mode 100644 docs/man/nng_stat_find_listener.adoc create mode 100644 docs/man/nng_stat_find_socket.3.adoc delete mode 100644 docs/man/nng_stat_find_socket.adoc (limited to 'docs') diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc index cdb540c7..8a526399 100644 --- a/docs/man/nng_setopt.3.adoc +++ b/docs/man/nng_setopt.3.adoc @@ -1,5 +1,5 @@ = nng_setopt(3) -// + // Copyright 2019 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // @@ -7,7 +7,6 @@ // 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 diff --git a/docs/man/nng_stat.5.adoc b/docs/man/nng_stat.5.adoc index 0b649308..e0ada32d 100644 --- a/docs/man/nng_stat.5.adoc +++ b/docs/man/nng_stat.5.adoc @@ -1,13 +1,12 @@ = nng_stat(5) -// -// Copyright 2018 Staysail Systems, Inc. + +// Copyright 2019 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // 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 diff --git a/docs/man/nng_stat_find.3.adoc b/docs/man/nng_stat_find.3.adoc new file mode 100644 index 00000000..cdcf461f --- /dev/null +++ b/docs/man/nng_stat_find.3.adoc @@ -0,0 +1,51 @@ += nng_stat_find(3) + +// Copyright 2019 Staysail Systems, Inc. +// +// 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_stat_find - find statistic by name + +== SYNOPSIS + +[source,c] +---- +#include + +typedef struct nng_stat nng_stat; + +nng_stat *nng_stat_find(nng_stat *stat, const char *name); +---- + +== DESCRIPTION + +The `nng_stat_find()` function searches the statistics tree _stat_, looking for a statistic whose name is _name_. +If it finds one, it returns it. +Otherwise `NULL` is returned. + +NOTE: If multiple statistics have that name, then only the first match is returned. + +== RETURN VALUES + +The matching statistic, or NULL if no match is found. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)], +xref:nng_stat_find_listener.3.adoc[nng_stat_find_listner(3)], +xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find.adoc b/docs/man/nng_stat_find.adoc deleted file mode 100644 index 4f4103ea..00000000 --- a/docs/man/nng_stat_find.adoc +++ /dev/null @@ -1,52 +0,0 @@ -= nng_stat_find(3) -// -// Copyright 2019 Staysail Systems, Inc. -// -// 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_stat_find - find statistic by name - -== SYNOPSIS - -[source,c] ----- -#include - -typedef struct nng_stat nng_stat; - -nng_stat *nng_stat_find(nng_stat *stat, const char *name); ----- - -== DESCRIPTION - -The `nng_stat_find()` function searches the statistics tree _stat_, looking for a statistic whose name is _name_. -If it finds one, it returns it. -Otherwise `NULL` is returned. - -NOTE: If multiple statistics have that name, then only the first match is returned. - -== RETURN VALUES - -The matching statistic, or NULL if no match is found. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stat_child.3.adoc[nng_stat_child(3)], -xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)], -xref:nng_stat_find_listener.3.adoc[nng_stat_find_listner(3)], -xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(3)], -xref:nng_stats_get.3.adoc[nng_stats_get(3)], -xref:nng_stat.5.adoc[nng_stat(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find_dialer.3.adoc b/docs/man/nng_stat_find_dialer.3.adoc new file mode 100644 index 00000000..202fd289 --- /dev/null +++ b/docs/man/nng_stat_find_dialer.3.adoc @@ -0,0 +1,55 @@ += nng_stat_find_dialer(3) + +// Copyright 2020 Staysail Systems, Inc. +// +// 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_stat_find_dialer - find dialer statistics + +== SYNOPSIS + +[source,c] +---- +#include + +typedef struct nng_stat nng_stat; +typedef struct nng_dialer nng_dialer; + +nng_stat *nng_stat_find_dialer(nng_stat *stat, nng_dialer dialer); +---- + +== DESCRIPTION + +The `nng_stat_find_dialer()` function returns the statistics tree within _stat_ associated with the dialer _dialer_, if such a tree exists. +Otherwise `NULL` is returned. + +Generally, there will be child statistics of the returned value, each corresponding to a specific metric. +These can be further scanned using either +xref:nng_stat_find.3.adoc[nng_stat_find(3)] +or by walking the tree with +xref:nng_stat_child.3.adoc[nng_stat_child(3)]. + +== RETURN VALUES + +The matching statistic, or NULL if no match is found. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stat_find.3.adoc[nng_stat_find(3)], +xref:nng_stat_find_listener.3.adoc[nng_stat_find_listener(3)], +xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find_dialer.adoc b/docs/man/nng_stat_find_dialer.adoc deleted file mode 100644 index b0df247a..00000000 --- a/docs/man/nng_stat_find_dialer.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_stat_find_socket(3) -// -// Copyright 2019 Staysail Systems, Inc. -// -// 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_stat_find_dialer - find dialer statistics - -== SYNOPSIS - -[source,c] ----- -#include - -typedef struct nng_stat nng_stat; -typedef struct nng_dialer nng_dialer; - -nng_stat *nng_stat_find_dialer(nng_stat *stat, nng_dialer dialer); ----- - -== DESCRIPTION - -The `nng_stat_find_dialer()` function returns the statistics tree within _stat_ associated with the dialer _dialer_, if such a tree exists. -Otherwise `NULL` is returned. - -Generally, there will be child statistics of the returned value, each corresponding to a specific metric. -These can be further scanned using either -xref:nng_stat_find.3.adoc[nng_stat_find(3)] -or by walking the tree with -xref:nng_stat_child.3.adoc[nng_stat_child(3)]. - -== RETURN VALUES - -The matching statistic, or NULL if no match is found. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stat_child.3.adoc[nng_stat_child(3)], -xref:nng_stat_find.3.adoc[nng_stat_find(3)], -xref:nng_stat_find_listener.3.adoc[nng_stat_find_listener(3)], -xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(3)], -xref:nng_stats_get.3.adoc[nng_stats_get(3)], -xref:nng_stat.5.adoc[nng_stat(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find_listener.3.adoc b/docs/man/nng_stat_find_listener.3.adoc new file mode 100644 index 00000000..46c2dc74 --- /dev/null +++ b/docs/man/nng_stat_find_listener.3.adoc @@ -0,0 +1,55 @@ += nng_stat_find_listener(3) + +// Copyright 2019 Staysail Systems, Inc. +// +// 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_stat_find_listener - find listener statistics + +== SYNOPSIS + +[source,c] +---- +#include + +typedef struct nng_stat nng_stat; +typedef struct nng_listener nng_listener; + +nng_stat *nng_stat_find_listener(nng_stat *stat, nng_listener listener); +---- + +== DESCRIPTION + +The `nng_stat_find_listener()` function returns the statistics tree within _stat_ associated with the listener _listener_, if such a tree exists. +Otherwise `NULL` is returned. + +Generally, there will be child statistics of the returned value, each corresponding to a specific metric. +These can be further scanned using either +xref:nng_stat_find.3.adoc[nng_stat_find(3)] +or by walking the tree with +xref:nng_stat_child.3.adoc[nng_stat_child(3)]. + +== RETURN VALUES + +The matching statistic, or NULL if no match is found. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stat_find.3.adoc[nng_stat_find(3)], +xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)], +xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find_listener.adoc b/docs/man/nng_stat_find_listener.adoc deleted file mode 100644 index 2a099b1b..00000000 --- a/docs/man/nng_stat_find_listener.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_stat_find_listener(3) -// -// Copyright 2019 Staysail Systems, Inc. -// -// 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_stat_find_listener - find listener statistics - -== SYNOPSIS - -[source,c] ----- -#include - -typedef struct nng_stat nng_stat; -typedef struct nng_listener nng_listener; - -nng_stat *nng_stat_find_listener(nng_stat *stat, nng_listener listener); ----- - -== DESCRIPTION - -The `nng_stat_find_listener()` function returns the statistics tree within _stat_ associated with the listener _listener_, if such a tree exists. -Otherwise `NULL` is returned. - -Generally, there will be child statistics of the returned value, each corresponding to a specific metric. -These can be further scanned using either -xref:nng_stat_find.3.adoc[nng_stat_find(3)] -or by walking the tree with -xref:nng_stat_child.3.adoc[nng_stat_child(3)]. - -== RETURN VALUES - -The matching statistic, or NULL if no match is found. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stat_child.3.adoc[nng_stat_child(3)], -xref:nng_stat_find.3.adoc[nng_stat_find(3)], -xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)], -xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket(3)], -xref:nng_stats_get.3.adoc[nng_stats_get(3)], -xref:nng_stat.5.adoc[nng_stat(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find_socket.3.adoc b/docs/man/nng_stat_find_socket.3.adoc new file mode 100644 index 00000000..deea509c --- /dev/null +++ b/docs/man/nng_stat_find_socket.3.adoc @@ -0,0 +1,55 @@ += nng_stat_find_socket(3) + +// Copyright 2019 Staysail Systems, Inc. +// +// 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_stat_find_socket - find socket statistics + +== SYNOPSIS + +[source,c] +---- +#include + +typedef struct nng_stat nng_stat; +typedef struct nng_socket nng_socket; + +nng_stat *nng_stat_find_socket(nng_stat *stat, nng_socket socket); +---- + +== DESCRIPTION + +The `nng_stat_find_socket()` function returns the statistics tree within _stat_ associated with the socket _socket_, if such a tree exists. +Otherwise `NULL` is returned. + +Generally, there will be child statistics of the returned value, each corresponding to a specific metric. +These can be further scanned using either +xref:nng_stat_find.3.adoc[nng_stat_find(3)] +or by walking the tree with +xref:nng_stat_child.3.adoc[nng_stat_child(3)]. + +== RETURN VALUES + +The matching statistic, or NULL if no match is found. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stat_find.3.adoc[nng_stat_find(3)], +xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)], +xref:nng_stat_find_listener.3.adoc[nng_stat_find_listener(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_find_socket.adoc b/docs/man/nng_stat_find_socket.adoc deleted file mode 100644 index eb03d5ea..00000000 --- a/docs/man/nng_stat_find_socket.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_stat_find_socket(3) -// -// Copyright 2019 Staysail Systems, Inc. -// -// 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_stat_find_socket - find socket statistics - -== SYNOPSIS - -[source,c] ----- -#include - -typedef struct nng_stat nng_stat; -typedef struct nng_socket nng_socket; - -nng_stat *nng_stat_find_socket(nng_stat *stat, nng_socket socket); ----- - -== DESCRIPTION - -The `nng_stat_find_socket()` function returns the statistics tree within _stat_ associated with the socket _socket_, if such a tree exists. -Otherwise `NULL` is returned. - -Generally, there will be child statistics of the returned value, each corresponding to a specific metric. -These can be further scanned using either -xref:nng_stat_find.3.adoc[nng_stat_find(3)] -or by walking the tree with -xref:nng_stat_child.3.adoc[nng_stat_child(3)]. - -== RETURN VALUES - -The matching statistic, or NULL if no match is found. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stat_child.3.adoc[nng_stat_child(3)], -xref:nng_stat_find.3.adoc[nng_stat_find(3)], -xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer(3)], -xref:nng_stat_find_listener.3.adoc[nng_stat_find_listener(3)], -xref:nng_stats_get.3.adoc[nng_stats_get(3)], -xref:nng_stat.5.adoc[nng_stat(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_name.3.adoc b/docs/man/nng_stat_name.3.adoc index 87fac572..c7a3f1bf 100644 --- a/docs/man/nng_stat_name.3.adoc +++ b/docs/man/nng_stat_name.3.adoc @@ -1,5 +1,5 @@ = nng_stat_name(3) -// + // Copyright 2018 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // @@ -7,7 +7,6 @@ // 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 -- cgit v1.2.3-70-g09d2