[dpdk-dev] [PATCH] doc: fix repeated typo in sample app docs

[dpdk-dev] [PATCH] doc: fix repeated typo in sample app docs

[John McNamara]

Fix repeated typo in the "Compiling the Application" section of
almost all of the sample app docs.

This generally gets copied into new sample app guides.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/sample_app_ug/kernel_nic_interface.rst    | 4 ++--
 doc/guides/sample_app_ug/l2_forward_job_stats.rst    | 3 ++-
 doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 3 ++-
 doc/guides/sample_app_ug/l3_forward.rst              | 3 ++-
 doc/guides/sample_app_ug/l3_forward_power_man.rst    | 3 ++-
 doc/guides/sample_app_ug/qos_scheduler.rst           | 3 ++-
 doc/guides/sample_app_ug/timer.rst                   | 3 ++-
 doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst     | 3 ++-
 8 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/doc/guides/sample_app_ug/kernel_nic_interface.rst b/doc/guides/sample_app_ug/kernel_nic_interface.rst
index f1deca9..c8fc10a 100644
--- a/doc/guides/sample_app_ug/kernel_nic_interface.rst
+++ b/doc/guides/sample_app_ug/kernel_nic_interface.rst
@@ -87,8 +87,8 @@ Compile the application as follows:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd
-        ${RTE_SDK}/examples/kni
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/kni
 
 #.  Set the target (a default target is used if not specified)
 
diff --git a/doc/guides/sample_app_ug/l2_forward_job_stats.rst b/doc/guides/sample_app_ug/l2_forward_job_stats.rst
index 6cbf627..acf6273 100644
--- a/doc/guides/sample_app_ug/l2_forward_job_stats.rst
+++ b/doc/guides/sample_app_ug/l2_forward_job_stats.rst
@@ -101,7 +101,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l2fwd-jobstats
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l2fwd-jobstats
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
index 9334e75..65a3cec 100644
--- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
+++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
@@ -101,7 +101,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l2fwd
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l2fwd
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst
index 6ca03f9..34a84f1 100644
--- a/doc/guides/sample_app_ug/l3_forward.rst
+++ b/doc/guides/sample_app_ug/l3_forward.rst
@@ -69,7 +69,8 @@ To compile the application:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l3fwd
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l3fwd
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst
index 39c2ea5..ac688f8 100644
--- a/doc/guides/sample_app_ug/l3_forward_power_man.rst
+++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst
@@ -111,7 +111,8 @@ To compile the application:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l3fwd-power
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l3fwd-power
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/qos_scheduler.rst b/doc/guides/sample_app_ug/qos_scheduler.rst
index ffa8ee2..7f9e925 100644
--- a/doc/guides/sample_app_ug/qos_scheduler.rst
+++ b/doc/guides/sample_app_ug/qos_scheduler.rst
@@ -64,7 +64,8 @@ To compile the application:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/qos_sched
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/qos_sched
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/timer.rst b/doc/guides/sample_app_ug/timer.rst
index ee0a732..e4de359 100644
--- a/doc/guides/sample_app_ug/timer.rst
+++ b/doc/guides/sample_app_ug/timer.rst
@@ -41,7 +41,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/timer
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/timer
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst b/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
index 6fb0f0b..9140a22 100644
--- a/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
+++ b/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
@@ -93,7 +93,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/vmdq_dcb
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/vmdq_dcb
 
 #.  Set the target (a default target is used if not specified). For example:
 
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] doc: fix repeated typo in sample app docs

[De Lara Guarch, Pablo]

Hi John,

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Friday, November 13, 2015 5:55 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: fix repeated typo in sample app docs
> 
> Fix repeated typo in the "Compiling the Application" section of
> almost all of the sample app docs.
> 
> This generally gets copied into new sample app guides.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Could you also fix the issue below in the load balancer application,
which is related to this patch?

cd ${RTE_SDK}/examples/load_balancer make

Thanks!
Pablo

[dpdk-dev] [PATCH v2] doc: fix repeated typo in sample app docs

[John McNamara]

Fix repeated typo in the "Compiling the Application" section of
almost all of the sample app docs.

This generally gets copied into new sample app guides.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---

