All of lore.kernel.org
 help / color / mirror / Atom feed
From: Anand Rawat <anand.rawat@intel.com>
To: dev@dpdk.org
Cc: anand.rawat@intel.com, pallavi.kadam@intel.com,
	ranjit.menon@intel.com, jeffrey.b.shaw@intel.com,
	bruce.richardson@intel.com, thomas@monjalon.net
Subject: [PATCH v6 7/8] doc: add documentation for windows
Date: Wed, 27 Mar 2019 19:21:14 -0700	[thread overview]
Message-ID: <20190328022115.4660-8-anand.rawat@intel.com> (raw)
In-Reply-To: <20190328022115.4660-1-anand.rawat@intel.com>

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.kadam@intel.com>
Signed-off-by: Anand Rawat <anand.rawat@intel.com>
Reviewed-by: Jeff Shaw <jeffrey.b.shaw@intel.com>
Reviewed-by: Ranjit Menon <ranjit.menon@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.richardson@intel.com>
 F: kernel/freebsd/nic_uio/
 
+Windows support
+M: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com>
+M: Omar Cardona <ocardona@microsoft.com>
+M: Anand Rawat <anand.rawat@intel.com>
+M: Ranjit Menon <ranjit.menon@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 <http://releases.llvm.org/download.html>`_.
+For example, Clang-LLVM direct download link::
+
+	http://releases.llvm.org/7.0.1/LLVM-7.0.1-win64.exe
+
+
+Install the Linker
+------------------
+
+Download and install the Build Tools for Visual Studio to link and build the files on windows, from `Microsoft* website <https://visualstudio.microsoft.com/downloads>`_.
+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 <http://mesonbuild.com/Getting-meson.html>`_.
+A good option to choose is the MSI installer for both meson and ninja together::
+
+	http://mesonbuild.com/Getting-meson.html#installing-meson-and-ninja-with-the-msi-installer%22
+
+Install the Backend
+-------------------
+
+If using Ninja, download and install the backend from `Ninja* website <https://ninja-build.org/>`_ 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

  parent reply	other threads:[~2019-03-28  2:21 UTC|newest]

