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

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

.. _linux_gsg:

Getting Started Guide for Linux
===============================

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

    intro
    sys_reqs
    build_dpdk
    cross_build_dpdk_for_arm64
    linux_drivers
    build_sample_apps
    linux_eal_parameters
    enable_func
    nic_perf_intel_platform
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-2015 Intel Corporation.`
doc: getting started guide for linux The 1.7 DPDK_Linux_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. This is the first document from a set of documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-16 13:27:42 +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			`.. _linux_gsg:`

doc: precise title for linux guide Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> 2014-10-31 21:05:34 +00:00			`Getting Started Guide for Linux`
			`===============================`
doc: getting started guide for linux The 1.7 DPDK_Linux_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. This is the first document from a set of documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-16 13:27:42 +00:00
			`.. toctree::`
			`:maxdepth: 2`
			`:numbered:`

			`intro`
			`sys_reqs`
			`build_dpdk`
doc: add cross compiling guide This is the guide for cross compiling ARM64 DPDK from X86 hosts. Signed-off-by: Gavin Hu <gavin.hu@arm.com> Reviewed-by: Steve Capper <steve.capper@arm.com> Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com> 2018-06-29 17:27:34 +00:00			`cross_build_dpdk_for_arm64`
doc: move kernel drivers to a new chapter The UIO and VFIO sections should not be part of the "Compiling the DPDK Target from Source" chapter, as it is PMD specific and not true for all PMDs. Instead, moving those sections to a new chapter which include all kernel drivers being used along with the different PMDs. Signed-off-by: Shahaf Shuler <shahafs@mellanox.com> Acked-by: John McNamara <john.mcnamara@intel.com> 2017-07-29 16:17:30 +00:00			`linux_drivers`
doc: getting started guide for linux The 1.7 DPDK_Linux_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. This is the first document from a set of documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-16 13:27:42 +00:00			`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			`linux_eal_parameters`
doc: getting started guide for linux The 1.7 DPDK_Linux_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. This is the first document from a set of documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> 2014-10-16 13:27:42 +00:00			`enable_func`
doc: add NIC performance guide on Linux IA Add a new guide doc as part of the Linux Getting Started Guide. The document is a step-by-step guide on how to get high performance with DPDK on an Intel platform. It is designed for users who are not familiar with DPDK but would like to get the best performance with NICs. Signed-off-by: Qian Xu <qian.q.xu@intel.com> 2015-11-18 03:10:16 +00:00			`nic_perf_intel_platform`