[dpdk-dev] (pkgtgen-dpdk) doc: Fix broken link to pktgen-dpdk documentation

Message ID 942AD08E4186F644A54168E4F84117C93166AC@SAUSMAILMBX1.ad.tri.sbc.com (mailing list archive)
State Not Applicable, archived
Headers

Checks

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

Commit Message

McCullough, Harrison June 23, 2017, 5:07 p.m. UTC
  The `setup.sh` script is now located in the `tools` subdirectory. In
addition, it is not an executable but is shown as if it was. It should
either be called with `bash`, run with `source`, or set to be an
executable.

Signed-off-by: Harrison McCullough <harrison_mccullough@labs.att.com>
---
 docs/source/getting_started.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
  

Comments

John McNamara June 26, 2017, 2:53 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of McCullough, Harrison
> Sent: Friday, June 23, 2017 6:07 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] (pkgtgen-dpdk) doc: Fix broken link to pktgen-
> dpdk documentation
> 
> The `setup.sh` script is now located in the `tools` subdirectory. In
> addition, it is not an executable but is shown as if it was. It should
> either be called with `bash`, run with `source`, or set to be an
> executable.
> 
> Signed-off-by: Harrison McCullough <harrison_mccullough@labs.att.com>

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

Patch

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
index 3869be1..5a0b6a3 100644
--- a/docs/source/getting_started.rst
+++ b/docs/source/getting_started.rst
@@ -186,19 +186,19 @@  Pktgen can then be built as follows::
 Setting up your environment
 ---------------------------
 
-In the ``PktgenInstallDir`` level directory there is ``setup.sh`` script,
+In the ``PktgenInstallDir/tools`` directory there is ``setup.sh`` script,
 which should be run once per boot. The script contains the commands required
 to set up the environment::
 
-   $ cd <PktgenInstallDir>
-   $ sudo ./setup.sh
+   $ cd <PktgenInstallDir>/tools
+   $ sudo bash setup.sh
 
 The setup script is a bash script and tries to configure the system to run a
 DPDK application. You will probably have to change the script to match your
 system.
 
 The ``modprobe uio`` command, in the setup script, loads the UIO support
-module into the kernel as well as loafing the igb-uio.ko module.
+module into the kernel as well as loading the igb-uio.ko module.
 
 The two echo commands, in the setup script, set up the huge pages for a two
 socket system. If you only have a single socket system then remove the second