numam-dpdk/doc/guides/freebsd_gsg/index.rst

..  SPDX-License-Identifier: BSD-3-Clause
    Copyright(c) 2010-2014 Intel Corporation.

.. _freebsd_gsg:

Getting Started Guide for FreeBSD
=================================

.. toctree::
    :maxdepth: 2
    :numbered:

    intro
    install_from_ports
    build_dpdk
    build_sample_apps
    freebsd_eal_parameters
doc: convert Intel license headers to SPDX tags Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com> 2018-02-01 17:18:17 +00:00			`.. SPDX-License-Identifier: BSD-3-Clause`
			`Copyright(c) 2010-2014 Intel Corporation.`
doc: getting started guide for freebsd The 1.7 DPDK_FreeBSD_GSG 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 is the second document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-23 14:15:28 +00:00
doc: move FAQ The FAQ section have been moved to a standalone document. Signed-off-by: John McNamara <john.mcnamara@intel.com> 2015-08-11 11:57:42 +00:00			`.. _freebsd_gsg:`

doc: getting started guide for freebsd The 1.7 DPDK_FreeBSD_GSG 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 is the second document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-23 14:15:28 +00:00			`Getting Started Guide for FreeBSD`
			`=================================`

			`.. toctree::`
			`:maxdepth: 2`
			`:numbered:`

			`intro`
doc: add freebsd ports Since the DPDK is now part of the BSD ports collection, we should recommend installing from ports as the best way to get it up and running. In order to achieve this, while still keeping the document readable, the chapter on system requirements has been moved to instead be a section within the chapter on compiling the DPDK outside of the ports collection. This move is necessary, since it covered a lot of detail on installing other ports required to build DPDK. These steps are not needed when installing DPDK itself from ports. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-11-24 15:50:39 +00:00			`install_from_ports`
doc: getting started guide for freebsd The 1.7 DPDK_FreeBSD_GSG 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 is the second document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-23 14:15:28 +00:00			`build_dpdk`
			`build_sample_apps`
doc: document all EAL parameters in one place Currently, the most complete (but still incomplete) user guide for EAL command-line parameters resides in user guide for testpmd. This is wrong on multiple levels, and should not be the case. To fix it, we have to create a document that lists all supported EAL command-line arguments. However, because different platforms support different subsets of available EAL parameters, instead of creating a single file, we will create a common file in doc/guides/common containing documentation for EAL parameters that are supported on all of our supported platforms (Linux and FreeBSD at the time of this writing). We will then include this document in the Getting Started guides for all supported platforms, so that any changes made to documentation for commonly supported EAL parameters will be reflected in Getting Started guides for all platforms. This patch also removes EAL parameters documentation from the testpmd user guide, and instead adds references to the newly created documents in both testpmd user guides and in sample applications guide. Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com> Reviewed-by: Rami Rosen <roszenrami@gmail.com> 2018-11-19 13:10:26 +00:00			`freebsd_eal_parameters`