From d759d4726ba8ac0fe8f8711a4015de717eb8a4a2 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 17 Mar 2018 17:28:52 -0700 Subject: [PATCH] fixes #294 rename nng_zerotier_xxx to nng_zt_xxx --- docs/man/libnng.3.adoc | 2 +- docs/man/nng_zerotier.7.adoc | 4 +++- ...ng_zerotier_register.3.adoc => nng_zt_register.3.adoc} | 8 ++++---- 3 files changed, 8 insertions(+), 6 deletions(-) rename docs/man/{nng_zerotier_register.3.adoc => nng_zt_register.3.adoc} (82%) diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index ba68b17cb..66b006984 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 04a684091..2e62edc9d 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_zt_register.3.adoc similarity index 82% rename from docs/man/nng_zerotier_register.3.adoc rename to docs/man/nng_zt_register.3.adoc index 4998fe323..181429a65 100644 --- a/docs/man/nng_zerotier_register.3.adoc +++ b/docs/man/nng_zt_register.3.adoc @@ -1,4 +1,4 @@ -= nng_zerotier_register(3) += nng_zt_register(3) // // Copyright 2018 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV @@ -11,7 +11,7 @@ == NAME -nng_zerotier_register - register ZeroTier transport +nng_zt_register - register ZeroTier transport == SYNOPSIS @@ -19,12 +19,12 @@ nng_zerotier_register - register ZeroTier transport ---- #include -int nng_zerotier_register(void); +int nng_zt_register(void); ---- == DESCRIPTION -The `nng_zerotier_register()` function registers the +The `nng_zt_register()` function registers the ((_zt_ transport))(((transport, _zt_))) for use. == RETURN VALUES