summaryrefslogtreecommitdiffstats
path: root/extras/libmemif/examples
diff options
context:
space:
mode:
authorPaul Vinciguerra <pvinci@vinciconsulting.com>2020-05-15 23:13:36 -0400
committerMatthew Smith <mgsmith@netgate.com>2020-05-18 18:21:53 +0000
commitf4fbfd692fbc04a67e61d83ef477200967a6bc34 (patch)
tree06a0ee32dbcdc109384a1fa5eb4ce934e2381b5b /extras/libmemif/examples
parent59a78e966c7813e1bd86310bc0edd8e60a506ccf (diff)
libmemif: cleanup typos
cleaned up typos in documetation while doing a read through. Type: style Change-Id: Id8abbd8d6297ee10490c12a8e62097224f7ec1e1 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
Diffstat (limited to 'extras/libmemif/examples')
-rw-r--r--extras/libmemif/examples/example_setup_doc.md2
-rw-r--r--extras/libmemif/examples/examples_doc.md2
2 files changed, 2 insertions, 2 deletions
diff --git a/extras/libmemif/examples/example_setup_doc.md b/extras/libmemif/examples/example_setup_doc.md
index 7fc5443b5fd..89df8ab1d44 100644
--- a/extras/libmemif/examples/example_setup_doc.md
+++ b/extras/libmemif/examples/example_setup_doc.md
@@ -18,7 +18,7 @@ icmpr-epoll:
```
conn 0 0
```
-Memif in slave mode will try to connect every 2 seconds. If connection establishment is successfull, a message will show.
+Memif in slave mode will try to connect every 2 seconds. If connection establishment is successful, a message will show.
```
INFO: memif connected!
```
diff --git a/extras/libmemif/examples/examples_doc.md b/extras/libmemif/examples/examples_doc.md
index 11937c576fb..4422d42d44b 100644
--- a/extras/libmemif/examples/examples_doc.md
+++ b/extras/libmemif/examples/examples_doc.md
@@ -13,6 +13,6 @@ Current WORKDIR is set to root repository directory. Example apps can be run fro
Example app | Description
------------|------------
-@ref extras/libmemif/examples/icmp_responder | Simplest implementaion. Event polling is handled by libmemif. Single memif conenction in slave mode is created (id 0). Use Ctrl + C to exit app. Memif receive mode: interrupt.
+@ref extras/libmemif/examples/icmp_responder | Simplest implementation. Event polling is handled by libmemif. Single memif connection in slave mode is created (id 0). Use Ctrl + C to exit app. Memif receive mode: interrupt.
@ref extras/libmemif/examples/icmp_responder-epoll (run in container by default) | Supports multiple connections and master mode. User can create/delete connections, set ip addresses, print connection information. @ref libmemif_example_setup_doc contains instructions on basic connection use cases setups. Memif receive mode: interrupt. App provides functionality to disable interrupts for specified queue/s for testing purposes. Polling mode is not implemented in this example.
@ref extras/libmemif/examples/icmp_responder-mt) | Multi-thread example, very similar to icmpr-epoll. Packets are handled in threads assigned to specific queues. Slave mode only. Memif receive mode: polling (memif_rx_poll function), interrupt (memif_rx_interrupt function). Receive modes differ per queue.