Doc updates prior to branch 18/11518/1
authorChris Luke <chrisy@flirble.org>
Wed, 4 Apr 2018 18:13:50 +0000 (14:13 -0400)
committerChris Luke <chrisy@flirble.org>
Wed, 4 Apr 2018 18:13:50 +0000 (14:13 -0400)
Change-Id: Ibcffee7d20dbb79720199bcd82d2353f39d5544f
Signed-off-by: Chris Luke <chrisy@flirble.org>
RELEASE.md
doxygen/dev_doc.md
doxygen/user_doc.md
src/plugins/avf/README.md
src/plugins/lacp/lacp_doc.md
src/plugins/marvell/README.md

index 7543d77..b16376a 100644 (file)
@@ -1,5 +1,6 @@
 # Release Notes    {#release_notes}
 
+* @subpage release_notes_1804
 * @subpage release_notes_1801
 * @subpage release_notes_1710
 * @subpage release_notes_1707
@@ -9,6 +10,13 @@
 * @subpage release_notes_1609
 * @subpage release_notes_1606
 
+@page release_notes_1801 Release notes for VPP 18.04
+
+More than 530 commits since the 18.01 release.
+
+TODO
+
+
 @page release_notes_1801 Release notes for VPP 18.01
 
 More than 560 commits since the 17.10 release.
index d1d22f7..690a8d8 100644 (file)
@@ -9,4 +9,5 @@ Programming notes for developers.
 - @subpage vapi_doc
 - @subpage acl_hash_lookup
 - @subpage acl_multicore
+- @subpage acl_lookup_context
 - @subpage libmemif_doc
index 4d6b22f..5f139c7 100644 (file)
@@ -4,19 +4,22 @@ User Documentation    {#user_doc}
 Several modules provide operational, dataplane-user focused documentation.
 
 - [GUI guided user demo](https://wiki.fd.io/view/VPP_Sandbox/vpp-userdemo)
+- @subpage avf_plugin_doc
 - @subpage bfd_doc
+- @subpage dpdk_crypto_ipsec_doc
+- @subpage flowprobe_plugin_doc
 - @subpage ioam_plugin_doc
 - @subpage ipsec_gre_doc
+- @subpage kp_plugin_doc
+- @subpage lacp_plugin_doc
 - @subpage lb_plugin_doc
 - @subpage lldp_doc
 - @subpage map_doc
-- @subpage dpdk_crypto_ipsec_doc
-- @subpage flowprobe_plugin_doc
+- @subpage marvel_plugin_doc
+- @subpage nat64_doc
 - @subpage qos_doc
 - @subpage selinux_doc
 - @subpage span_doc
-- @subpage srv6_doc
 - @subpage srmpls_doc
-- @subpage nat64_doc
+- @subpage srv6_doc
 - @subpage vcl_ldpreload_doc
-- @subpage kp_plugin_doc
index 422a6c0..6a464a4 100644 (file)
@@ -1,4 +1,4 @@
-# Intel AVF device plugin for VPP   
+# Intel AVF device plugin for VPP    {#avf_plugin_doc}
 
 ##Overview
 This plugins provides native device support for intel Adaptive Virtual
index f196e0a..1f7fe4a 100644 (file)
@@ -1,8 +1,7 @@
-# VPP Link Aggregation Control Protocol (LACP) implementation    {#lacp_doc}
+# VPP Link Aggregation Control Protocol (LACP) implementation    {#lacp_plugin_doc}
 
 This document is to describe the usage of VPP LACP implementation.
 
-
 ## LACP
 
 The Link Aggregation Control Protocol (LACP) is an 802.3ad standard which
@@ -29,28 +28,33 @@ detach interface <interface>
 
 ### Configuration example
 
+```
 create bond mode lacp
 set interface state BondEthernet0 up
 enslave interface TenGigabitEthernet7/0/0 to BondEthernet1
 enslave interface TenGigabitEthernet7/0/1 to BondEthernet1
 enslave interface TenGigabitEthernet5/0/0 to BondEthernet1
 enslave interface TenGigabitEthernet5/0/1 to BondEthernet1
+```
 
+```
 detach interface TenGigabitEthernet5/0/1
+```
 
+```
 delete bond BondEthernet0
+```
 
 ### Operational data
 
+```
 show lacp [<interface>] [details]
+```
 
 Example:
 
-show lacp
-
-
-DBGvpp# sh lacp
-sh lacp
+```
+DBGvpp# show lacp
                                                         actor state                      partner state
 interface name            sw_if_index  bond interface   exp/def/dis/col/syn/agg/tim/act  exp/def/dis/col/syn/agg/tim/act
 GigabitEthernet2/0/1      1            BondEthernet0      0   0   1   1   1   1   1   1    0   0   1   1   1   1   1   1
@@ -75,18 +79,26 @@ TenGigabitEthernet6/0/0   4            BondEthernet2      0   0   1   1   1   1
   LAG ID: [(ffff,90-e2-ba-36-31-21,0002,00ff,0002), (ffff,90-e2-ba-29-f5-31,000f,00ff,0001)]
   RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
 DBGvpp#
+```
 
+```
 show bond [details]
+````
 
+Example:
 
-DBGvpp# sh bond
+```
+DBGvpp# show bond
 sh bond
 interface name   sw_if_index   mode         load balance  active slaves  slaves
 BondEthernet0    10            lacp         l2            1              1
 BondEthernet1    11            lacp         l34           4              4
 BondEthernet2    12            lacp         l23           2              2
 DBGvpp#
+```
 
 ### Debugging
 
-debug lacp [<interface>] <on | off>
\ No newline at end of file
+```
+debug lacp [<interface>] <on | off>
+```
index 786c4c8..300d583 100644 (file)
@@ -1,4 +1,4 @@
-# Marvel device plugin for VPP   
+# Marvel device plugin for VPP    {#marvel_plugin_doc}
 
 ##Overview
 This plugins provides native device support for Marvell PP2 network device, by use of Marvel Usermode SDK ([MUSDK][1]).