diff options
| author |   Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2019-07-29 11:18:05 +0200 |
|---|---|---|
| committer |   Dave Barach <openvpp@barachs.net> | 2019-08-01 18:01:57 +0000 |
| commit | 55c68c9521d98005ce850ee54a40c7579d88928b (patch) | |
| tree | b5513b058e87e9914c13e5f08df5787f2b595fa8 /src | |
| parent | 30aaf97a90230d68c0f2736b0a026e07b06e7e32 (diff) | |
docs: Small fixes and ordering
* deactivtates the TODOs on doxygen (were empty)
* This move punt.md to readthedocs (should be the new
place for dev doc ?)
* Makes Handoff queue demo plugin a child of dev doc
in doxygen
Type: fix
Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/examples/handoffdemo/README.md | 2 | ||||
| -rw-r--r-- | src/vnet/ip/punt.rst (renamed from src/vnet/ip/punt.md) | 21 |
2 files changed, 11 insertions, 12 deletions
diff --git a/src/examples/handoffdemo/README.md b/src/examples/handoffdemo/README.md index 3787731c73f..e38c7b3cca0 100644 --- a/src/examples/handoffdemo/README.md +++ b/src/examples/handoffdemo/README.md @@ -1,4 +1,4 @@ -# Handoff queue demo plugin +# Handoff queue demo plugin {#handoff_queue_demo_plugin} This plugin provides a simplified example of how to hand off packets between threads. I used it to debug packet-tracer handoff diff --git a/src/vnet/ip/punt.md b/src/vnet/ip/punt.rst index 2bbb5f6b97e..3f1a9d4a844 100644 --- a/src/vnet/ip/punt.md +++ b/src/vnet/ip/punt.rst @@ -1,10 +1,10 @@ -.. _punt: +.. _dev_punt: + +.. toctree:: Punting Packets =============== -.. toctree:: - Overview ________ @@ -17,8 +17,8 @@ A popular meaning of punt is to send packets to the user/control-plane. This is specific option of the more general case above, where VPP is handing the packet to the control-plane for further prosessing. -The Punt Infrastructe ---------------------- +The Punt Infrastructure +_______________________ Exception packets are those that a given node cannot handle via normal mecahnisms. @@ -37,7 +37,7 @@ that the source node would otherise drop. Punting to the Control Plane ----------------------------- +____________________________ Active Punt ----------- @@ -47,11 +47,10 @@ want to receive and this is where I want it sent. Currently there exists 3 ways to describe how to match/classify the packets to be punted: -... - 1) a matching UDP port - 2) a matching IP protocol (i.e. OSPF) - 3) a matching punt excpetion reason (see above) -... + +1) a matching UDP port +2) a matching IP protocol (i.e. OSPF) +3) a matching punt excpetion reason (see above) Depending on the type/classification of the packet to be punted, that active punt will register itself into the VLIB graph to receive those |