Thread overview: 178+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-06  4:16 [PATCH v2 0/6] HelloWorld example for windows Anand Rawat
2019-03-06  4:16 ` [PATCH v2 1/6] eal: eal stub to add windows support Anand Rawat
2019-03-06 10:03   ` Thomas Monjalon
2019-03-06 11:20     ` Bruce Richardson
2019-03-06 11:36       ` Thomas Monjalon
2019-03-06 11:52         ` Richardson, Bruce
2019-03-07  1:04           ` Anand Rawat
2019-03-07  8:59             ` Thomas Monjalon
2019-03-07  1:19       ` Anand Rawat
2019-03-06  4:16 ` [PATCH v2 2/6] eal: add header files to support windows Anand Rawat
2019-03-06 11:31   ` Thomas Monjalon
2019-03-07  3:27     ` Anand Rawat
2019-03-07  8:45       ` Thomas Monjalon
2019-03-07 10:24         ` Bruce Richardson
2019-03-07 11:33           ` Thomas Monjalon
2019-03-07 11:53             ` Richardson, Bruce
2019-03-06  4:16 ` [PATCH v2 3/6] eal: add headers for compatibility with windows environment Anand Rawat
2019-03-06  4:16 ` [PATCH v2 4/6] eal: add minimum viable code for eal on windows Anand Rawat
2019-03-06  4:16 ` [PATCH v2 5/6] examples: add meson changes for windows Anand Rawat
2019-03-06  4:16 ` [PATCH v2 6/6] doc: add documention " Anand Rawat
2019-03-07 17:03   ` Kovacevic, Marko
2019-03-07 18:46     ` Anand Rawat
2019-03-11 12:45   ` Jerin Jacob Kollanukkaran
2019-03-11 13:51     ` Richardson, Bruce
2019-03-11 15:30       ` Raslan Darawsheh
2019-03-11 15:46       ` Jerin Jacob Kollanukkaran
2019-03-14  0:04     ` Anand Rawat
2019-03-06  8:29 ` [PATCH v2 0/6] HelloWorld example " Thomas Monjalon
2019-03-06 22:45   ` Anand Rawat
2019-03-06 23:03     ` Thomas Monjalon
2019-03-20  0:40 ` [PATCH v3 0/8] " Anand Rawat
2019-03-20  0:40   ` [PATCH v3 1/8] eal: eal stub to add windows support Anand Rawat
2019-03-20  0:40   ` [PATCH v3 2/8] eal: add header files to support windows Anand Rawat
2019-03-20  0:40   ` [PATCH v3 3/8] kvargs: adding a module definition file Anand Rawat
2019-03-20  0:40   ` [PATCH v3 4/8] eal: sys/queue.h implementation for windows Anand Rawat
2019-03-20  0:40   ` [PATCH v3 5/8] eal: add headers for compatibility with windows environment Anand Rawat
2019-03-20  0:40   ` [PATCH v3 6/8] eal: add minimum viable code for eal on windows Anand Rawat
2019-03-20  0:40   ` [PATCH v3 7/8] doc: add documention for windows Anand Rawat
2019-03-20  0:40   ` [PATCH v3 8/8] build: meson changes to build on windows Anand Rawat
2019-03-22 22:54 ` [PATCH v4 0/8] HelloWorld example for windows Anand Rawat
2019-03-22 22:54   ` [PATCH v4 1/8] eal: eal stub to add windows support Anand Rawat
2019-03-22 22:54   ` [PATCH v4 2/8] eal: add header files to support windows Anand Rawat
2019-03-22 22:55   ` [PATCH v4 3/8] kvargs: adding a module definition file Anand Rawat
2019-03-22 22:55   ` [PATCH v4 4/8] eal: sys/queue.h implementation for windows Anand Rawat
2019-03-22 22:55   ` [PATCH v4 5/8] eal: add headers for compatibility with windows environment Anand Rawat
2019-03-22 22:55   ` [PATCH v4 6/8] eal: add minimum viable code for eal on windows Anand Rawat
2019-03-22 22:55   ` [PATCH v4 7/8] doc: add documention for windows Anand Rawat
2019-03-23 16:51     ` Jerin Jacob Kollanukkaran
2019-03-25 10:24       ` Bruce Richardson
2019-03-25 17:43         ` Pallavi Kadam
2019-03-22 22:55   ` [PATCH v4 8/8] build: meson changes to build on windows Anand Rawat
2019-03-25 10:32     ` Bruce Richardson
2019-03-25 18:47   ` [PATCH v4 0/8] HelloWorld example for windows Harini Ramakrishnan
2019-03-26  6:02 ` [PATCH v5 " Anand Rawat
2019-03-26  6:02   ` [PATCH v5 1/8] eal: eal stub to add windows support Anand Rawat
2019-03-26 16:29     ` Harini Ramakrishnan
     [not found]     ` <MWHPR21MB0638113CDE9F61F8EC3E63D0EF5F0@MWHPR21MB0638.namprd21.prod.outlook.com>
