doc/guides/prog_guide/intro.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2010-2014 Intel Corporation.
   3
   4 Introduction
   5 ============
   6
   7 This document provides software architecture information,
   8 development environment information and optimization guidelines.
   9
  10 For programming examples and for instructions on compiling and running each sample application,
  11 see the *DPDK Sample Applications User Guide* for details.
  12
  13 For general information on compiling and running applications, see the *DPDK Getting Started Guide*.
  14
  15 Documentation Roadmap
  16 ---------------------
  17
  18 The following is a list of DPDK documents in the suggested reading order:
  19
  20 *   **Release Notes** : Provides release-specific information, including supported features,
  21     limitations, fixed issues, known issues and so on.
  22     Also, provides the answers to frequently asked questions in FAQ format.
  23
  24 *   **Getting Started Guide** : Describes how to install and configure the DPDK software;
  25     designed to get users up and running quickly with the software.
  26
  27 *   **FreeBSD* Getting Started Guide** : A document describing the use of the DPDK with FreeBSD*
  28     has been added in DPDK Release 1.6.0.
  29     Refer to this guide for installation and configuration instructions to get started using the DPDK with FreeBSD*.
  30
  31 *   **Programmer's Guide** (this document): Describes:
  32
  33     *   The software architecture and how to use it (through examples),
  34         specifically in a Linux* application (linux) environment
  35
  36     *   The content of the DPDK, the build system
  37         (including the commands that can be used in the root DPDK to build the development kit and an application)
  38         and guidelines for porting an application
  39
  40     *   Optimizations used in the software and those that should be considered for new development
  41
  42     A glossary of terms is also provided.
  43
  44 *   **API Reference** : Provides detailed information about DPDK functions,
  45     data structures and other programming constructs.
  46
  47 *   **Sample Applications User Guide**: Describes a set of sample applications.
  48     Each chapter describes a sample application that showcases specific functionality
  49     and provides instructions on how to compile, run and use the sample application.
  50
  51 Related Publications
  52 --------------------
  53
  54 The following documents provide information that is relevant to the development of applications using the DPDK:
  55
  56 *   Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3A: System Programming Guide