From d759d4726ba8ac0fe8f8711a4015de717eb8a4a2 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 17 Mar 2018 17:28:52 -0700 Subject: fixes #294 rename nng_zerotier_xxx to nng_zt_xxx --- docs/man/libnng.3.adoc | 2 +- docs/man/nng_zerotier.7.adoc | 4 +++- docs/man/nng_zerotier_register.3.adoc | 42 ----------------------------------- docs/man/nng_zt_register.3.adoc | 42 +++++++++++++++++++++++++++++++++++ 4 files changed, 46 insertions(+), 44 deletions(-) delete mode 100644 docs/man/nng_zerotier_register.3.adoc create mode 100644 docs/man/nng_zt_register.3.adoc diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index ba68b17c..66b00698 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -190,7 +190,7 @@ The following functions are used to register a transport for use. | <>|register TLS transport | <>|register WebSocket transport | <>|register WebSocket Secure transport -| <>|register ZeroTier transport +| <>|register ZeroTier transport |=== === URL Object diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index 04a68409..2e62edc9 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -58,7 +58,9 @@ concepts and administration. === Registration Depending upon how the library was built, it may be necessary to -register the transport by calling `nng_zt_register()`. This function +register the transport by calling +<>. +This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason. diff --git a/docs/man/nng_zerotier_register.3.adoc b/docs/man/nng_zerotier_register.3.adoc deleted file mode 100644 index 4998fe32..00000000 --- a/docs/man/nng_zerotier_register.3.adoc +++ /dev/null @@ -1,42 +0,0 @@ -= nng_zerotier_register(3) -// -// Copyright 2018 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 - -nng_zerotier_register - register ZeroTier transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_zerotier_register(void); ----- - -== DESCRIPTION - -The `nng_zerotier_register()` function registers the -((_zt_ transport))(((transport, _zt_))) for use. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -<>, -<> diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc new file mode 100644 index 00000000..181429a6 --- /dev/null +++ b/docs/man/nng_zt_register.3.adoc @@ -0,0 +1,42 @@ += nng_zt_register(3) +// +// Copyright 2018 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 + +nng_zt_register - register ZeroTier transport + +== SYNOPSIS + +[source,c] +---- +#include + +int nng_zt_register(void); +---- + +== DESCRIPTION + +The `nng_zt_register()` function registers the +((_zt_ transport))(((transport, _zt_))) for use. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +<>, +<> -- cgit v1.2.3-70-g09d2