[dpdk-dev] [PATCH v4 2/2] doc: add new introduction to sample app guides

Mcnamara, John john.mcnamara at intel.com
Thu Oct 5 19:48:26 CEST 2017



> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Thursday, October 5, 2017 12:13 PM
> To: Mcnamara, John <john.mcnamara at intel.com>
> Cc: dev at dpdk.org; Kovacevic, Marko <marko.kovacevic at intel.com>
> Subject: [PATCH v4 2/2] doc: add new introduction to sample app guides
> 
> Add new Introduction Section into the sample app guides.
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic at intel.com>

Hi,

Some minor comments below.


>...

> +Introduction to the DPDK Sample Applications
> +============================================
> +
> +This article describes the Data Plane Development Kit Sample
> Applications.

This first line can be omitted.


> +
> +The DPDK Sample Applications are small standalone applications which
> +demonstrate various features of DPDK. They can be considered a cookbook
> of DPDK features.
> +User interested in getting started with DPDK can take the applications,
> +try out the features, and then extend them to fit their needs.

s/User/Users/


> +
> +
> +The DPDK Sample Applications
> +----------------------------
> +
> + .. _table_:
> + .. table:: **Some of the DPDK Sample applications**


The _table_ target should be more unique such as: _table_sample_apps


> +
> +These examples range from simple to reasonable complex but most are


s/reasonable/reasonably/

> +The Hello
> +  World example sets up the DPDK Environment Abstraction Layer (EAL),
> +and prints a
> +  simple "Hello World" message to each of the DPDK enabled cores. This
> +  applicatioin doesn’t do any packet formatting but it is a good way to


s/applicatioin/application/


Reviewed-by: John McNamara <john.mcnamara at intel.com>




More information about the dev mailing list