path: root/doc/guides/prog_guide/overview.rst
AgeCommit message (Collapse)Author
2019-03-12mk: use linux and freebsd in config namesBruce Richardson
Rather than using linuxapp and bsdapp everywhere, we can change things to use the, more readable, terms "linux" and "freebsd" in our build configs. Rather than renaming the configs we can just duplicate the existing ones with the new names using symlinks, and use the new names exclusively internally. ["make showconfigs" also only shows the new names to keep the list short] The result is that backward compatibility is kept fully but any new builds or development can be done using the newer names, i.e. both "make config T=x86_64-native-linuxapp-gcc" and "T=x86_64-native-linux-gcc" work. Signed-off-by: Bruce Richardson <>
2018-04-11mbuf: remove control mbufOlivier Matz
The rte_ctrlmbuf structure is not used by any example application in dpdk. Remove it, as announced on the mailing list. Signed-off-by: Olivier Matz <> Acked-by: Jerin Jacob <>
2018-02-06doc: convert Intel license headers to SPDX tagsFerruh Yigit
Signed-off-by: Ferruh Yigit <> Acked-by: Bruce Richardson <>
2016-11-07doc: fix typosAlain Leon
Fixes typos present in the documentation and code comments. Signed-off-by: Alain Leon <> Acked-by: John McNamara <>
2015-12-15doc: fix spellingsJohn McNamara
Fix various spellings in rst docs. Signed-off-by: John McNamara <> Acked-by: Harry van Haaren <>
2015-07-16doc: update malloc guideSergio Gonzalez Monroy
Update malloc documentation to reflect new implementation details. Signed-off-by: Sergio Gonzalez Monroy <>
2015-05-25doc: refactor figure numbers into referencesJohn McNamara
This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <>
2015-03-19doc: convert image extensions to wildcardJohn McNamara
Changed all image.svg and image.png extensions to image.* This allows Sphinx to decide the appropriate image type from the available image options. In case of PDF, SVG images are converted and Sphinx must pick the converted version. Signed-off-by: John McNamara <> Acked-by: Bernard Iremonger <>
2014-12-19doc: remove Intel references from prog guideSiobhan Butler
Removed redundant references to Intel(R) DPDK in Programmers Guide. Signed-off-by: Siobhan Butler <> Acked-by: Bernard Iremonger <>
2014-11-18doc: programmers guideBernard Iremonger
The 1.7 DPDK_Prog_Guide 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 these png files are modified they should be replaced with an svg file. This is the sixth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <>