docs: Edit FEATURE.yaml files so they can be published 88/24288/4
authorJohn DeNisco <jdenisco@cisco.com>
Fri, 10 Jan 2020 15:07:26 +0000 (10:07 -0500)
committerOle Trøan <otroan@employees.org>
Fri, 10 Jan 2020 17:20:21 +0000 (17:20 +0000)
Type: docs
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I7280e5c5ad10a66c0787a5282291a2ef000bff5f

35 files changed:
src/plugins/abf/FEATURE.yaml
src/plugins/builtinurl/FEATURE.yaml
src/plugins/crypto_ia32/FEATURE.yaml
src/plugins/crypto_ipsecmb/FEATURE.yaml
src/plugins/crypto_openssl/FEATURE.yaml
src/plugins/dhcp/FEATURE.yaml
src/plugins/gtpu/FEATURE.yaml
src/plugins/http_static/FEATURE.yaml
src/plugins/igmp/FEATURE.yaml
src/plugins/l3xc/FEATURE.yaml
src/plugins/lacp/FEATURE.yaml
src/plugins/lb/FEATURE.yaml
src/plugins/mactime/FEATURE.yaml
src/plugins/map/FEATURE.yaml
src/plugins/mdata/FEATURE.yaml
src/plugins/nat/FEATURE.yaml
src/plugins/svs/FEATURE.yaml
src/vcl/FEATURE.yaml
src/vnet/bfd/FEATURE.yaml
src/vnet/bier/FEATURE.yaml
src/vnet/devices/af_packet/FEATURE.yaml
src/vnet/dpo/FEATURE.yaml
src/vnet/gre/FEATURE.yaml
src/vnet/ip-neighbor/FEATURE.yaml
src/vnet/ipsec/FEATURE.yaml
src/vnet/l2/FEATURE.yaml
src/vnet/lisp-cp/FEATURE.yaml
src/vnet/lisp-gpe/FEATURE.yaml
src/vnet/lldp/FEATURE.yaml
src/vnet/mpls/FEATURE.yaml
src/vnet/qos/FEATURE.yaml
src/vnet/tcp/FEATURE.yaml
src/vnet/tls/FEATURE.yaml
src/vnet/udp/FEATURE.yaml
src/vnet/vxlan/FEATURE.yaml

index f77d1a3..b9f3285 100644 (file)
@@ -15,6 +15,6 @@ features:
   - ABF runs as an input feature in the L3 path
 
 
-description: "ACL Based Forwarding"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index ff99299..ba8e3c7 100644 (file)
@@ -1,9 +1,9 @@
 ---
-name: Builtin URL support for the static http/https server (builtinurl)
+name: Builtin URL support for the static http or https server
 maintainer: Dave Barach <dave@barachs.net>
 features:
   - Builtin URLs for the static http/https server
-description: "Adds a set of URLs to the static http/https server.
+description: "The (builtinurl) plugin adds a set of URLs to the static http/https server.
               Current URLs, all of which return data in .json fmt:
               <root-url>/version.json - vpp version info
               <root-url>/interface_list.json - list of interfaces
index 29f81f4..206cace 100644 (file)
@@ -5,6 +5,6 @@ features:
   - CBC(128, 192, 256)
   - GCM(128, 192, 256)
 
-description: "native crypto-engine"
+description: "An implentation of a native crypto-engine"
 state: production
 properties: [API, CLI, MULTITHREAD]
index ec33a1b..3ca03bf 100644 (file)
@@ -6,6 +6,6 @@ features:
   - CBC(128, 192, 256)
   - GCM(128, 192, 256)
 
-description: "IPSecMB crypto-engine"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index 41f9399..da0a081 100644 (file)
@@ -9,6 +9,6 @@ features:
   - DES, 3DES
   - MD5
 
-description: "openssl crypto-engine"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index acc7eaf..469af29 100644 (file)
@@ -1,11 +1,11 @@
 ---
-name: Dynamic Host Configuration Protocol (DHCP)
+name: Dynamic Host Configuration Protocol
 maintainer: Dave Barach <dave@barachs.net>, Neale Ranns <nranns@cisco.com>
 features:
   - DHCP client (v4/v6)
   - DHCPv6 prefix delegation
   - DHCP Proxy / Option 82
 
-description: "DHCP client"
+description: "An implemenation of the Dynamic Host Configuration Protocol (DHCP) client"
 state: production
 properties: [API, CLI, MULTITHREAD]
