DPDK official document list (18.02)

DPDK official document list

DPDK provides different supporting documents for readers to use. The documents mentioned below are the latest versions of the documents mentioned on the official website http://dpdk.org/doc (current time April 2018, version 18.02). The following is a brief description of the content of the downloaded pdf document in the order of the contents in the web version of the document http://dpdk.org/doc/guides/ , so that we can find the corresponding document as needed.

1. Getting started guide

  用于描述在不同的操作系统（freebsd和linux）上安装、配置DPDK软件；帮助用户启动和快速运行软件。
  见 linux_gsg-18.02.pdf和freebsd_gsg-18.02.pdf。

2. Sample applications user guides

  见sample_app_ug-18.02.pdf

3. Programmer's guide

 包括DPDK软件架构以及在linux环境下的使用方法；编译系统、移植说明及优化方法。
  见prog_guide-18.02.pdf

4. howto guides

 见howto-18.02.pdf。先列一列（因为现在有些术语还没看。fix me）：

• Live Migration of VM with SR-IOV VF
• Live Migration of VM with Virtio on host running vhost_user
• Flow Bifurcation How-to Guide
• Generic Traffic API - Example
• PVP reference benchmark setup using testpmd
• VF daemon (VFd)
• Virtio_user for Container Networking
• Virtio_user as Exceptional Path
• DPDK pdump library and pdump tool

5. DPDK tools user guides

  一些DPDK官方给的工具和test vector files的原理，见tools-18.02.pdf。

List the tools first:

• dpdk-proinfo
• dpdk-pdump
• dpdk-pmdinfo
• dpdk-devbind
• dpdk-test-bbdev
• dpdk-test-crypto-perf
• dpdk-test-eventdev

6. testpmd sample application user guides (testpmd application user guides)

见testpmd_app_ug-18.02.pdf。（先知道 testpmd测试dpdk的一个玩意 fix me）

7. network interface controller drivers

见nics-18.02.pdf。

8. Baseband device drivers

见bbdevs-18.02.pdf。

9. Crypto device drivers

见cryptodevs-18.02.pdf。

10. Event device drivers

见eventdevs-18.02.pdf。

11. Mempool device drivers

见mempool-18.02.pdf。

12. Platform specific guides

目前只有octeontx board的支持包有关信息。见platform-18.02.pdf

13. Contributor's guidelines

主要面向dpdk投稿者（贡献者contributor）包括DPDK的C编码风格、特定开发环境在C代码中的设计、ABI更新升级、文档撰写、dpdk发布和稳定版有关的信息。见contributing-18.02.pdf。

14. Release notes

  提供具体的发布信息，版本历史，包括支持特性、限制、问题改进、问题报告等。见rel_notes-18.02.pdf。  

15. FAQ

  常见问题解答。见faq-18.02.pdf。