summaryrefslogtreecommitdiff
path: root/doc/guides/prog_guide/intro.rst
diff options
context:
space:
mode:
authorBernard Iremonger <bernard.iremonger@intel.com>2014-11-14 11:53:41 +0000
committerThomas Monjalon <thomas.monjalon@6wind.com>2014-11-18 14:49:54 +0100
commitfc1f2750a3ec6da919e3c86e59d56f34ec97154b (patch)
tree90bfbaeb8d079ad36aea970eaf2003247aeeec22 /doc/guides/prog_guide/intro.rst
parenta4675d45cce945510f11a8a03a6cfe9ee871e67d (diff)
downloaddpdk-fc1f2750a3ec6da919e3c86e59d56f34ec97154b.zip
dpdk-fc1f2750a3ec6da919e3c86e59d56f34ec97154b.tar.gz
dpdk-fc1f2750a3ec6da919e3c86e59d56f34ec97154b.tar.xz
doc: programmers guide
The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
Diffstat (limited to 'doc/guides/prog_guide/intro.rst')
-rw-r--r--doc/guides/prog_guide/intro.rst83
1 files changed, 83 insertions, 0 deletions
diff --git a/doc/guides/prog_guide/intro.rst b/doc/guides/prog_guide/intro.rst
new file mode 100644
index 0000000..4b7a9f8
--- /dev/null
+++ b/doc/guides/prog_guide/intro.rst
@@ -0,0 +1,83 @@
+.. BSD LICENSE
+ Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name of Intel Corporation nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Introduction
+============
+
+This document provides software architecture information,
+development environment information and optimization guidelines.
+
+For programming examples and for instructions on compiling and running each sample application,
+see the *Intel® DPDK Sample Applications User Guide* for details.
+
+For general information on compiling and running applications, see the *Intel® DPDK Getting Started Guide*.
+
+Documentation Roadmap
+---------------------
+
+The following is a list of Intel® DPDK documents in the suggested reading order:
+
+* **Release Notes** (this document): Provides release-specific information, including supported features,
+ limitations, fixed issues, known issues and so on.
+ Also, provides the answers to frequently asked questions in FAQ format.
+
+* **Getting Started Guide** : Describes how to install and configure the Intel® DPDK software;
+ designed to get users up and running quickly with the software.
+
+* **FreeBSD* Getting Started Guide** : A document describing the use of the Intel® DPDK with FreeBSD*
+ has been added in Intel® DPDK Release 1.6.0.
+ Refer to this guide for installation and configuration instructions to get started using the Intel® DPDK with FreeBSD*.
+
+* **Programmer's Guide** (this document): Describes:
+
+ * The software architecture and how to use it (through examples),
+ specifically in a Linux* application (linuxapp) environment
+
+ * The content of the Intel® DPDK, the build system
+ (including the commands that can be used in the root Intel® DPDK Makefile to build the development kit and an application)
+ and guidelines for porting an application
+
+ * Optimizations used in the software and those that should be considered for new development
+
+ A glossary of terms is also provided.
+
+* **API Reference** : Provides detailed information about Intel® DPDK functions,
+ data structures and other programming constructs.
+
+* **Sample Applications User Guide**: Describes a set of sample applications.
+ Each chapter describes a sample application that showcases specific functionality
+ and provides instructions on how to compile, run and use the sample application.
+
+Related Publications
+--------------------
+
+The following documents provide information that is relevant to the development of applications using the Intel® DPDK:
+
+* Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3A: System Programming Guide