summaryrefslogtreecommitdiff
path: root/doc/guides/prog_guide/mbuf_lib.rst
AgeCommit message (Collapse)Author
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 <olivier.matz@6wind.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-02-06doc: convert Intel license headers to SPDX tagsFerruh Yigit
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2016-12-06doc: fix description of attach to indirect mbufBaruch Siach
Since commit 4a96e8b652181 ("mbuf: allow to clone an indirect mbuf") attaching to an indirect mbuf creates a clone of that mbuf. Update the mbuf documentation to match. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-12-06doc: fix mistakes in prog guideBaruch Siach
- Remove wrong document description: The Programmer’s Guide intro is not the Release Notes. - Fix heading of section which only deals with Tx queues configuration. - Fix wrong verbatim text paragraphs: Reduce the indentation of these paragraphs since they are not part of the verbatim block. Signed-off-by: Baruch Siach <baruch@tkos.co.il> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-04-11doc: fix references in guidesThomas Monjalon
Replace some hard-coded section numbers by dynamic links. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
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 <john.mcnamara@intel.com>
2015-04-29doc: fix spellings and typosJohn McNamara
Fixed several typos and spelling errors in guide docs. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-03-31doc: add description of the offload APIOlivier Matz
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
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 <john.mcnamara@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-20doc: update mbuf section of programmers guideBruce Richardson
In Release 1.8, the mbuf structure was significantly reworked to add extra information, leading to the structure being split across two cache lines, and the data pointer being replaced by an offset. The description of the library in the programmer's guide document needs to be updated to take account of these changes. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
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 <siobhan.a.butler@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
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 <bernard.iremonger@intel.com>