2019-03-26 22:50       ` Omar Cardona
2019-03-26  6:02   ` [PATCH v5 2/8] eal: add header files to support windows Anand Rawat
2019-03-26 10:20     ` Jerin Jacob Kollanukkaran
2019-03-27 21:23       ` Ranjit Menon
2019-03-27 22:29         ` Thomas Monjalon
2019-03-27 23:10           ` Anand Rawat
2019-03-27 23:27             ` Thomas Monjalon
2019-03-26 16:30     ` Harini Ramakrishnan
2019-03-26  6:02   ` [PATCH v5 3/8] kvargs: adding a module definition file Anand Rawat
2019-03-26 10:32     ` Jerin Jacob Kollanukkaran
2019-03-26 10:58       ` Bruce Richardson
2019-03-26 13:37         ` [EXT] " Jerin Jacob Kollanukkaran
2019-03-26 13:55           ` Thomas Monjalon
2019-03-26 14:41             ` Bruce Richardson
2019-03-26 15:07               ` Thomas Monjalon
2019-03-26 15:17                 ` Bruce Richardson
2019-03-26 15:22                   ` Thomas Monjalon
2019-03-26 14:40           ` Bruce Richardson
2019-03-26 15:35             ` Jerin Jacob Kollanukkaran
2019-03-26 16:46               ` Bruce Richardson
2019-03-26 23:13                 ` Anand Rawat
2019-03-26 16:31     ` Harini Ramakrishnan
2019-03-26 19:02     ` Stephen Hemminger
2019-03-26  6:02   ` [PATCH v5 4/8] eal: sys/queue.h implementation for windows Anand Rawat
2019-03-26 16:31     ` Harini Ramakrishnan
2019-03-26 19:06     ` Stephen Hemminger
2019-03-26 20:52       ` Thomas Monjalon
2019-03-26 21:14         ` Jeff Shaw
2019-03-26 21:47           ` Thomas Monjalon
2019-03-26 21:54             ` Jeff Shaw
2019-03-26 22:23               ` Thomas Monjalon
2019-03-26 22:34                 ` Jeff Shaw
2019-03-26 23:00                   ` Thomas Monjalon
2019-03-26 23:43                     ` Jeff Shaw
2019-03-26 23:54                       ` Thomas Monjalon
2019-03-27 21:16       ` Anand Rawat
2019-03-26  6:02   ` [PATCH v5 5/8] eal: add headers for compatibility with windows environment Anand Rawat
2019-03-26 16:33     ` Harini Ramakrishnan
2019-03-26  6:02   ` [PATCH v5 6/8] eal: add minimum viable code for eal on windows Anand Rawat
2019-03-26 16:32     ` Harini Ramakrishnan
2019-03-26  6:02   ` [PATCH v5 7/8] doc: add documention for windows Anand Rawat
2019-03-26 10:27     ` Jerin Jacob Kollanukkaran
2019-03-26 10:37     ` David Marchand
2019-03-26 18:29       ` Anand Rawat
2019-03-26 16:33     ` Harini Ramakrishnan
2019-03-26  6:02   ` [PATCH v5 8/8] build: meson changes to build on windows Anand Rawat
2019-03-26 16:34     ` Harini Ramakrishnan
2019-03-26 16:28   ` [PATCH v5 0/8] HelloWorld example for windows Harini Ramakrishnan
     [not found]   ` <MWHPR21MB06380D6FA7CF5513DDC3820AEF5F0@MWHPR21MB0638.namprd21.prod.outlook.com>
2019-03-26 22:43     ` Omar Cardona
2019-03-28  2:21 ` [PATCH v6 " Anand Rawat
2019-03-28  2:21   ` [PATCH v6 1/8] eal: eal stub to add windows support Anand Rawat
2019-03-28 19:27     ` Harini Ramakrishnan
2019-03-28  2:21   ` [PATCH v6 2/8] eal: add header files to support os specifics Anand Rawat
2019-03-28 19:27     ` Harini Ramakrishnan
2019-03-28  2:21   ` [PATCH v6 3/8] build: add module definition file for windows Anand Rawat
2019-03-28 19:29     ` Harini Ramakrishnan
2019-03-28  2:21   ` [PATCH v6 4/8] eal: sys/queue.h implementation " Anand Rawat
2019-03-28  2:30     ` Varghese, Vipin
2019-03-28  2:39       ` Anand Rawat
2019-03-28  3:29         ` Varghese, Vipin
2019-03-28 19:30     ` Harini Ramakrishnan
2019-03-28  2:21   ` [PATCH v6 5/8] eal: add headers for compatibility with windows Anand Rawat
2019-03-28 19:29     ` Harini Ramakrishnan
2019-03-28  2:21   ` [PATCH v6 6/8] eal: add minimum viable code for eal on windows Anand Rawat
2019-03-28 19:32     ` Harini Ramakrishnan
2019-03-28  2:21   ` Anand Rawat [this message]
2019-03-28 19:31     ` [PATCH v6 7/8] doc: add documentation for windows Harini Ramakrishnan
2019-03-28  2:21   ` [PATCH v6 8/8] build: meson changes to build on windows Anand Rawat
2019-03-28 15:10     ` Thomas Monjalon
2019-03-28 19:30     ` Harini Ramakrishnan
2019-03-28 19:28   ` [PATCH v6 0/8] HelloWorld example for windows Harini Ramakrishnan
2019-03-28 23:24 ` [PATCH v7 " Anand Rawat
2019-03-28 23:24   ` [PATCH v7 1/8] eal: eal stub to add windows support Anand Rawat
2019-04-01 16:17     ` Bruce Richardson
2019-04-01 16:34     ` Bruce Richardson
2019-04-01 17:06       ` Anand Rawat
2019-04-01 20:10         ` Bruce Richardson
2019-03-28 23:24   ` [PATCH v7 2/8] eal: add header files to support os specifics Anand Rawat
2019-04-01 23:09     ` Thomas Monjalon
2019-04-02  3:52       ` Anand Rawat
2019-03-28 23:24   ` [PATCH v7 3/8] build: add module definition file for windows Anand Rawat
2019-03-28 23:24   ` [PATCH v7 4/8] eal: sys/queue.h implementation " Anand Rawat
2019-03-28 23:24   ` [PATCH v7 5/8] eal: add headers for compatibility with windows Anand Rawat
2019-03-28 23:24   ` [PATCH v7 6/8] eal: add minimum viable code for eal on windows Anand Rawat
2019-03-28 23:24   ` [PATCH v7 7/8] doc: add documentation for windows Anand Rawat
2019-03-29  0:06     ` Harini Ramakrishnan
2019-04-01 23:22     ` Thomas Monjalon
2019-04-02  1:01       ` Pallavi Kadam
2019-04-02  7:15         ` Thomas Monjalon
2019-03-28 23:24   ` [PATCH v7 8/8] build: meson changes to build on windows Anand Rawat
2019-04-01 23:25     ` Thomas Monjalon
2019-04-02  3:47       ` Anand Rawat
2019-03-29  0:12   ` [PATCH v7 0/8] HelloWorld example for windows Harini Ramakrishnan
2019-04-02  3:54 ` [PATCH v8 00/10] HelloWorld example for Windows Anand Rawat
2019-04-02  3:54   ` [PATCH v8 01/10] eal: eal stub to add windows support Anand Rawat
2019-04-02  3:54   ` [PATCH v8 02/10] meson: required changes for windows Anand Rawat
2019-04-02 23:04     ` Thomas Monjalon
2019-04-02 23:23       ` Pallavi Kadam
2019-04-02  3:54   ` [PATCH v8 03/10] eal: add new rte_os.h header to build system Anand Rawat
2019-04-02 19:56     ` Thomas Monjalon
2019-04-02 20:47       ` Thomas Monjalon
2019-04-02 22:11         ` Anand Rawat
2019-04-02 22:32           ` Thomas Monjalon
2019-04-02 22:34             ` Anand Rawat
2019-04-02  3:54   ` [PATCH v8 04/10] eal: update common headers to use rte_os.h Anand Rawat
2019-04-02  3:54   ` [PATCH v8 05/10] build: add module definition file for windows Anand Rawat
2019-04-02 23:03     ` Thomas Monjalon
2019-04-02  3:54   ` [PATCH v8 06/10] eal: sys/queue.h implementation " Anand Rawat
2019-04-02  3:54   ` [PATCH v8 07/10] eal: add headers for compatibility with windows Anand Rawat
2019-04-02  3:54   ` [PATCH v8 08/10] eal: add minimum viable code for eal on windows Anand Rawat
2019-04-02 20:06     ` Thomas Monjalon
2019-04-02 21:21       ` Pallavi Kadam
2019-04-02 21:38         ` Thomas Monjalon
2019-04-02 21:46           ` Pallavi Kadam
2019-04-02 22:39     ` Thomas Monjalon
2019-04-02 22:57       ` Anand Rawat
2019-04-02  3:54   ` [PATCH v8 09/10] doc: add documentation for windows Anand Rawat
2019-04-02  3:54   ` [PATCH v8 10/10] build: meson changes to build on windows Anand Rawat
2019-04-02 22:51     ` Thomas Monjalon
2019-04-02 23:01       ` Anand Rawat
2019-04-02 23:25   ` [PATCH v8 00/10] HelloWorld example for Windows Thomas Monjalon
2019-04-02 23:49     ` Anand Rawat

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190328022115.4660-8-anand.rawat@intel.com \
    --to=anand.rawat@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=jeffrey.b.shaw@intel.com \
    --cc=pallavi.kadam@intel.com \
    --cc=ranjit.menon@intel.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.