summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLawrence Kesteloot <lk@teamten.com>2018-09-15 21:32:19 -0700
committerGarrett D'Amore <garrett@damore.org>2018-09-19 08:20:53 -0700
commit21cfd179ac26e67e05108f345974468691c32972 (patch)
treeb88e33984df16fb7186be2f25d3ce61f0b2826bc /docs
parentcf576e329c8b17604e0bfa1005d502086e4cf8b6 (diff)
downloadnng-21cfd179ac26e67e05108f345974468691c32972.tar.gz
nng-21cfd179ac26e67e05108f345974468691c32972.tar.bz2
nng-21cfd179ac26e67e05108f345974468691c32972.zip
Fix minor typos in the docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_aio_alloc.3.adoc2
-rw-r--r--docs/man/nng_device.3.adoc2
-rw-r--r--docs/man/nng_dial.3.adoc2
-rw-r--r--docs/man/nng_dialer_setopt.3.adoc2
-rw-r--r--docs/man/nng_listener_setopt.3.adoc2
-rw-r--r--docs/man/nng_listener_start.3.adoc4
-rw-r--r--docs/man/nng_options.5.adoc2
-rw-r--r--docs/man/nng_sockaddr.5.adoc2
-rw-r--r--docs/man/nng_stat_type.3.adoc4
-rw-r--r--docs/man/nng_tls_config_cert_key_file.3tls.adoc2
-rw-r--r--docs/man/nng_zerotier.7.adoc4
11 files changed, 14 insertions, 14 deletions
diff --git a/docs/man/nng_aio_alloc.3.adoc b/docs/man/nng_aio_alloc.3.adoc
index 2dc6d4a8..056705c8 100644
--- a/docs/man/nng_aio_alloc.3.adoc
+++ b/docs/man/nng_aio_alloc.3.adoc
@@ -31,7 +31,7 @@ which will be executed when an associated asynchronous operation finishes.
It will be called with the argument _arg_.
NOTE: The callback _callb_ must not perform any blocking operations, and
-must complete it's execution quickly. If _callb_ does block, this can
+must complete its execution quickly. If _callb_ does block, this can
lead ultimately to an apparent "hang" or deadlock in the application.
Asynchronous I/O operations all take an `<<nng_aio.5#,nng_aio>>`
diff --git a/docs/man/nng_device.3.adoc b/docs/man/nng_device.3.adoc
index fed4ef7c..6b56d46f 100644
--- a/docs/man/nng_device.3.adoc
+++ b/docs/man/nng_device.3.adoc
@@ -11,7 +11,7 @@
== NAME
-nng_sendmsg - send message
+nng_device - send message
== SYNOPSIS
diff --git a/docs/man/nng_dial.3.adoc b/docs/man/nng_dial.3.adoc
index 77eda33b..68fe5ac4 100644
--- a/docs/man/nng_dial.3.adoc
+++ b/docs/man/nng_dial.3.adoc
@@ -24,7 +24,7 @@ int nng_dial(nng_socket s, const char *url, nng_dialer *dp, int flags);
== DESCRIPTION
-The `nng_dialer()` function creates a newly initialized
+The `nng_dial()` function creates a newly initialized
`<<nng_dialer.5#,nng_dialer>>` object,
associated with socket _s_, and configured to listen at the
address specified by _url_, and starts it.
diff --git a/docs/man/nng_dialer_setopt.3.adoc b/docs/man/nng_dialer_setopt.3.adoc
index d90ed247..fd62d0ce 100644
--- a/docs/man/nng_dialer_setopt.3.adoc
+++ b/docs/man/nng_dialer_setopt.3.adoc
@@ -49,7 +49,7 @@ Additionally some transport-specific options are documented with the
transports themselves.
NOTE: Once a dialer has started, it is generally not possible to change
-it's configuration.
+its configuration.
=== Forms
diff --git a/docs/man/nng_listener_setopt.3.adoc b/docs/man/nng_listener_setopt.3.adoc
index 00490e06..c6f18ca8 100644
--- a/docs/man/nng_listener_setopt.3.adoc
+++ b/docs/man/nng_listener_setopt.3.adoc
@@ -47,7 +47,7 @@ Additionally some transport-specific options and protocol-specific options
are documented with the transports and protocols themselves.
NOTE: Once a listener has started, it is generally not possible to change
-it's configuration.
+its configuration.
=== Forms
diff --git a/docs/man/nng_listener_start.3.adoc b/docs/man/nng_listener_start.3.adoc
index 94a1e420..852a859a 100644
--- a/docs/man/nng_listener_start.3.adoc
+++ b/docs/man/nng_listener_start.3.adoc
@@ -32,7 +32,7 @@ dialers.
Each new connection results in an `<<nng_pipe.5#,nng_pipe>>` object,
which will be attached to the listener's socket.
-Normally, the act of "`binding`" to it's address is done
+Normally, the act of "`binding`" to its address is done
synchronously, including any necessary name resolution.
As a result,
a failure, such as if the address is already in use, will be returned
@@ -45,7 +45,7 @@ TIP: While `NNG_FLAG_NONBLOCK` can help an application be more resilient,
it also generally makes diagnosing failures somewhat more difficult.
Once a listener has started, it is generally not possible to change
-it's configuration.
+its configuration.
== RETURN VALUES
diff --git a/docs/man/nng_options.5.adoc b/docs/man/nng_options.5.adoc
index 00a5e011..2887719a 100644
--- a/docs/man/nng_options.5.adoc
+++ b/docs/man/nng_options.5.adoc
@@ -267,7 +267,7 @@ When this is supported, it can have a value between 1 and 255, inclusive.
NOTE: Not all protocols support this option.
Those that do generally have a default value of 8.
-TIP: Each node along a forwarding path may have it's own value for the
+TIP: Each node along a forwarding path may have its own value for the
maximum time-to-live, and performs its own checks before forwarding a message.
Therefore it is helpful if all nodes in the topology use the same value for
this option.
diff --git a/docs/man/nng_sockaddr.5.adoc b/docs/man/nng_sockaddr.5.adoc
index fea434bb..e8bae425 100644
--- a/docs/man/nng_sockaddr.5.adoc
+++ b/docs/man/nng_sockaddr.5.adoc
@@ -46,7 +46,7 @@ representing the addresses used by underlying transports, such as TCP/IP
addresses, IPC paths, and so forth.
****
-The name `sockaddr` is based on it's similarity with POSIX `struct sockaddr`,
+The name `sockaddr` is based on its similarity with POSIX `struct sockaddr`,
but in the _nng_ library, these addresses are more closely affiliated with
instances of `<<nng_pipe.5#,nng_pipe>>`
than of `<<nng_socket.5#,nng_socket>>`.
diff --git a/docs/man/nng_stat_type.3.adoc b/docs/man/nng_stat_type.3.adoc
index d1b1586d..d583ee55 100644
--- a/docs/man/nng_stat_type.3.adoc
+++ b/docs/man/nng_stat_type.3.adoc
@@ -40,12 +40,12 @@ The `nng_stat_type()` function returns the type of the statistic _stat_.
The returned type will be one of the following values:
((`NNG_STAT_SCOPE`))::
-This is a placeholder providing scope, and carries no value on it's own.
+This is a placeholder providing scope, and carries no value on its own.
Instead it is a parent node with child statistics (see
`<<nng_stat_child.3#,nng_stat_child()>>`.)
((`NNG_STAT_LEVEL`))::
-This is a numeric statistic, but it's value is a level, so rate calculations
+This is a numeric statistic, but its value is a level, so rate calculations
based on changes in this value should not be considered significant.
((`NNG_STAT_COUNTER`))::
diff --git a/docs/man/nng_tls_config_cert_key_file.3tls.adoc b/docs/man/nng_tls_config_cert_key_file.3tls.adoc
index 70d34d45..802b050e 100644
--- a/docs/man/nng_tls_config_cert_key_file.3tls.adoc
+++ b/docs/man/nng_tls_config_cert_key_file.3tls.adoc
@@ -35,7 +35,7 @@ establishing TLS sessions using _cfg_.
It may contain additional certificates leading to a validation chain,
with the leaf certificate first.
There is no need to include the self-signed root, as the peer
-will need to have that already in order to perform it's own validation.
+will need to have that already in order to perform its own validation.
The private key may be encrypted with a password, in which can be supplied in
_pass_.
diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc
index 1aca83ff..5b7224a6 100644
--- a/docs/man/nng_zerotier.7.adoc
+++ b/docs/man/nng_zerotier.7.adoc
@@ -186,7 +186,7 @@ in this fashion.
The maximum number (`int`) of attempts to try to establish a connection
before reporting a timeout, and is only used with dialers.
The default is 240, which results in a 2 minute timeout if
- `NNG_OPT_ZT_CONN_TIME` is at it's default of 500.
+ `NNG_OPT_ZT_CONN_TIME` is at its default of 500.
If the value is set to 0, then connection attempts will keep retrying forever.
[[NNG_OPT_ZT_PING_TIME]]
@@ -215,7 +215,7 @@ in this fashion.
((`NNG_OPT_ZT_ORBIT`))(((orbit, ZeroTier)))(((federation,ZeroTier))):
This is a write-only option that takes an array of two `uint64_t` values,
indicating the ID of a ZeroTier "`moon`", and the node ID of the root server
- for that moon. (The ID may be zero if the moon ID is the same as it's
+ for that moon. (The ID may be zero if the moon ID is the same as its
root server ID, which is conventional.)
[[NNG_OPT_ZT_DEORBIT]]