d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
58bb1ee4a5
numam-dpdk/doc/guides/index.rst

29 lines
513 B
ReStructuredText
Raw Normal View History

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
doc: add guide for Windows Added documentation to build helloworld example on Windows using meson and clang. Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com> Signed-off-by: Anand Rawat <anand.rawat@intel.com> Reviewed-by: Jeff Shaw <jeffrey.b.shaw@intel.com> Reviewed-by: Ranjit Menon <ranjit.menon@intel.com> Tested-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com> Acked-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com>
2019-04-02 03:54:57 +00:00
Copyright(c) 2010-2019 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
mk: generate html guides with sphinx Add minimal configuration and index to validate new rules inside "make doc" and "make doc-clean". RTE_SPHINX_BUILD can be overriden. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-10-15 20:12:20 +00:00
DPDK documentation
==================
.. toctree::
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
:maxdepth: 1
linux_gsg/index
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
freebsd_gsg/index
doc: add guide for Windows Added documentation to build helloworld example on Windows using meson and clang. Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com> Signed-off-by: Anand Rawat <anand.rawat@intel.com> Reviewed-by: Jeff Shaw <jeffrey.b.shaw@intel.com> Reviewed-by: Ranjit Menon <ranjit.menon@intel.com> Tested-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com> Acked-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com>
2019-04-02 03:54:57 +00:00
windows_gsg/index
doc: sample application user guide The 1.7 DPDK_SampleApp_UG 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 thes png files are modified they should be replaced with an svg file. This is the fifth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-11 12:27:01 +00:00
sample_app_ug/index
doc: rearrange the high level index Rearrange the order of the high level documenation index into a more logical sequence for a new user. Also, improve some of the high-level document names. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2016-11-11 13:45:55 +00:00
prog_guide/index
howto/index
doc: move tool guides in their own subdirectory This is to clarify the scope of these documents that are more tools than sample applications. Also this is a preparation step to add more tools and generate man pages off of their rst files. Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com> Acked-by: Luca Boccassi <lboccass@brocade.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-08-31 07:50:09 +00:00
tools/index
doc: testpmd application user guide The 1.7 DPDK_TestPMD_App_UG 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 fourth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-04 13:56:59 +00:00
testpmd_app_ug/index
doc: rearrange the high level index Rearrange the order of the high level documenation index into a more logical sequence for a new user. Also, improve some of the high-level document names. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2016-11-11 13:45:55 +00:00
nics/index
bb/null: add null base band device driver - 'bbdev_null' is a basic pmd that performs a minimalistic bbdev operation - useful for bbdev smoke testing and in measuring the overhead introduced by the bbdev library - 'bbdev_null' pmd is enabled by default Signed-off-by: Amr Mokhtar <amr.mokhtar@intel.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-01-11 19:23:19 +00:00
bbdevs/index
doc: rearrange the high level index Rearrange the order of the high level documenation index into a more logical sequence for a new user. Also, improve some of the high-level document names. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2016-11-11 13:45:55 +00:00
cryptodevs/index
doc: add compression driver and ISA-L PMD guides This adds general compression drivers feature guide as well as the ISA-L PMD documentation and guide. Signed-off-by: Lee Daly <lee.daly@intel.com> Reviewed-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2018-05-09 16:14:35 +00:00
compressdevs/index
doc: add event device and software eventdev This commit adds a section to the docs listing the event device PMDs available. It then adds the software eventdev PMD to the listed event devices. Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2017-03-30 19:30:48 +00:00
eventdevs/index
doc: add DPAA2 QDMA rawdev guide Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com> Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com>
2018-05-03 16:06:10 +00:00
rawdevs/index
doc: add octeontx mempool guide This commit adds a section to the docs listing the mempool device PMDs available. It then adds the octeontx fpavf mempool PMD to the listed mempool devices. Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-11-07 06:59:33 +00:00
mempool/index
doc: add octeontx platform guide This commit adds a section to the docs listing the platform guide for the PMDs. It then adds the octeontx platform guide to the listed platform devices. Patch also removes platform specific duplicate setup information from eventdev/octeontx.rst, nics/octeontx.rst and update to plaform/octeontx.rst. Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-11-07 06:59:32 +00:00
platform/index
doc: rename guidelines for contributors Clarify target of guidelines by renaming the title and the directory. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2015-08-11 12:49:52 +00:00
contributing/index
doc: rearrange the high level index Rearrange the order of the high level documenation index into a more logical sequence for a new user. Also, improve some of the high-level document names. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2016-11-11 13:45:55 +00:00
rel_notes/index
faq/index
Reference in New Issue Copy Permalink