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