cmhi
/
f-stack
mirror of https://github.com/F-Stack/f-stack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
f-stack/dpdk/doc/guides/prog_guide/intro.rst

57 lines
2.4 KiB
ReStructuredText
Raw Normal View History

Reupgrade DPDK to 18.11.
2019-06-25 11:12:58 +00:00
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2014 Intel Corporation.
init
2017-04-21 10:43:26 +00:00
Introduction
============
This document provides software architecture information,
development environment information and optimization guidelines.
For programming examples and for instructions on compiling and running each sample application,
see the *DPDK Sample Applications User Guide* for details.
For general information on compiling and running applications, see the *DPDK Getting Started Guide*.
Documentation Roadmap
---------------------
The following is a list of DPDK documents in the suggested reading order:
DPDK: upgrade to 17.11.2 LTS. Changes: 1. This version is downloaded from https://fast.dpdk.org/rel/dpdk-17.11.2.tar.xz. 2. Adapt the new interface `rte_ring_dequeue_burst`. 3. Change the type of `port_id` from uint8_t to uint16_t. 4. Just link libdpdk.a instead of the other libaries. 5. Install libnuma-dev first. 6. Update the documents.
2018-05-15 09:49:22 +00:00
* **Release Notes** : Provides release-specific information, including supported features,
init
2017-04-21 10:43:26 +00:00
limitations, fixed issues, known issues and so on.
Also, provides the answers to frequently asked questions in FAQ format.
* **Getting Started Guide** : Describes how to install and configure the DPDK software;
designed to get users up and running quickly with the software.
* **FreeBSD* Getting Started Guide** : A document describing the use of the DPDK with FreeBSD*
has been added in DPDK Release 1.6.0.
Refer to this guide for installation and configuration instructions to get started using the DPDK with FreeBSD*.
* **Programmer's Guide** (this document): Describes:
* The software architecture and how to use it (through examples),
DPDK: upgrade to DPDK 19.11.2(LTS).
2020-06-18 16:55:50 +00:00
specifically in a Linux* application (linux) environment
init
2017-04-21 10:43:26 +00:00
* The content of the DPDK, the build system
DPDK: upgrade to DPDK 20.11.0(LTS).
2021-02-05 08:48:47 +00:00
(including the commands that can be used in the root DPDK to build the development kit and an application)
init
2017-04-21 10:43:26 +00:00
and guidelines for porting an application
* Optimizations used in the software and those that should be considered for new development
A glossary of terms is also provided.
* **API Reference** : Provides detailed information about DPDK functions,
data structures and other programming constructs.
* **Sample Applications User Guide**: Describes a set of sample applications.
Each chapter describes a sample application that showcases specific functionality
and provides instructions on how to compile, run and use the sample application.
Related Publications
--------------------
The following documents provide information that is relevant to the development of applications using the DPDK:
* Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3A: System Programming Guide