numam-dpdk/doc/guides/freebsd_gsg/intro.rst
Bruce Richardson 5cfaa3c3b0 doc: make doc roadmap common for Linux and BSD guides
Both the Linux and FreeBSD GSG docs had a "Documentation Roadmap"
section as part of the introduction page, and this contained the same
information, with only the reference to the GSGs themselves being
different. This text can be consolidated into a single text file which
is included by both GSG intro sections - using relative links for the
self reference.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2022-06-26 23:36:39 +02:00

27 lines
1.0 KiB
ReStructuredText

.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2014 Intel Corporation.
Introduction
============
This document contains instructions for installing and configuring the
Data Plane Development Kit (DPDK) software. It is designed to get customers
up and running quickly and describes how to compile and run a
DPDK application in a FreeBSD application (freebsd) environment, without going
deeply into detail.
For a comprehensive guide to installing and using FreeBSD, the following
handbook is available from the FreeBSD Documentation Project:
`FreeBSD Handbook <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_.
.. note::
DPDK is now available as part of the FreeBSD ports collection and as a pre-built package.
Installing via the ports collection or FreeBSD `pkg` infrastructure is now the recommended
way to install DPDK on FreeBSD, and is documented in the next chapter, :ref:`install_from_ports`.
Documentation Roadmap
---------------------
.. include:: ../linux_gsg/doc_roadmap.include.rst