1*5cfaa3c3SBruce Richardson.. SPDX-License-Identifier: BSD-3-Clause 2*5cfaa3c3SBruce Richardson Copyright(c) 2010-2022 Intel Corporation. 3*5cfaa3c3SBruce Richardson 4*5cfaa3c3SBruce Richardson.. 5*5cfaa3c3SBruce Richardson NOTE: this file is common between BSD and Linux, so should be kept general 6*5cfaa3c3SBruce Richardson 7*5cfaa3c3SBruce RichardsonThe following is a list of DPDK documents in the suggested reading order: 8*5cfaa3c3SBruce Richardson 9*5cfaa3c3SBruce Richardson* :doc:`../rel_notes/index`: Provides release-specific information, including supported 10*5cfaa3c3SBruce Richardson features, limitations, fixed issues, known issues and so on. Also, provides the 11*5cfaa3c3SBruce Richardson answers to frequently asked questions in FAQ format. 12*5cfaa3c3SBruce Richardson 13*5cfaa3c3SBruce Richardson* :doc:`./index` (this document): Describes how to install and 14*5cfaa3c3SBruce Richardson configure the DPDK; designed to get users up and running quickly with the 15*5cfaa3c3SBruce Richardson software. 16*5cfaa3c3SBruce Richardson 17*5cfaa3c3SBruce Richardson* :doc:`../prog_guide/index`: Describes: 18*5cfaa3c3SBruce Richardson 19*5cfaa3c3SBruce Richardson * The software architecture and how to use it (through examples), 20*5cfaa3c3SBruce Richardson specifically in a Linux* application (linux) environment 21*5cfaa3c3SBruce Richardson 22*5cfaa3c3SBruce Richardson * The content of the DPDK, the build system (including the commands 23*5cfaa3c3SBruce Richardson that can be used to build the development kit and an application) 24*5cfaa3c3SBruce Richardson and guidelines for porting an application 25*5cfaa3c3SBruce Richardson 26*5cfaa3c3SBruce Richardson * Optimizations used in the software and those that should be considered 27*5cfaa3c3SBruce Richardson for new development 28*5cfaa3c3SBruce Richardson 29*5cfaa3c3SBruce Richardson A glossary of terms is also provided. 30*5cfaa3c3SBruce Richardson 31*5cfaa3c3SBruce Richardson* `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions, 32*5cfaa3c3SBruce Richardson data structures and other programming constructs. 33*5cfaa3c3SBruce Richardson 34*5cfaa3c3SBruce Richardson* :doc:`../sample_app_ug/index`: Describes a set of sample applications. 35*5cfaa3c3SBruce Richardson Each chapter describes a sample application that showcases specific functionality 36*5cfaa3c3SBruce Richardson and provides instructions on how to compile, run and use the sample application. 37*5cfaa3c3SBruce Richardson 38*5cfaa3c3SBruce Richardson* **Driver Reference Guides**: Provides details on each driver inside a particular category. 39*5cfaa3c3SBruce Richardson Separate guides exist for each of: 40*5cfaa3c3SBruce Richardson 41*5cfaa3c3SBruce Richardson * :doc:`../bbdevs/index` 42*5cfaa3c3SBruce Richardson 43*5cfaa3c3SBruce Richardson * :doc:`../compressdevs/index` 44*5cfaa3c3SBruce Richardson 45*5cfaa3c3SBruce Richardson * :doc:`../cryptodevs/index` 46*5cfaa3c3SBruce Richardson 47*5cfaa3c3SBruce Richardson * :doc:`../dmadevs/index` 48*5cfaa3c3SBruce Richardson 49*5cfaa3c3SBruce Richardson * :doc:`../eventdevs/index` 50*5cfaa3c3SBruce Richardson 51*5cfaa3c3SBruce Richardson * :doc:`../gpus/index` 52*5cfaa3c3SBruce Richardson 53*5cfaa3c3SBruce Richardson * :doc:`../mempool/index` 54*5cfaa3c3SBruce Richardson 55*5cfaa3c3SBruce Richardson * :doc:`../nics/index` 56*5cfaa3c3SBruce Richardson 57*5cfaa3c3SBruce Richardson * :doc:`../rawdevs/index` 58*5cfaa3c3SBruce Richardson 59*5cfaa3c3SBruce Richardson * :doc:`../regexdevs/index` 60*5cfaa3c3SBruce Richardson 61*5cfaa3c3SBruce Richardson * :doc:`../vdpadevs/index` 62