Acked-by: Harini Ramakrishnan <harini.ramakrish...@microsoft.com>
-----Original Message-----
From: dev <dev-boun...@dpdk.org> On Behalf Of Anand Rawat
Sent: Wednesday, March 27, 2019 7:21 PM
To: dev@dpdk.org
Cc: anand.ra...@intel.com; pallavi.ka...@intel.com; ranjit.me...@intel.com;
jeffrey.b.s...@intel.com; bruce.richard...@intel.com; tho...@monjalon.net
Subject: [dpdk-dev] [PATCH v6 7/8] doc: add documentation for windows
Added documentation to build helloworld example on windows using meson and
clang. Updated the maintainers list to include windows maintainers.
Signed-off-by: Pallavi Kadam <pallavi.ka...@intel.com>
Signed-off-by: Anand Rawat <anand.ra...@intel.com>
Reviewed-by: Jeff Shaw <jeffrey.b.s...@intel.com>
Reviewed-by: Ranjit Menon <ranjit.me...@intel.com>
---
MAINTAINERS | 7 +++
doc/guides/index.rst | 3 +-
doc/guides/windows_gsg/build_dpdk.rst | 73 +++++++++++++++++++++++++++
doc/guides/windows_gsg/index.rst | 14 +++++
doc/guides/windows_gsg/intro.rst | 20 ++++++++
5 files changed, 116 insertions(+), 1 deletion(-) 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/MAINTAINERS b/MAINTAINERS
index 21e164095..d64d7ceb8 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -278,6 +278,13 @@ FreeBSD UIO
M: Bruce Richardson <bruce.richard...@intel.com>
F: kernel/freebsd/nic_uio/
+Windows support
+M: Harini Ramakrishnan <harini.ramakrish...@microsoft.com>
+M: Omar Cardona <ocard...@microsoft.com>
+M: Anand Rawat <anand.ra...@intel.com>
+M: Ranjit Menon <ranjit.me...@intel.com>
+F: lib/librte_eal/windows/
+
Core Libraries
--------------
diff --git a/doc/guides/index.rst b/doc/guides/index.rst index
8a9ed65c8..8a1601b27 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -1,5 +1,5 @@
.. SPDX-License-Identifier: BSD-3-Clause
- Copyright(c) 2010-2014 Intel Corporation.
+ Copyright(c) 2010-2019 Intel Corporation.
DPDK documentation
==================
@@ -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..b88eb76c9
--- /dev/null
+++ b/doc/guides/windows_gsg/build_dpdk.rst
@@ -0,0 +1,73 @@
+.. 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 MSVC*
linker.
+The Meson* Build system is used to prepare the sources for compilation with
the Ninja backend.
+
+\*Other names and brands may be claimed as the property of others.
+
+Install the Compiler
+--------------------
+
+Download and install the clang compiler from `LLVM* website
<https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Freleases.llvm.org%2Fdownload.html&data=02%7C01%7CHarini.Ramakrishnan%40microsoft.com%7Ce4ffece3a667422d599008d6b3243c0a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636893365548294922&sdata=U66vvhVzKJkL1XHkKpdrqDwLC8l307lcrmhrS9Y5vsw%3D&reserved=0>`_.
+For example, Clang-LLVM direct download link::
+
+
+https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Freleas
+es.llvm.org%2F7.0.1%2FLLVM-7.0.1-win64.exe&data=02%7C01%7CHarini.Ra
+makrishnan%40microsoft.com%7Ce4ffece3a667422d599008d6b3243c0a%7C72f988b
+f86f141af91ab2d7cd011db47%7C1%7C0%7C636893365548294922&sdata=5v%2Bd
+Ne6R%2Fx%2FvDjPvTZdTnwb4ic6aHpyU%2Fg4404wfa3M%3D&reserved=0
+
+
+Install the Linker
+------------------
+
+Download and install the Build Tools for Visual Studio to link and build the
files on windows, from `Microsoft* website
<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fvisualstudio.microsoft.com%2Fdownloads&data=02%7C01%7CHarini.Ramakrishnan%40microsoft.com%7Ce4ffece3a667422d599008d6b3243c0a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636893365548294922&sdata=hFZZLZtJ6hPg25SLgHn2HHCV9iRwmzCIseYbsKALgOE%3D&reserved=0>`_.
+When installing build tools, select the "Visual C++ build tools" option and
ensure the Windows SDK is selected.
+
+
+Install the Build System
+------------------------
+
+Download and install the build system from `Meson* website
<https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmesonbuild.com%2FGetting-meson.html&data=02%7C01%7CHarini.Ramakrishnan%40microsoft.com%7Ce4ffece3a667422d599008d6b3243c0a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636893365548294922&sdata=x40rheD8e7%2FXeniX9uDNLeiR%2FYvGAiN3uMTe0ogkVi0%3D&reserved=0>`_.
+A good option to choose is the MSI installer for both meson and ninja
together::
+
+
+https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmesonb
+uild.com%2FGetting-meson.html%23installing-meson-and-ninja-with-the-msi
+-installer%2522&data=02%7C01%7CHarini.Ramakrishnan%40microsoft.com%
+7Ce4ffece3a667422d599008d6b3243c0a%7C72f988bf86f141af91ab2d7cd011db47%7
+C1%7C0%7C636893365548294922&sdata=s%2Bth54SiyuA74wD7YQdPVjD3q92HJZS
+DO7SbOPJX4ow%3D&reserved=0
+
+Install the Backend
+-------------------
+
+If using Ninja, download and install the backend from `Ninja* website
+<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fninja-build.org%2F&data=02%7C01%7CHarini.Ramakrishnan%40microsoft.com%7Ce4ffece3a667422d599008d6b3243c0a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636893365548294922&sdata=VtGH%2BqKrthIWbfkseM%2BrSTK88JPE%2BASfxXkVEHUToA8%3D&reserved=0>`_
or install along with the meson build system.
+
+Build the code
+--------------
+
+The build environment is setup to build the EAL and the helloworld
+example by default.
+
+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 `dpdk-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..d9b7990a8
--- /dev/null
+++ b/doc/guides/windows_gsg/index.rst
@@ -0,0 +1,14 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2019 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
