[6/6] doc: close up gaps in sample app guide table

Message ID 20191003131918.30970-7-bruce.richardson@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series remove a few example applications |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Bruce Richardson Oct. 3, 2019, 1:19 p.m. UTC
  Following the removal of some sample applications, close up the gaps
introduced in the table so that it is formatted nicely for the next
release.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/sample_app_ug/intro.rst | 30 +++++++++++++-----------------
 1 file changed, 13 insertions(+), 17 deletions(-)
  

Comments

Thomas Monjalon Oct. 23, 2019, 3:19 p.m. UTC | #1
03/10/2019 15:19, Bruce Richardson:
> Following the removal of some sample applications, close up the gaps
> introduced in the table so that it is formatted nicely for the next
> release.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

I don't think we should maintain such table.
Either it is a normal list, or we drop the whole listing.

>   .. table:: **Some of the DPDK Sample applications**
>  
>      +---------------------------------------+--------------------------------------+
> -    | Bonding                               |                                      |
> +    | Bonding                               | Packet Ordering                      |
>      +---------------------------------------+--------------------------------------+
> -    | Command Line                          | Packet Ordering                      |
> +    | Command Line                          | Performance Thread                   |
>      +---------------------------------------+--------------------------------------+
> -    | Distributor                           | Performance Thread                   |
> +    | Distributor                           | Precision Time Protocol (PTP) Client |
>      +---------------------------------------+--------------------------------------+
> -    | Ethtool                               | Precision Time Protocol (PTP) Client |
> -    +---------------------------------------+--------------------------------------+
> -    |                                       | Quality of Service (QoS) Metering    |
> +    | Ethtool                               | Quality of Service (QoS) Metering    |
>      +---------------------------------------+--------------------------------------+
>      | Hello World                           | QoS Scheduler                        |
>      +---------------------------------------+--------------------------------------+
> -    | Internet Protocol (IP) Fragmentation  |                                      |
> -    +---------------------------------------+--------------------------------------+
> -    | IP Pipeline                           | RX/TX Callbacks                      |
> +    | Internet Protocol (IP) Fragmentation  | RX/TX Callbacks                      |
>      +---------------------------------------+--------------------------------------+
> -    | IP Reassembly                         | Server node EFD                      |
> +    | IP Pipeline                           | Server node EFD                      |
>      +---------------------------------------+--------------------------------------+
> -    | IPsec Security Gateway                | Basic Forwarding/Skeleton App        |
> +    | IP Reassembly                         | Basic Forwarding/Skeleton App        |
>      +---------------------------------------+--------------------------------------+
> -    | IPv4 multicast                        | Tunnel End Point (TEP) termination   |
> +    | IPsec Security Gateway                | Tunnel End Point (TEP) termination   |
>      +---------------------------------------+--------------------------------------+
> -    | Kernel NIC Interface                  | Timer                                |
> +    | IPv4 multicast                        | Timer                                |
>      +---------------------------------------+--------------------------------------+
> -    | Network Layer 2 Forwarding + variants | Vhost                                |
> +    | Kernel NIC Interface                  | Vhost                                |
>      +---------------------------------------+--------------------------------------+
> -    | Network Layer 3 Forwarding + variants | Vhost Xen                            |
> +    | Network Layer 2 Forwarding + variants | Vhost Xen                            |
>      +---------------------------------------+--------------------------------------+
> -    | Link Status Interrupt                 | VMDQ Forwarding                      |
> +    | Network Layer 3 Forwarding + variants | VMDQ Forwarding                      |
>      +---------------------------------------+--------------------------------------+
> -    |                                       | VMDQ and DCB Forwarding              |
> +    | Link Status Interrupt                 | VMDQ and DCB Forwarding              |
>      +---------------------------------------+--------------------------------------+
>      | Multi-process                         | VM Power Management                  |
>      +---------------------------------------+--------------------------------------+
  

Patch

diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
index 981e50f94..dcfe70db2 100644
--- a/doc/guides/sample_app_ug/intro.rst
+++ b/doc/guides/sample_app_ug/intro.rst
@@ -31,37 +31,33 @@  applications that are available in the examples directory of DPDK:
  .. table:: **Some of the DPDK Sample applications**
 
     +---------------------------------------+--------------------------------------+
-    | Bonding                               |                                      |
+    | Bonding                               | Packet Ordering                      |
     +---------------------------------------+--------------------------------------+
-    | Command Line                          | Packet Ordering                      |
+    | Command Line                          | Performance Thread                   |
     +---------------------------------------+--------------------------------------+
-    | Distributor                           | Performance Thread                   |
+    | Distributor                           | Precision Time Protocol (PTP) Client |
     +---------------------------------------+--------------------------------------+
-    | Ethtool                               | Precision Time Protocol (PTP) Client |
-    +---------------------------------------+--------------------------------------+
-    |                                       | Quality of Service (QoS) Metering    |
+    | Ethtool                               | Quality of Service (QoS) Metering    |
     +---------------------------------------+--------------------------------------+
     | Hello World                           | QoS Scheduler                        |
     +---------------------------------------+--------------------------------------+
-    | Internet Protocol (IP) Fragmentation  |                                      |
-    +---------------------------------------+--------------------------------------+
-    | IP Pipeline                           | RX/TX Callbacks                      |
+    | Internet Protocol (IP) Fragmentation  | RX/TX Callbacks                      |
     +---------------------------------------+--------------------------------------+
-    | IP Reassembly                         | Server node EFD                      |
+    | IP Pipeline                           | Server node EFD                      |
     +---------------------------------------+--------------------------------------+
-    | IPsec Security Gateway                | Basic Forwarding/Skeleton App        |
+    | IP Reassembly                         | Basic Forwarding/Skeleton App        |
     +---------------------------------------+--------------------------------------+
-    | IPv4 multicast                        | Tunnel End Point (TEP) termination   |
+    | IPsec Security Gateway                | Tunnel End Point (TEP) termination   |
     +---------------------------------------+--------------------------------------+
-    | Kernel NIC Interface                  | Timer                                |
+    | IPv4 multicast                        | Timer                                |
     +---------------------------------------+--------------------------------------+
-    | Network Layer 2 Forwarding + variants | Vhost                                |
+    | Kernel NIC Interface                  | Vhost                                |
     +---------------------------------------+--------------------------------------+
-    | Network Layer 3 Forwarding + variants | Vhost Xen                            |
+    | Network Layer 2 Forwarding + variants | Vhost Xen                            |
     +---------------------------------------+--------------------------------------+
-    | Link Status Interrupt                 | VMDQ Forwarding                      |
+    | Network Layer 3 Forwarding + variants | VMDQ Forwarding                      |
     +---------------------------------------+--------------------------------------+
-    |                                       | VMDQ and DCB Forwarding              |
+    | Link Status Interrupt                 | VMDQ and DCB Forwarding              |
     +---------------------------------------+--------------------------------------+
     | Multi-process                         | VM Power Management                  |
     +---------------------------------------+--------------------------------------+