aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_stat.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
committerGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
commitdcb962389c5f71bc25cdb84f3363eed95bad9bdd (patch)
tree2a94b72596df4ff76081eb74632af0ce273517b1 /docs/man/nng_stat.5.adoc
parent7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (diff)
downloadnng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.gz
nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.bz2
nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.zip
fixes #861 Man pages need to use .adoc suffix
Diffstat (limited to 'docs/man/nng_stat.5.adoc')
-rw-r--r--docs/man/nng_stat.5.adoc48
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/man/nng_stat.5.adoc b/docs/man/nng_stat.5.adoc
index 54b54883..4382e4b0 100644
--- a/docs/man/nng_stat.5.adoc
+++ b/docs/man/nng_stat.5.adoc
@@ -25,31 +25,31 @@ typedef struct nng_stat nng_stat;
== DESCRIPTION
An `nng_stat`(((statistic))) represents a statistic.
-All statistics have names (`<<nng_stat_name.3#,nng_stat_name()>>`) and
-descriptions (`<<nng_stat_desc.3#,nng_stat_desc()>>`), and are
-typed (`<<nng_stat_type.3#,nng_stat_type()>>`).
+All statistics have names (xref:nng_stat_name.3.adoc[`nng_stat_name()`]) and
+descriptions (xref:nng_stat_desc.3.adoc[`nng_stat_desc()`]), and are
+typed (xref:nng_stat_type.3.adoc[`nng_stat_type()`]).
Most statistics are numeric,
-and thus carry a value (`<<nng_stat_value.3#,nng_stat_value()>>`)
-and frequently also a unit that the value measures (`<<nng_stat_unit.3#,nng_stat_unit()>>`).
+and thus carry a value (xref:nng_stat_value.3.adoc[`nng_stat_value()`])
+and frequently also a unit that the value measures (xref:nng_stat_unit.3.adoc[`nng_stat_unit()`]).
-Some statistics however, are simply strings (`<<nng_stat_string.3#,nng_stat_string()>>`),
+Some statistics however, are simply strings (xref:nng_stat_string.3.adoc[`nng_stat_string()`]),
and thus carry no numeric value.
Statistics are organized as a tree, and any given statistic can have siblings
-(`<<nng_stat_next.3#,nng_stat_next()>>`).
+(xref:nng_stat_next.3.adoc[`nng_stat_next()`]).
Note however that generally only `NNG_STAT_SCOPE` statistics, which are
act as placeholders in the tree (and carry no value),
-will have children (`<<nng_stat_child.3#,nng_stat_child()>>`).
+will have children (xref:nng_stat_child.3.adoc[`nng_stat_child()`]).
-A tree of statistics is collected using `<<nng_stats_get.3#,nng_stats_get()>>`,
-and can be freed when no longer needed with `<<nng_stats_free.3#,nng_stats_free()>>`.
+A tree of statistics is collected using xref:nng_stats_get.3.adoc[`nng_stats_get()`],
+and can be freed when no longer needed with xref:nng_stats_free.3.adoc[`nng_stats_free()`].
This collection process is generally performed in a way to minimize impact
to running operations, but there is still some impact caused by collection
of statistics.
The time when a statistic`'s value is captured can be obtained using
-`<<nng_stat_timestamp.3#,nng_stat_timestamp()>>`, which is useful for
+xref:nng_stat_timestamp.3.adoc[`nng_stat_timestamp()`], which is useful for
measuring rates of change in certain statistics.
NOTE: The presence, names, and meanings of any given statistic are
@@ -63,16 +63,16 @@ in order to reduce program size and run-time overheads.
== SEE ALSO
[.text-left]
-<<libnng.3#,libnng(3)>>,
-<<nng_stats_free.3#,nng_stats_free(3)>>,
-<<nng_stats_get.3#,nng_stats_get(3)>>,
-<<nng_stat_child.3#,nng_stat_child(3)>>,
-<<nng_stat_desc.3#,nng_stat_desc(3)>>,
-<<nng_stat_name.3#,nng_stat_name(3)>>,
-<<nng_stat_next.3#,nng_stat_next(3)>>,
-<<nng_stat_string.3#,nng_stat_string(3)>>,
-<<nng_stat_timestamp.3#,nng_stat_timestamp(3)>>,
-<<nng_stat_type.3#,nng_stat_type(3)>>,
-<<nng_stat_unit.3#,nng_stat_unit(3)>>,
-<<nng_stat_value.3#,nng_stat_value(3)>>,
-<<nng.7#,nng(7)>>
+xref:libnng.3.adoc[libnng(3)],
+xref:nng_stats_free.3.adoc[nng_stats_free(3)],
+xref:nng_stats_get.3.adoc[nng_stats_get(3)],
+xref:nng_stat_child.3.adoc[nng_stat_child(3)],
+xref:nng_stat_desc.3.adoc[nng_stat_desc(3)],
+xref:nng_stat_name.3.adoc[nng_stat_name(3)],
+xref:nng_stat_next.3.adoc[nng_stat_next(3)],
+xref:nng_stat_string.3.adoc[nng_stat_string(3)],
+xref:nng_stat_timestamp.3.adoc[nng_stat_timestamp(3)],
+xref:nng_stat_type.3.adoc[nng_stat_type(3)],
+xref:nng_stat_unit.3.adoc[nng_stat_unit(3)],
+xref:nng_stat_value.3.adoc[nng_stat_value(3)],
+xref:nng.7.adoc[nng(7)]