index fbd576b..2ce20ca 100644 (file)
@@ -1,10 +1,10 @@
 ---
-name: GTPU
+name: GPRS Tunneling Protocol
 maintainer: Hongjun Ni <hongjun.ni@intel.com>
 features:
   - GTPU decapsulation
   - GTPU encapsulation
 
-description: "GPRS Tunnelling Protocol"
+description: "An implementation of the GPRS Tunnelling Protocol"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 67a6842..d40855f 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: Static http/https server (http_static)
+name: Static http https server
 maintainer: Dave Barach <dave@barachs.net>
 features:
   - An extensible static http/https server with caching
index aab4960..686ef6d 100644 (file)
@@ -4,6 +4,6 @@ maintainer: Neale Ranns <nranns@cisco.com>
 features:
   - IGMPv3 only.
 
-description: "IGMP"
+description: "An implementation of the Internet Group Management Protocol (IGMP)"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 3c2bf07..5086fee 100644 (file)
@@ -8,6 +8,6 @@ features:
     and adding a default route with the same path. However, the L3XC is more
     efficient in memory and CPU
 
-description: "L3-xconnect"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index 4812c02..516efde 100644 (file)
@@ -1,8 +1,8 @@
 ---
-name: Link Aggregation Control Protocol (LACP)
+name: Link Aggregation Control Protocol
 maintainer: Steven Luong <sluong@cisco.com>
 features:
   - Support LACP version 1 specification including marker protocol
-description: "Link Aggregation Control Protocol implementation"
+description: "Link Aggregation Control Protocol implementation (LACP)"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index 7456e68..9a9887c 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: LB
+name: Load Balancer
 maintainer: Pfister <ppfister@cisco.com>, Hongjun Ni <hongjun.ni@intel.com>
 features:
   - GRE tunnel mode
@@ -8,6 +8,6 @@ features:
   - Consistent Hash
   - Connection Track
 
-description: "Load Balancer"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index f24450e..144c70b 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: Time-range-based MAC-address filter (mactime)
+name: Time-range-based MAC-address filter
 maintainer: Dave Barach <dave@barachs.net>
 features:
   - Static / time-range / data quota based MAC address filter
index b505591..18df5f5 100644 (file)
@@ -1,12 +1,12 @@
 ---
-name: Mapping of Address and Port (MAP)
+name: Mapping of Address and Port
 maintainer: Ole Troan <ot@cisco.com>
 features:
   - LW46 BR (RFC7596):
       - Fragmentation and Reassembly
   - MAP-E BR (RFC7597)
   - MAP-T BR (RFC7599)
-description: "IPv4 as a service mechanisms. Tunnel or translate
+description: "Mapping of Address and Port (MAP): IPv4 as a service mechanisms. Tunnel or translate
               an IPv4 address, an IPv4 subnet or a shared IPv4 address.
               In shared IPv4 address mode, only UDP, TCP and restricted
               ICMP is supported."
index d25a71d..d1843e6 100644 (file)
@@ -1,11 +1,11 @@
 ---
-name: Buffer Metadata Change Tracker (mdata)
+name: Buffer Metadata Change Tracker
 maintainer: Dave Barach <dave@barachs.net>
 features:
   - Buffer Metadata Change Tracker
 description: |-
-              Buffer Metadata Change Tracker
-              Uses the before / after graph node main loop performance
+              The Buffer Metadata Change Tracker (mdata)
+              uses the before / after graph node main loop performance
               callback hooks to snapshoot buffer metadata, then
               compare and summarize results per-node.
               Answers the question "what buffer metadata does a particular
index 65cd959..183db05 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: Network Address Translation (NAT)
+name: Network Address Translation
 maintainer:
   - Ole Troan <ot@cisco.com>
   - Filip Varga <fivarga@cisco.com>
@@ -20,8 +20,8 @@ features:
   - NAT66
   - DS-lite
   - 464XLAT
-description: "The NAT plugin offers a multiple address translation functions.
-              These can be used in a raft of different scenarios. CPE, CGN,
-              etc."
+description: "The Network Address Translation (NAT) plugin offers a multiple address
+              translation functions. These can be used in a raft of different
+              scenarios. CPE, CGN, etc."
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index 7941df3..f37234a 100644 (file)
@@ -10,6 +10,6 @@ features:
   - Tables are bound to interfaces.
   - SVS runs as an input feature in the L3 path
 
