doc/guides/linux_gsg/intro.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2010-2014 Intel Corporation.
   3
   4 Introduction
   5 ============
   6
   7 This document contains instructions for installing and configuring the Data Plane Development Kit (DPDK) software.
   8 It is designed to get customers up and running quickly.
   9 The document describes how to compile and run a DPDK application in a Linux application (linux) environment,
  10 without going deeply into detail.
  11
  12 Documentation Roadmap
  13 ---------------------
  14
  15 The following is a list of DPDK documents in the suggested reading order:
  16
  17 *   Release Notes: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on.
  18     Also, provides the answers to frequently asked questions in FAQ format.
  19
  20 *   Getting Started Guide (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software.
  21
  22 *   Programmer's Guide: Describes:
  23
  24     *   The software architecture and how to use it (through examples), specifically in a Linux application (linux) environment
  25
  26     *   The content of the DPDK, the build system (including the commands that can be used to build the development kit and
  27         an application) and guidelines for porting an application
  28
  29     *   Optimizations used in the software and those that should be considered for new development
  30
  31     A glossary of terms is also provided.
  32
  33 *   API Reference: Provides detailed information about DPDK functions, data structures and other programming constructs.
  34
  35 *   Sample Applications User Guide: Describes a set of sample applications.
  36     Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application.