doc/guides/prog_guide/intro.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 Introduction
  32 ============
  33
  34 This document provides software architecture information,
  35 development environment information and optimization guidelines.
  36
  37 For programming examples and for instructions on compiling and running each sample application,
  38 see the *DPDK Sample Applications User Guide* for details.
  39
  40 For general information on compiling and running applications, see the *DPDK Getting Started Guide*.
  41
  42 Documentation Roadmap
  43 ---------------------
  44
  45 The following is a list of DPDK documents in the suggested reading order:
  46
  47 *   **Release Notes** (this document): Provides release-specific information, including supported features,
  48     limitations, fixed issues, known issues and so on.
  49     Also, provides the answers to frequently asked questions in FAQ format.
  50
  51 *   **Getting Started Guide** : Describes how to install and configure the DPDK software;
  52     designed to get users up and running quickly with the software.
  53
  54 *   **FreeBSD* Getting Started Guide** : A document describing the use of the DPDK with FreeBSD*
  55     has been added in DPDK Release 1.6.0.
  56     Refer to this guide for installation and configuration instructions to get started using the DPDK with FreeBSD*.
  57
  58 *   **Programmer's Guide** (this document): Describes:
  59
  60     *   The software architecture and how to use it (through examples),
  61         specifically in a Linux* application (linuxapp) environment
  62
  63     *   The content of the DPDK, the build system
  64         (including the commands that can be used in the root DPDK Makefile to build the development kit and an application)
  65         and guidelines for porting an application
  66
  67     *   Optimizations used in the software and those that should be considered for new development
  68
  69     A glossary of terms is also provided.
  70
  71 *   **API Reference** : Provides detailed information about DPDK functions,
  72     data structures and other programming constructs.
  73
  74 *   **Sample Applications User Guide**: Describes a set of sample applications.
  75     Each chapter describes a sample application that showcases specific functionality
  76     and provides instructions on how to compile, run and use the sample application.
  77
  78 Related Publications
  79 --------------------
  80
  81 The following documents provide information that is relevant to the development of applications using the DPDK:
  82
  83 *   Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3A: System Programming Guide