15630257fSFerruh Yigit.. SPDX-License-Identifier: BSD-3-Clause 25630257fSFerruh Yigit Copyright(c) 2010-2014 Intel Corporation. 3fc1f2750SBernard Iremonger 4fc1f2750SBernard IremongerIntroduction 5fc1f2750SBernard Iremonger============ 6fc1f2750SBernard Iremonger 7fc1f2750SBernard IremongerThis document provides software architecture information, 8fc1f2750SBernard Iremongerdevelopment environment information and optimization guidelines. 9fc1f2750SBernard Iremonger 10fc1f2750SBernard IremongerFor programming examples and for instructions on compiling and running each sample application, 1148624fd9SSiobhan Butlersee the *DPDK Sample Applications User Guide* for details. 12fc1f2750SBernard Iremonger 1348624fd9SSiobhan ButlerFor general information on compiling and running applications, see the *DPDK Getting Started Guide*. 14fc1f2750SBernard Iremonger 15fc1f2750SBernard IremongerDocumentation Roadmap 16fc1f2750SBernard Iremonger--------------------- 17fc1f2750SBernard Iremonger 1848624fd9SSiobhan ButlerThe following is a list of DPDK documents in the suggested reading order: 19fc1f2750SBernard Iremonger 20707be598SBaruch Siach* **Release Notes** : Provides release-specific information, including supported features, 21fc1f2750SBernard Iremonger limitations, fixed issues, known issues and so on. 22fc1f2750SBernard Iremonger Also, provides the answers to frequently asked questions in FAQ format. 23fc1f2750SBernard Iremonger 2448624fd9SSiobhan Butler* **Getting Started Guide** : Describes how to install and configure the DPDK software; 25fc1f2750SBernard Iremonger designed to get users up and running quickly with the software. 26fc1f2750SBernard Iremonger 2748624fd9SSiobhan Butler* **FreeBSD* Getting Started Guide** : A document describing the use of the DPDK with FreeBSD* 2848624fd9SSiobhan Butler has been added in DPDK Release 1.6.0. 2948624fd9SSiobhan Butler Refer to this guide for installation and configuration instructions to get started using the DPDK with FreeBSD*. 30fc1f2750SBernard Iremonger 31fc1f2750SBernard Iremonger* **Programmer's Guide** (this document): Describes: 32fc1f2750SBernard Iremonger 33fc1f2750SBernard Iremonger * The software architecture and how to use it (through examples), 34218c4e68SBruce Richardson specifically in a Linux* application (linux) environment 35fc1f2750SBernard Iremonger 3648624fd9SSiobhan Butler * The content of the DPDK, the build system 37*3cc6ecfdSCiara Power (including the commands that can be used in the root DPDK to build the development kit and an application) 38fc1f2750SBernard Iremonger and guidelines for porting an application 39fc1f2750SBernard Iremonger 40fc1f2750SBernard Iremonger * Optimizations used in the software and those that should be considered for new development 41fc1f2750SBernard Iremonger 42fc1f2750SBernard Iremonger A glossary of terms is also provided. 43fc1f2750SBernard Iremonger 4448624fd9SSiobhan Butler* **API Reference** : Provides detailed information about DPDK functions, 45fc1f2750SBernard Iremonger data structures and other programming constructs. 46fc1f2750SBernard Iremonger 47fc1f2750SBernard Iremonger* **Sample Applications User Guide**: Describes a set of sample applications. 48fc1f2750SBernard Iremonger Each chapter describes a sample application that showcases specific functionality 49fc1f2750SBernard Iremonger and provides instructions on how to compile, run and use the sample application. 50fc1f2750SBernard Iremonger 51fc1f2750SBernard IremongerRelated Publications 52fc1f2750SBernard Iremonger-------------------- 53fc1f2750SBernard Iremonger 5448624fd9SSiobhan ButlerThe following documents provide information that is relevant to the development of applications using the DPDK: 55fc1f2750SBernard Iremonger 56fc1f2750SBernard Iremonger* Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3A: System Programming Guide 57