[dpdk-dev] [PATCH 6/6] doc: add documention for windows
Anand Rawat
anand.rawat at intel.com
Fri Mar 1 08:18:47 CET 2019
Add documentation to build helloworld example
on windows using meson and clang.
Signed-off-by: Anand Rawat <anand.rawat at intel.com>
Signed-off-by: Kadam, Pallavi <pallavi.kadam at intel.com>
Reviewed-by: Jeffrey B Shaw <jeffrey.b.shaw at intel.com>
Reviewed-by: Ranjit Menon <ranjit.menon at intel.com>
---
doc/guides/index.rst | 1 +
doc/guides/windows_gsg/build_dpdk.rst | 76 +++++++++++++++++++++++++++
doc/guides/windows_gsg/index.rst | 14 +++++
doc/guides/windows_gsg/intro.rst | 20 +++++++
4 files changed, 111 insertions(+)
create mode 100644 doc/guides/windows_gsg/build_dpdk.rst
create mode 100644 doc/guides/windows_gsg/index.rst
create mode 100644 doc/guides/windows_gsg/intro.rst
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 8a9ed65c8..9dba6c80a 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -9,6 +9,7 @@ DPDK documentation
linux_gsg/index
freebsd_gsg/index
+ windows_gsg/index
sample_app_ug/index
prog_guide/index
howto/index
diff --git a/doc/guides/windows_gsg/build_dpdk.rst b/doc/guides/windows_gsg/build_dpdk.rst
new file mode 100644
index 000000000..fc5bd6c5c
--- /dev/null
+++ b/doc/guides/windows_gsg/build_dpdk.rst
@@ -0,0 +1,76 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2019 Intel Corporation.
+
+Compiling the DPDK Target from Source
+=====================================
+
+System Requirements
+-------------------
+
+The DPDK and its applications require the Clang-LLVM C compiler and linker.
+The Meson* Build system is used to prepare the sources
+for compilation with either of the Ninja or Visual Studio 2017 backends.
+
+\*Other names and brands may be claimed as the property of others.
+
+Install the Compiler
+--------------------
+
+Download and install the compiler from LLVM* website.
+
+Install the Build System
+------------------------
+
+Download and install the build system from Meson's website.
+
+Install the Backend
+-------------------
+
+If using Ninja, download and install the backend from Ninja's website.
+If using Visual Studio 2017, download and install the backend from Microsoft's website.
+
+Build the code
+--------------
+
+The build environment is setup to build the EAL and the helloworld example by
+default.
+
+Using the vs2017 backend
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Open a "Developer Command Prompt" and navigate to the DPDK source directory. If
+using the vs2017 backend, with a build directory named `build`, type the
+following commands.
+
+.. code-block:: console
+
+ cd C:\Users\me\dpdk
+ meson build --backend=vs2017
+ cd build
+ msbuild DPDK.sln
+
+Alternatively, the DPDK.sln file can be compiled with a supported IDE.
+
+Using the ninja backend
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: console
+
+ cd C:\Users\me\dpdk
+ meson build
+ cd build
+ ninja
+
+Run the helloworld example
+==========================
+
+Navigate to the build directory and run `helloworld.exe`.
+
+.. code-block:: console
+
+ cd C:\Users\me\dpdk\build
+ helloworld.exe
+ hello from core 1
+ hello from core 3
+ hello from core 0
+ hello from core 2
diff --git a/doc/guides/windows_gsg/index.rst b/doc/guides/windows_gsg/index.rst
new file mode 100644
index 000000000..87d7380b5
--- /dev/null
+++ b/doc/guides/windows_gsg/index.rst
@@ -0,0 +1,14 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2018 Intel Corporation.
+
+.. _windows_gsg:
+
+Getting Started Guide for Windows
+=================================
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ intro
+ build_dpdk
diff --git a/doc/guides/windows_gsg/intro.rst b/doc/guides/windows_gsg/intro.rst
new file mode 100644
index 000000000..a0285732d
--- /dev/null
+++ b/doc/guides/windows_gsg/intro.rst
@@ -0,0 +1,20 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2019 Intel Corporation.
+
+Introduction
+============
+
+This document contains instructions for installing and configuring the Data
+Plane Development Kit (DPDK) software. The document describes how to compile
+and run a DPDK application in a Windows* OS application environment, without
+going deeply into detail.
+
+\*Other names and brands may be claimed as the property of others.
+
+Limitations
+===========
+
+DPDK for Windows is currently a work in progress. Not all DPDK source files
+compile. Support is being added in pieces so as to limit the overall scope
+of any individual patch series. The goal is to be able to run any DPDK
+application natively on Windows.
--
2.17.1.windows.2
More information about the dev
mailing list