aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted
diff options
context:
space:
mode:
authorPaul Vinciguerra <pvinci@vinciconsulting.com>2019-11-05 15:34:36 -0500
committerDave Barach <openvpp@barachs.net>2019-11-06 17:53:42 +0000
commit340c15c6ed34ce60c821b5260fec3eb11d65dcb7 (patch)
treee791acb487279b7273cdbe753a2d46ccd982f5ea /docs/gettingstarted
parent4d11b6cecaa9c1be20aa149bc8779f197f6393ed (diff)
docs: add spellcheck to 'make docs' sphinx docs
The CI gate will fail if there are typos in the docs. writing output... [ 21%] events/Summits/OpensourceSummit... writing output... [ 22%] events/Summits/UKNO/2017_04_30_... featuresbyrelease/vpp16.06.rst:34:Rasberry:vpp16.06 writing output... [100%] usecases/vppinazure Spelling checker messages written to /vpp/docs/_build/html/output.txt Warning, treated as error: Found 1 misspelled words Makefile:31: recipe for target 'html' failed make[1]: *** [html] Error 2 make[1]: Leaving directory '/vpp/docs' If you introduce a term that is not recognized, please add it to custom dictionary at docs/spelling_wordlist.txt. Type: feature Change-Id: Id49be4fbee617f544f1ab8e78e7de8a4df36448b Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
Diffstat (limited to 'docs/gettingstarted')
-rw-r--r--docs/gettingstarted/developers/fib20/routes.rst4
-rw-r--r--docs/gettingstarted/developers/fib20/tunnels.rst2
-rw-r--r--docs/gettingstarted/developers/metadata.md4
-rw-r--r--docs/gettingstarted/developers/vlib.md2
4 files changed, 6 insertions, 6 deletions
diff --git a/docs/gettingstarted/developers/fib20/routes.rst b/docs/gettingstarted/developers/fib20/routes.rst
index 464a24af5d3..1ee09ced448 100644
--- a/docs/gettingstarted/developers/fib20/routes.rst
+++ b/docs/gettingstarted/developers/fib20/routes.rst
@@ -27,7 +27,7 @@ The route data is decomposed into three parts; entry, path-list and paths;
* Attached next-hop: the path is described with an interface and a next-hop. The next-hop is in the same sub-net as the router's own address on that interface, hence the peer is considered to be *attached*
- * Attached: the path is described only by an interface. All address covered by the prefix are on the same L2 segment to which that router's interface is attached. This means it is possible to ARP for any address covered by the prefix Рwhich is usually not the case (hence the proxy ARP debacle in IOS). An attached path is only appropriate for a point-to-point (P2P) interface where ARP is not required, i.e. a GRE tunnel.
+ * Attached: the path is described only by an interface. All address covered by the prefix are on the same L2 segment to which that router's interface is attached. This means it is possible to ARP for any address covered by the prefix which is usually not the case (hence the proxy ARP debacle in IOS). An attached path is only appropriate for a point-to-point (P2P) interface where ARP is not required, i.e. a GRE tunnel.
* Recursive: The path is described only via the next-hop and table-id.
@@ -132,7 +132,7 @@ is attached are installed in forwarding. This requires the use of *cover trackin
where a route maintains a dependency relationship with the route that is its less
specific cover. When this cover changes (i.e. there is a new covering route) or the
forwarding information of the cover is updated, then the covered route is notified.
-Adj-fibs that fail this cover check are not installed in the fib_table_tճ forwarding
+Adj-fibs that fail this cover check are not installed in the fib_table_t's forwarding
table, there are only present in the non-forwarding table.
Overlapping sub-nets are not supported, so no adj-fib has multiple paths. The control
diff --git a/docs/gettingstarted/developers/fib20/tunnels.rst b/docs/gettingstarted/developers/fib20/tunnels.rst
index 1613a69df8c..c33d63c3b92 100644
--- a/docs/gettingstarted/developers/fib20/tunnels.rst
+++ b/docs/gettingstarted/developers/fib20/tunnels.rst
@@ -18,7 +18,7 @@ Figure 11 shows the control plane object graph for a route via a tunnel. The two
sub-graphs for the route via the tunnel and the route for the tunnel's
destination are shown to the right and left respectively. The red line shows the
relationship form by stacking the two sub-graphs. The adjacency on the tunnel
-interface is termed a ԭid-chainՠthis it is now present in the middle of the
+interface is termed a 'mid-chain' this it is now present in the middle of the
graph/chain rather than its usual terminal location.
The mid-chain adjacency is contributed by the gre_tunnel_t , which also becomes
diff --git a/docs/gettingstarted/developers/metadata.md b/docs/gettingstarted/developers/metadata.md
index 2f20596c0d9..34400ef4568 100644
--- a/docs/gettingstarted/developers/metadata.md
+++ b/docs/gettingstarted/developers/metadata.md
@@ -10,7 +10,7 @@ We will examine vpp buffer metadata in some detail, but folks who need
to manipulate and/or extend the scheme should expect to do a certain
level of code inspection.
-Vlib (Vector library) primary buffer metatdata
+Vlib (Vector library) primary buffer metadata
----------------------------------------------
The first 64 octets of each vlib_buffer_t carries the primary buffer
@@ -119,7 +119,7 @@ Important fields:
* NAT fields
* u32 unused[6]
-Vnet (network stack) secondary buffer metatdata
+Vnet (network stack) secondary buffer metadata
-----------------------------------------------
Vnet primary buffer metadata occupies space reserved in the vlib
diff --git a/docs/gettingstarted/developers/vlib.md b/docs/gettingstarted/developers/vlib.md
index 462168618b2..504ee07a7a0 100644
--- a/docs/gettingstarted/developers/vlib.md
+++ b/docs/gettingstarted/developers/vlib.md
@@ -527,7 +527,7 @@ Here is a complete example:
This example implements the "show ip tuple match" debug cli
command. In ordinary usage, the vlib cli is available via the "vppctl"
-applicationn, which sends traffic to a named pipe. One can configure
+application, which sends traffic to a named pipe. One can configure
debug CLI telnet access on a configurable port.
The cli implementation has an output redirection facility which makes it