-description: "Source VRF Select"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index b2ab7cc..06236bc 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: VPP Comms Library (VCL)
+name: VPP Comms Library
 maintainer: Florin Coras <fcoras@cisco.com>
 features:
   - Abstracts vpp host stack sessions to integer session handles
@@ -16,7 +16,7 @@ features:
       - Applications that are supported work with VCL and implicitly with VPP's
         host stack without any code change
       - It does not support all syscalls and syscall options
-description: "VCL simplifies app interaction with session layer by exposing
-              APIs that are similar to but not POSIX-compliant."
+description: "VPP Comms Library (VCL) simplifies app interaction with session layer
+              by exposing APIs that are similar to but not POSIX-compliant."
 state: production
 properties: [API, CLI, MULTITHREAD]
index 5c14281..eb57196 100644 (file)
@@ -1,8 +1,8 @@
 ---
-name: Bidirectional Forwarding Detection (BFD)
+name: Bidirectional Forwarding Detection
 maintainer: Klement Sekera <ksekera@cisco.com>
 features:
   - BFD protocol implementation
-description: "Bidirectional Forwarding Detection implementation"
+description: "An implementation of Bidirectional Forwarding Detection (BFD)."
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index fcd72d0..7c10929 100644 (file)
@@ -7,6 +7,6 @@ features:
   - Encapsulation for Bit Index Explicit Replication (BIER) in MPLS and
     Non-MPLS Networks (https://tools.ietf.org/html/rfc8296)
 
-description: "BIER"
+description: "An implementation of Bit Indexed Explicit Replication (BIER)"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 4a057c4..25d8b2b 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: host-interface Device (AF_PACKET)
+name: host-interface Device AF_PACKET
 maintainer: Damjan Marion <damarion@cisco.com>
 features:
   - L4 checksum offload
index 747ac91..e255656 100644 (file)
@@ -10,6 +10,6 @@ features:
   - DPO graphs can be rooted at any point in the VLIB graph - notable examples
     are L3 FIB lookup, ABF, L3XC.
 
-description: "DPO"
+description: "Data-Plane Objects (DPO)"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 5e0e77c..4b35b87 100644 (file)
@@ -8,6 +8,6 @@ features:
   - L2 tunnels
 missing:
   - GRE keys
-description: "GRE"
+description: "An implementation of Generic Routing Encapsulation (GRE)"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 00ca849..08e3aaf 100644 (file)
@@ -5,6 +5,6 @@ features:
   - IP protocol independent Database of Neighbours (aka peers)
   - limits on number of peers, recycling and aging
 
-description: "IP-neighbor"
+description: ""
 state: production
 properties: [API, CLI, MULTITHREAD]
index 0fe7781..1f2915a 100644 (file)
@@ -6,6 +6,6 @@ features:
   - Authetication Header (https://tools.ietf.org/html/rfc4302)
   - Encapsulating Security Payload (https://tools.ietf.org/html/rfc4303)
 
-description: "IPSec"
+description: "An implementation of IPSec"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 04a81d5..510dc17 100644 (file)
@@ -1,9 +1,9 @@
 ---
-name: Layer 2 Forwarding (L2)
+name: Layer 2 Forwarding
 maintainer: John Lo <loj@cisco.com>
 features:
-  - L2 Cross-connect (xconnect) of two interfaces
-  - L2 Bridging of multiple interfaces in a bridge domain (BD):
+  - Layer 2 (L2) Cross-connect (xconnect) of two interfaces
+  - Layer 2 (L2) Bridging of multiple interfaces in a bridge domain (BD):
       - Forwarding via destination MAC address of packet
       - MAC learning enable/disable on BD or per interface
       - MAC aging with specified aging interval enable/disable
index 957186d..fb48e1f 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: Locator/ID Separation Protocol (LISP) Control Plane
+name: Locator ID Separation Protocol Control Plane
 maintainer: Florin Coras <fcoras@cisco.com>
 features:
   - ITR, ETR and RTR mode of operation
@@ -9,6 +9,6 @@ features:
   - RLOC-probing
   - Support for Ethernet, IPv4, IPv6 and NSH EIDs (payloads)
   - Map-resolver failover algorithm
-description: "LISP control plane implementation"
+description: "Locator ID Separation Protocol control plane (LISP) implementation"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index fb051e3..d2016e6 100644 (file)
@@ -1,11 +1,11 @@
 ---
-name: Locator/ID Separation Protocol Generic Protocol Extension (LISP-GPE)
+name: Locator ID Separation Protocol Generic Protocol Extension
 maintainer: Florin Coras <fcoras@cisco.com>
 features:
   - ITR, ETR and RTR modes
   - Support for Ethernet, IPv4, IPv6 and NSH EIDs (payloads)
   - Source/dest forwarding
   - IPv4 and IPv6 RLOCs
-description: "LISP-GPE implementation"
+description: "Locator ID Separation Protocol Generic Protocol Extension (LISP-GPE) implementation"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index 0d3277d..feda51a 100644 (file)
@@ -1,8 +1,8 @@
 ---
-name: Link Layer Discovery Protocol (LLDP)
+name: Link Layer Discovery Protocol
 maintainer: Klement Sekera <ksekera@cisco.com>
 features:
   - link layer discovery protocol implementation
-description: "Link Layer Discovery Protocol implementation"
+description: "Link Layer Discovery Protocol (LLDP) implementation"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index 89c4589..c036751 100644 (file)
@@ -5,6 +5,6 @@ features:
   - Label imposition/disposition - pipe and uniform mode
   - Tunnels - unidirectional
 
-description: "MPLS"
+description: "An implementation of Multi-Protocol Label Switching (MPLS)"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 3f7975a..47ccf0a 100644 (file)
@@ -7,6 +7,6 @@ features:
   - Mark - write [mapped] QoS bits into packet headers
   - Store - write in packet metadata a fixed QoS value
 
-description: "QoS"
+description: "An implentation of Quality of Service (QoS)"
 state: production
 properties: [API, CLI, MULTITHREAD]
index 2ef690c..10c88ee 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: Transmission Control Protocol (TCP)
+name: Transmission Control Protocol
 maintainer: Florin Coras <fcoras@cisco.com>
 features:
         - Core functionality (RFC793, RFC5681, RFC6691)
@@ -10,6 +10,6 @@ features:
         - Defending spoofing and flooding attacks (RFC6528)
         - Partly implemented features (RFC1122, RFC4898, RFC5961)
         - Delivery rate estimation (draft-cheng-iccrg-delivery-rate-estimation)
-description: "High speed and scale TCP implementation"
+description: "High speed and scale Transmission Control Protocol (TCP) implementation"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index a27d783..46eec31 100644 (file)
@@ -1,14 +1,14 @@
 ---
-name: Transport Layer Security (TLS)
+name: Transport Layer Security
 maintainer:
   - Florin Coras <fcoras@cisco.com>
   - Ping Yu <ping.yu@intel.com>
 features:
   - Framework that supports pluggable TLS engines
   - OpenSSL, Picotls and MbedTLS engines
-description: "TLS protocol implementation that consists of a set of engines
-              that act as wrappers for existing TLS implementations, e.g.,
-              OpenSSL, Picotls and MbedTLS, and a framework that integrates
-              the engines into VPP's host stack"
+description: "Transport Layer Security (TLS) protocol implementation that
+              consists of a set of engines that act as wrappers for existing
+              TLS implementations, e.g., OpenSSL, Picotls and MbedTLS, and
+              a framework that integrates the engines into VPP's host stack"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index 9291363..ad243b7 100644 (file)
@@ -1,9 +1,9 @@
 ---
-name: User Datagram Protocol (UDP)
+name: User Datagram Protocol
 maintainer: Florin Coras <fcoras@cisco.com>
 features:
   - host stack integration via session layer
   - standalone per port dispatcher for tunneling protocols
-description: "UDP implementation"
+description: "User Datagram Protocol (UDP) implementation"
 state: production
 properties: [API, CLI, STATS, MULTITHREAD]
index 41abbca..dc7d21b 100644 (file)
@@ -1,5 +1,5 @@
 ---
-name: Virtual eXtensible LAN (VXLAN)
+name: Virtual eXtensible LAN
 maintainer: John Lo <loj@cisco.com>
 features:
   - VXLAN tunnel for support of L2 overlay/virtual networks (RFC-7348)
@@ -9,6 +9,6 @@ features:
   - VXLAN encap with flow-hashed source port for better underlay IP load balance
   - VXLAN decap optimization via vxlan-bypass IP feature on underlay interfaces
   - VXLAN decap HW offload using flow director with DPDK on Intel Fortville NICs
-description: "VXLAN tunnels support L2 overlay networks that span L3 networks"
+description: "Virtual eXtensible LAN (VXLAN) tunnels support L2 overlay networks that span L3 networks"
 state: production
 properties: [API, CLI, MULTITHREAD]