doc/guides/freebsd_gsg/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 contains instructions for installing and configuring the
  35 Data Plane Development Kit (DPDK) software. It is designed to get customers
  36 up and running quickly and describes how to compile and run a
  37 DPDK application in a FreeBSD application (bsdapp) environment, without going
  38 deeply into detail.
  39
  40 For a comprehensive guide to installing and using FreeBSD, the following
  41 handbook is available from the FreeBSD Documentation Project:
  42 `FreeBSD Handbook <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_.
  43
  44 .. note::
  45
  46    The DPDK is now available as part of the FreeBSD ports collection.
  47    Installing via the ports collection infrastructure is now the recommended
  48    way to install the DPDK on FreeBSD, and is documented in the
  49    next chapter, :ref:`install_from_ports`.
  50
  51 Documentation Roadmap
  52 ---------------------
  53
  54 The following is a list of DPDK documents in the suggested reading order:
  55
  56 *   **Release Notes** : Provides release-specific information, including supported
  57     features, limitations, fixed issues, known issues and so on.  Also, provides the
  58     answers to frequently asked questions in FAQ format.
  59
  60 *   **Getting Started Guide** (this document): Describes how to install and
  61     configure the DPDK; designed to get users up and running quickly with the
  62     software.
  63
  64 *   **Programmer's Guide**: Describes:
  65
  66     *   The software architecture and how to use it (through examples),
  67         specifically in a Linux* application (linuxapp) environment
  68
  69     *   The content of the DPDK, the build system (including the commands
  70         that can be used in the root DPDK Makefile to build the development
  71         kit and an application) and guidelines for porting an application
  72
  73     *   Optimizations used in the software and those that should be considered
  74         for new development
  75
  76     A glossary of terms is also provided.
  77
  78 *   **API Reference**: Provides detailed information about DPDK functions,
  79     data structures and other programming constructs.
  80
  81 *   **Sample Applications User Guide**: Describes a set of sample applications.
  82     Each chapter describes a sample application that showcases specific functionality
  83     and provides instructions on how to compile, run and use the sample application.