V2:
* Added similar fix in load_balancer file.


 doc/guides/sample_app_ug/kernel_nic_interface.rst    | 4 ++--
 doc/guides/sample_app_ug/l2_forward_job_stats.rst    | 3 ++-
 doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 3 ++-
 doc/guides/sample_app_ug/l3_forward.rst              | 3 ++-
 doc/guides/sample_app_ug/l3_forward_power_man.rst    | 3 ++-
 doc/guides/sample_app_ug/load_balancer.rst           | 3 ++-
 doc/guides/sample_app_ug/qos_scheduler.rst           | 3 ++-
 doc/guides/sample_app_ug/timer.rst                   | 3 ++-
 doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst     | 3 ++-
 9 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/doc/guides/sample_app_ug/kernel_nic_interface.rst b/doc/guides/sample_app_ug/kernel_nic_interface.rst
index f1deca9..c8fc10a 100644
--- a/doc/guides/sample_app_ug/kernel_nic_interface.rst
+++ b/doc/guides/sample_app_ug/kernel_nic_interface.rst
@@ -87,8 +87,8 @@ Compile the application as follows:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd
-        ${RTE_SDK}/examples/kni
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/kni
 
 #.  Set the target (a default target is used if not specified)
 
diff --git a/doc/guides/sample_app_ug/l2_forward_job_stats.rst b/doc/guides/sample_app_ug/l2_forward_job_stats.rst
index 6cbf627..acf6273 100644
--- a/doc/guides/sample_app_ug/l2_forward_job_stats.rst
+++ b/doc/guides/sample_app_ug/l2_forward_job_stats.rst
@@ -101,7 +101,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l2fwd-jobstats
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l2fwd-jobstats
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
index 9334e75..65a3cec 100644
--- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
+++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
@@ -101,7 +101,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l2fwd
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l2fwd
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst
index 6ca03f9..34a84f1 100644
--- a/doc/guides/sample_app_ug/l3_forward.rst
+++ b/doc/guides/sample_app_ug/l3_forward.rst
@@ -69,7 +69,8 @@ To compile the application:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l3fwd
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l3fwd
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst
index 39c2ea5..ac688f8 100644
--- a/doc/guides/sample_app_ug/l3_forward_power_man.rst
+++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst
@@ -111,7 +111,8 @@ To compile the application:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/l3fwd-power
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/l3fwd-power
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/load_balancer.rst b/doc/guides/sample_app_ug/load_balancer.rst
index 615826a..fdd8cbd 100644
--- a/doc/guides/sample_app_ug/load_balancer.rst
+++ b/doc/guides/sample_app_ug/load_balancer.rst
@@ -99,7 +99,8 @@ The sequence of steps used to build the application is:
 
     .. code-block:: console
 
-        cd ${RTE_SDK}/examples/load_balancer make
+        cd ${RTE_SDK}/examples/load_balancer
+        make
 
     For more details on how to build the DPDK libraries and sample applications,
     please refer to the *DPDK Getting Started Guide.*
diff --git a/doc/guides/sample_app_ug/qos_scheduler.rst b/doc/guides/sample_app_ug/qos_scheduler.rst
index ffa8ee2..7f9e925 100644
--- a/doc/guides/sample_app_ug/qos_scheduler.rst
+++ b/doc/guides/sample_app_ug/qos_scheduler.rst
@@ -64,7 +64,8 @@ To compile the application:
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/qos_sched
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/qos_sched
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/timer.rst b/doc/guides/sample_app_ug/timer.rst
index ee0a732..e4de359 100644
--- a/doc/guides/sample_app_ug/timer.rst
+++ b/doc/guides/sample_app_ug/timer.rst
@@ -41,7 +41,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/timer
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/timer
 
 #.  Set the target (a default target is used if not specified). For example:
 
diff --git a/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst b/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
index 6fb0f0b..9140a22 100644
--- a/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
+++ b/doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
@@ -93,7 +93,8 @@ Compiling the Application
 
     .. code-block:: console
 
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/vmdq_dcb
+        export RTE_SDK=/path/to/rte_sdk
+        cd ${RTE_SDK}/examples/vmdq_dcb
 
 #.  Set the target (a default target is used if not specified). For example:
 
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH v2] doc: fix repeated typo in sample app docs

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Monday, November 16, 2015 9:27 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v2] doc: fix repeated typo in sample app docs
> 
> Fix repeated typo in the "Compiling the Application" section of
> almost all of the sample app docs.
> 
> This generally gets copied into new sample app guides.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Re: [dpdk-dev] [PATCH v2] doc: fix repeated typo in sample app docs

[Thomas Monjalon]

> > Fix repeated typo in the "Compiling the Application" section of
> > almost all of the sample app docs.
> > 
> > This generally gets copied into new sample app guides.
> > 
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks