projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 9f95a23c TL |
1 | .. SPDX-License-Identifier: BSD-3-Clause |
| 2 | Copyright(c) 2010-2014 Intel Corporation. | |
| 7c673cae FG |
3 | |
| 4 | Introduction | |
| 5 | ============ | |
| 6 | ||
| 7 | This document contains instructions for installing and configuring the | |
| 8 | Data Plane Development Kit (DPDK) software. It is designed to get customers | |
| 9 | up and running quickly and describes how to compile and run a | |
| 9f95a23c | 10 | DPDK application in a FreeBSD application (freebsd) environment, without going |
| 7c673cae FG |
11 | deeply into detail. |
| 12 | ||
| 13 | For a comprehensive guide to installing and using FreeBSD, the following | |
| 14 | handbook is available from the FreeBSD Documentation Project: | |
| 15 | `FreeBSD Handbook <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_. | |
| 16 | ||
| 17 | .. note:: | |
| 18 | ||
| 19 | The DPDK is now available as part of the FreeBSD ports collection. | |
| 20 | Installing via the ports collection infrastructure is now the recommended | |
| 21 | way to install the DPDK on FreeBSD, and is documented in the | |
| 22 | next chapter, :ref:`install_from_ports`. | |
| 23 | ||
| 24 | Documentation Roadmap | |
| 25 | --------------------- | |
| 26 | ||
| 27 | The following is a list of DPDK documents in the suggested reading order: | |
| 28 | ||
| 29 | * **Release Notes** : Provides release-specific information, including supported | |
| 30 | features, limitations, fixed issues, known issues and so on. Also, provides the | |
| 31 | answers to frequently asked questions in FAQ format. | |
| 32 | ||
| 33 | * **Getting Started Guide** (this document): Describes how to install and | |
| 34 | configure the DPDK; designed to get users up and running quickly with the | |
| 35 | software. | |
| 36 | ||
| 37 | * **Programmer's Guide**: Describes: | |
| 38 | ||
| 39 | * The software architecture and how to use it (through examples), | |
| 9f95a23c | 40 | specifically in a Linux* application (linux) environment |
| 7c673cae FG |
41 | |
| 42 | * The content of the DPDK, the build system (including the commands | |
| 43 | that can be used in the root DPDK Makefile to build the development | |
| 44 | kit and an application) and guidelines for porting an application | |
| 45 | ||
| 46 | * Optimizations used in the software and those that should be considered | |
| 47 | for new development | |
| 48 | ||
| 49 | A glossary of terms is also provided. | |
| 50 | ||
| 51 | * **API Reference**: Provides detailed information about DPDK functions, | |
| 52 | data structures and other programming constructs. | |
| 53 | ||
| 54 | * **Sample Applications User Guide**: Describes a set of sample applications. | |
| 55 | Each chapter describes a sample application that showcases specific functionality | |
| 56 | and provides instructions on how to compile, run and use the sample application. |