doc: fix helloworld build on Windows

Message ID 20190520081952.1046496-1-adham@mellanox.com (mailing list archive)
State Accepted, archived
Headers
Series doc: fix helloworld build on Windows |

Checks

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

Commit Message

adham@mellanox.com May 20, 2019, 8:19 a.m. UTC
  From: Adham Masarwah <adham@mellanox.com>

The option -Dexamples=helloworld is missing.
The helloworld binary name was wrong.
Forcing clang may be required in some environments.

Fixes: 196c650b8b63 ("doc: add guide for Windows")

Signed-off-by: Adham Masarwah <adham@mellanox.com>
---
 doc/guides/windows_gsg/build_dpdk.rst | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)
  

Comments

Bruce Richardson May 20, 2019, 9:04 a.m. UTC | #1
On Mon, May 20, 2019 at 11:19:52AM +0300, adham@mellanox.com wrote:
> From: Adham Masarwah <adham@mellanox.com>
> 
> The option -Dexamples=helloworld is missing.
> The helloworld binary name was wrong.
> Forcing clang may be required in some environments.
> 
> Fixes: 196c650b8b63 ("doc: add guide for Windows")
> 
> Signed-off-by: Adham Masarwah <adham@mellanox.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
Thomas Monjalon May 29, 2019, 10:55 a.m. UTC | #2
20/05/2019 11:04, Bruce Richardson:
> On Mon, May 20, 2019 at 11:19:52AM +0300, adham@mellanox.com wrote:
> > From: Adham Masarwah <adham@mellanox.com>
> > 
> > The option -Dexamples=helloworld is missing.
> > The helloworld binary name was wrong.
> > Forcing clang may be required in some environments.
> > 
> > Fixes: 196c650b8b63 ("doc: add guide for Windows")
> > 
> > Signed-off-by: Adham Masarwah <adham@mellanox.com>
> > ---
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/windows_gsg/build_dpdk.rst b/doc/guides/windows_gsg/build_dpdk.rst
index f48805236..6711e07e2 100644
--- a/doc/guides/windows_gsg/build_dpdk.rst
+++ b/doc/guides/windows_gsg/build_dpdk.rst
@@ -59,22 +59,30 @@  default.
 Using the ninja backend
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
+Specifying the compiler might be required to complete the meson command.
+
+.. code-block:: console
+
+    set CC=clang
+
+To compile the examples, the flag ``-Dexamples`` is required.
+
 .. code-block:: console
 
     cd C:\Users\me\dpdk
-    meson build
+    meson -Dexamples=helloworld build
     cd build
     ninja
 
 Run the helloworld example
 ==========================
 
-Navigate to the build directory and run `dpdk-helloworld.exe`.
+Navigate to the examples in the build directory and run `dpdk-helloworld.exe`.
 
 .. code-block:: console
 
-    cd C:\Users\me\dpdk\build
-    helloworld.exe
+    cd C:\Users\me\dpdk\build\examples
+    dpdk-helloworld.exe
     hello from core 1
     hello from core 3
     hello from core 0