aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnton C. Wagensonner <anton.wagensonner@gmx.at>2019-08-12 21:42:54 +0200
committerGarrett D'Amore <garrett@damore.org>2019-09-26 04:40:59 -0700
commit32d17517b87713e4d584555c35ac48d010243910 (patch)
treebe93ff8120874f986de8321ba243b0f18179beaf /docs
parente618abf8f3db2a94269a79c8901a51148d48fcc2 (diff)
downloadnng-32d17517b87713e4d584555c35ac48d010243910.tar.gz
nng-32d17517b87713e4d584555c35ac48d010243910.tar.bz2
nng-32d17517b87713e4d584555c35ac48d010243910.zip
fixes some typos in documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/CONTRIBUTING.adoc6
-rw-r--r--docs/man/nng_ctx.5.adoc2
-rw-r--r--docs/man/nng_dialer.5.adoc2
-rw-r--r--docs/man/nng_listener.5.adoc2
-rw-r--r--docs/man/nng_pipe.5.adoc2
-rw-r--r--docs/man/nng_send.3.adoc2
-rw-r--r--docs/man/nng_socket.5.adoc2
7 files changed, 9 insertions, 9 deletions
diff --git a/docs/CONTRIBUTING.adoc b/docs/CONTRIBUTING.adoc
index a30bb8cc..a9b82d06 100644
--- a/docs/CONTRIBUTING.adoc
+++ b/docs/CONTRIBUTING.adoc
@@ -16,7 +16,7 @@ defect, or sending us a message, you agree and certify that:
repository.) This grant shall include a right to use for any
patents covering content in the submission.
- ** You are not aware of any legal encumberances to the use of the
+ ** You are not aware of any legal encumbrances to the use of the
submission (such as patents held by others) unless explicitly
stated otherwise.
@@ -41,7 +41,7 @@ when filing issues:
* Include CMake configuration used to build NNG.
-* Inclue expected results or behavior, and observed results or behavior.
+* Include expected results or behavior, and observed results or behavior.
* If at all possible, a reproducible test case is helpful. We prefer test
cases as the minimal amount of C code to demonstrate the defect.
@@ -93,7 +93,7 @@ of `clang-format` as older versions can differ in their output.
PR with partial work in progress, unless you have reached a
milestone that can stand on its own merit.)
- ** Each commit in a PR should also be "complete", so that the
+ ** Each commit in a PR should also be "complete", so that
a release could be cut in between your commits without
leaving the tree in a broken or dysfunctional state.
diff --git a/docs/man/nng_ctx.5.adoc b/docs/man/nng_ctx.5.adoc
index b1285c2c..86b89a33 100644
--- a/docs/man/nng_ctx.5.adoc
+++ b/docs/man/nng_ctx.5.adoc
@@ -40,7 +40,7 @@ to a completely different request.
IMPORTANT: The `nng_ctx` structure is always passed by value (both
for input parameters and return values), and should be treated opaquely.
-Passing structures this way ensures gives the compiler a chance to perform
+Passing structures this way gives the compiler a chance to perform
accurate type checks in functions passing values of this type.
All contexts share the same socket, and so some options, as well as the
diff --git a/docs/man/nng_dialer.5.adoc b/docs/man/nng_dialer.5.adoc
index a2757e38..b484e185 100644
--- a/docs/man/nng_dialer.5.adoc
+++ b/docs/man/nng_dialer.5.adoc
@@ -40,7 +40,7 @@ by a single xref:nng_socket.5.adoc[`nng_socket`].
IMPORTANT: The `nng_dialer` structure is always passed by value (both
for input parameters and return values), and should be treated opaquely.
-Passing structures this way ensures gives the compiler a chance to perform
+Passing structures this way gives the compiler a chance to perform
accurate type checks in functions passing values of this type.
TIP: A given xref:nng_socket.5.adoc[`nng_socket`] may have multiple dialer
diff --git a/docs/man/nng_listener.5.adoc b/docs/man/nng_listener.5.adoc
index d481b2ce..70dd86c0 100644
--- a/docs/man/nng_listener.5.adoc
+++ b/docs/man/nng_listener.5.adoc
@@ -37,7 +37,7 @@ by a single xref:nng_socket.5.adoc[`nng_socket`].
IMPORTANT: The `nng_listener` structure is always passed by value (both
for input parameters and return values), and should be treated opaquely.
-Passing structures this way ensures gives the compiler a chance to perform
+Passing structures this way gives the compiler a chance to perform
accurate type checks in functions passing values of this type.
TIP: A given xref:nng_socket.5.adoc[`nng_socket`] may have multiple listener
diff --git a/docs/man/nng_pipe.5.adoc b/docs/man/nng_pipe.5.adoc
index 8f9442c6..c951ecb2 100644
--- a/docs/man/nng_pipe.5.adoc
+++ b/docs/man/nng_pipe.5.adoc
@@ -34,7 +34,7 @@ and therefore are also automatically associated with a single socket.
IMPORTANT: The `nng_pipe` structure is always passed by value (both
for input parameters and return values), and should be treated opaquely.
-Passing structures this way ensures gives the compiler a chance to perform
+Passing structures this way gives the compiler a chance to perform
accurate type checks in functions passing values of this type.
TIP: Most applications should never concern themselves with individual pipes.
diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc
index 389ba079..7037f547 100644
--- a/docs/man/nng_send.3.adoc
+++ b/docs/man/nng_send.3.adoc
@@ -29,7 +29,7 @@ length _size_ using the xref:nng_socket.5.adoc[socket] _s_.
NOTE: The semantics of what sending a message means vary from protocol to
protocol, so examination of the protocol documentation is encouraged.
-(For example, with an xref:nng_pub.7.adoc[_nng_] socket the data is broadcast, so that
+(For example, with an xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that
any peers who have a suitable subscription will be able to receive it using
xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.)
Furthermore, some protocols may not support sending data (such as
diff --git a/docs/man/nng_socket.5.adoc b/docs/man/nng_socket.5.adoc
index b101969a..ab17f8f2 100644
--- a/docs/man/nng_socket.5.adoc
+++ b/docs/man/nng_socket.5.adoc
@@ -36,7 +36,7 @@ and is responsible for any state machines or other protocol-specific logic.
IMPORTANT: The `nng_socket` structure is always passed by value (both
for input parameters and return values), and should be treated opaquely.
-Passing structures this way ensures gives the compiler a chance to perform
+Passing structures this way gives the compiler a chance to perform
accurate type checks in functions passing values of this type.
Each `nng_socket` is created by a protocol-specific constructor, such as