doc: add guide for Windows
Added documentation to build helloworld example on Windows using meson and clang. 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> Tested-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com> Acked-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com>
This commit is contained in:
parent
fa647c5722
commit
196c650b8b
@ -291,6 +291,7 @@ M: Ranjit Menon <ranjit.menon@intel.com>
|
||||
F: kernel/windows/
|
||||
F: lib/librte_eal/windows/
|
||||
F: lib/librte_eal/rte_eal_exports.def
|
||||
F: doc/guides/windows_gsg/
|
||||
|
||||
|
||||
Core Libraries
|
||||
|
@ -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
|
||||
|
81
doc/guides/windows_gsg/build_dpdk.rst
Normal file
81
doc/guides/windows_gsg/build_dpdk.rst
Normal file
@ -0,0 +1,81 @@
|
||||
.. 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 Microsoft MSVC linker.
|
||||
The Meson Build system is used to prepare the sources for compilation
|
||||
with the Ninja backend.
|
||||
The installation of these tools is covered in this section.
|
||||
|
||||
|
||||
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
|
14
doc/guides/windows_gsg/index.rst
Normal file
14
doc/guides/windows_gsg/index.rst
Normal file
@ -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
|
20
doc/guides/windows_gsg/intro.rst
Normal file
20
doc/guides/windows_gsg/intro.rst
Normal file
@ -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.
|
Loading…
x
Reference in New Issue
Block a user