[v3,1/6] doc: remove unnecessary sample app guide table
Checks
Commit Message
The table of examples in the sample application guide is now removed,
as it was unnecessary and difficult to update when adding/removing
examples.
Signed-off-by: Ciara Power <ciara.power@intel.com>
---
v2: Remove the table listing sample applications
---
doc/guides/sample_app_ug/intro.rst | 44 +-----------------------------
1 file changed, 1 insertion(+), 43 deletions(-)
Comments
On Fri, Oct 25, 2019 at 10:56:03AM +0100, Ciara Power wrote:
> The table of examples in the sample application guide is now removed,
> as it was unnecessary and difficult to update when adding/removing
> examples.
>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
>
> ---
>
> v2: Remove the table listing sample applications
> ---
> doc/guides/sample_app_ug/intro.rst | 44 +-----------------------------
> 1 file changed, 1 insertion(+), 43 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
> index 90704194a..a7576837c 100644
> --- a/doc/guides/sample_app_ug/intro.rst
> +++ b/doc/guides/sample_app_ug/intro.rst
> @@ -23,49 +23,7 @@ command-line options.
> The DPDK Sample Applications
> ----------------------------
>
> -Table :numref:`table_sample_apps` shows a list of some of the main sample
> -applications that are available in the examples directory of DPDK:
> -
> - .. _table_sample_apps:
> -
> - .. table:: **Some of the DPDK Sample applications**
> -
> - +---------------------------------------+--------------------------------------+
> - | Bonding | Netmap Compatibility |
> - +---------------------------------------+--------------------------------------+
> - | Command Line | Packet Ordering |
> - +---------------------------------------+--------------------------------------+
> - | Distributor | Performance Thread |
> - +---------------------------------------+--------------------------------------+
> - | Ethtool | Precision Time Protocol (PTP) Client |
> - +---------------------------------------+--------------------------------------+
> - | Exception Path | Quality of Service (QoS) Metering |
> - +---------------------------------------+--------------------------------------+
> - | Hello World | QoS Scheduler |
> - +---------------------------------------+--------------------------------------+
> - | Internet Protocol (IP) Fragmentation | Quota and Watermark |
> - +---------------------------------------+--------------------------------------+
> - | IP Pipeline | RX/TX Callbacks |
> - +---------------------------------------+--------------------------------------+
> - | IP Reassembly | Server node EFD |
> - +---------------------------------------+--------------------------------------+
> - | IPsec Security Gateway | Basic Forwarding/Skeleton App |
> - +---------------------------------------+--------------------------------------+
> - | IPv4 multicast | Tunnel End Point (TEP) termination |
> - +---------------------------------------+--------------------------------------+
> - | Kernel NIC Interface | Timer |
> - +---------------------------------------+--------------------------------------+
> - | Network Layer 2 Forwarding + variants | Vhost |
> - +---------------------------------------+--------------------------------------+
> - | Network Layer 3 Forwarding + variants | Vhost Xen |
> - +---------------------------------------+--------------------------------------+
> - | Link Status Interrupt | VMDQ Forwarding |
> - +---------------------------------------+--------------------------------------+
> - | Load Balancer | VMDQ and DCB Forwarding |
> - +---------------------------------------+--------------------------------------+
> - | Multi-process | VM Power Management |
> - +---------------------------------------+--------------------------------------+
> -
> +There are many sample applications available in the examples directory of DPDK.
> These examples range from simple to reasonably complex but most are designed
> to demonstrate one particular feature of DPDK. Some of the more interesting
> examples are highlighted below.
> --
> 2.17.1
>
This table was pointless anyway, since the index gives a list of all the
apps, and a select are already called out below this in the doc.
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
@@ -23,49 +23,7 @@ command-line options.
The DPDK Sample Applications
----------------------------
-Table :numref:`table_sample_apps` shows a list of some of the main sample
-applications that are available in the examples directory of DPDK:
-
- .. _table_sample_apps:
-
- .. table:: **Some of the DPDK Sample applications**
-
- +---------------------------------------+--------------------------------------+
- | Bonding | Netmap Compatibility |
- +---------------------------------------+--------------------------------------+
- | Command Line | Packet Ordering |
- +---------------------------------------+--------------------------------------+
- | Distributor | Performance Thread |
- +---------------------------------------+--------------------------------------+
- | Ethtool | Precision Time Protocol (PTP) Client |
- +---------------------------------------+--------------------------------------+
- | Exception Path | Quality of Service (QoS) Metering |
- +---------------------------------------+--------------------------------------+
- | Hello World | QoS Scheduler |
- +---------------------------------------+--------------------------------------+
- | Internet Protocol (IP) Fragmentation | Quota and Watermark |
- +---------------------------------------+--------------------------------------+
- | IP Pipeline | RX/TX Callbacks |
- +---------------------------------------+--------------------------------------+
- | IP Reassembly | Server node EFD |
- +---------------------------------------+--------------------------------------+
- | IPsec Security Gateway | Basic Forwarding/Skeleton App |
- +---------------------------------------+--------------------------------------+
- | IPv4 multicast | Tunnel End Point (TEP) termination |
- +---------------------------------------+--------------------------------------+
- | Kernel NIC Interface | Timer |
- +---------------------------------------+--------------------------------------+
- | Network Layer 2 Forwarding + variants | Vhost |
- +---------------------------------------+--------------------------------------+
- | Network Layer 3 Forwarding + variants | Vhost Xen |
- +---------------------------------------+--------------------------------------+
- | Link Status Interrupt | VMDQ Forwarding |
- +---------------------------------------+--------------------------------------+
- | Load Balancer | VMDQ and DCB Forwarding |
- +---------------------------------------+--------------------------------------+
- | Multi-process | VM Power Management |
- +---------------------------------------+--------------------------------------+
-
+There are many sample applications available in the examples directory of DPDK.
These examples range from simple to reasonably complex but most are designed
to demonstrate one particular feature of DPDK. Some of the more interesting
examples are highlighted below.