| #
41dd9a6b |
| 08-Dec-2023 |
David Young <dave@youngcopy.com> |
doc: reorganize prog guide
Create categories in the index of the programmer's guide,
sort chapters and rewrite some titles for consistency.
Subdirectories are created for ethdev and eventdev
for gr
doc: reorganize prog guide
Create categories in the index of the programmer's guide,
sort chapters and rewrite some titles for consistency.
Subdirectories are created for ethdev and eventdev
for grouping the files together.
Useless link anchors at the beginning of files are removed,
the corresponding :ref: are replaced with :doc: links.
Signed-off-by: David Young <dave@youngcopy.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
show more ...
|
| #
b301f2d3 |
| 16-Jul-2023 |
Stephen Hemminger <stephen@networkplumber.org> |
doc: fix description of runtime directories
The documentation was never updated when the DPDK EAL
was modified to follow standard runtime conventions.
Fixes: 1835a22f342f ("support systemd service
doc: fix description of runtime directories
The documentation was never updated when the DPDK EAL
was modified to follow standard runtime conventions.
Fixes: 1835a22f342f ("support systemd service convention for runtime directory")
Cc: stable@dpdk.org
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
show more ...
|
| #
9c30a6f3 |
| 29-Jul-2021 |
Henry Nadeau <hnadeau@iol.unh.edu> |
doc: fix spelling
Spell checked and corrected documentation.
If there are any errors, or I have changed something that wasn't an error
please reach out to me so I can update the dictionary.
Cc: sta
doc: fix spelling
Spell checked and corrected documentation.
If there are any errors, or I have changed something that wasn't an error
please reach out to me so I can update the dictionary.
Cc: stable@dpdk.org
Signed-off-by: Henry Nadeau <hnadeau@iol.unh.edu>
show more ...
|
| #
c053d9e9 |
| 16-Sep-2020 |
Sarosh Arif <sarosh.arif@emumba.com> |
doc: fix grammar
This patch corrects a grammatical error by changing 'an DPDK' to 'a DPDK',
so that the sentences can become grammatically accurate.
Fixes: 2e486e26328c ("doc: remove Intel referenc
doc: fix grammar
This patch corrects a grammatical error by changing 'an DPDK' to 'a DPDK',
so that the sentences can become grammatically accurate.
Fixes: 2e486e26328c ("doc: remove Intel references from linux guide")
Fixes: 48624fd96e7c ("doc: remove Intel references from prog guide")
Fixes: e0c7c4731957 ("doc: remove Intel references from sample apps guide")
Cc: stable@dpdk.org
Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
show more ...
|
| #
db27370b |
| 10-Nov-2020 |
Stephen Hemminger <stephen@networkplumber.org> |
eal: replace blacklist/whitelist options
Replace -w / --pci-whitelist with -a / --allow options
and --pci-blacklist with --block.
The -b short option remains unchanged.
Allow the old options for no
eal: replace blacklist/whitelist options
Replace -w / --pci-whitelist with -a / --allow options
and --pci-blacklist with --block.
The -b short option remains unchanged.
Allow the old options for now, but print a nag
warning since old options are deprecated.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
show more ...
|
| #
bfbc3a50 |
| 03-May-2019 |
Anatoly Burakov <anatoly.burakov@intel.com> |
ipc: add warnings about correct API usage
When handling synchronous or asynchronous requests, the reply
must be sent explicitly even if the result of the operation is
an error, to avoid the other si
ipc: add warnings about correct API usage
When handling synchronous or asynchronous requests, the reply
must be sent explicitly even if the result of the operation is
an error, to avoid the other side timing out. Make note of this
in documentation explicitly.
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
show more ...
|
| #
3855b415 |
| 03-May-2019 |
Anatoly Burakov <anatoly.burakov@intel.com> |
ipc: add warnings about not using IPC with memory API
IPC and memory-related API's should not be mixed because memory
relies on IPC internally. Add explicit warnings to IPC API and
to the documentat
ipc: add warnings about not using IPC with memory API
IPC and memory-related API's should not be mixed because memory
relies on IPC internally. Add explicit warnings to IPC API and
to the documentation about this.
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
show more ...
|
| #
ab96056d |
| 03-May-2019 |
Anatoly Burakov <anatoly.burakov@intel.com> |
doc: fix typo in IPC guide
The word "synchronous" appears twice. Fix it.
Fixes: e22266669e86 ("doc: add IPC guide")
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
A
doc: fix typo in IPC guide
The word "synchronous" appears twice. Fix it.
Fixes: e22266669e86 ("doc: add IPC guide")
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
show more ...
|
| #
c96b55df |
| 29-Apr-2019 |
Yipeng Wang <yipeng1.wang@intel.com> |
hash: fix doc about thread/process safety
rte_hash_hash is multi-thread safe but not multi-process safe
because of the use of function pointers. Previous document
and comment says the other way arou
hash: fix doc about thread/process safety
rte_hash_hash is multi-thread safe but not multi-process safe
because of the use of function pointers. Previous document
and comment says the other way around. This commit fixes
the issue.
Fixes: fc1f2750a3ec ("doc: programmers guide")
Fixes: 48a399119619 ("hash: replace with cuckoo hash implementation")
Cc: stable@dpdk.org
Reported-by: Andrey Nikolaev <gentoorion@gmail.com>
Suggested-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com>
Acked-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
show more ...
|
| #
d629b7b5 |
| 26-Apr-2019 |
John McNamara <john.mcnamara@intel.com> |
doc: fix spelling reported by aspell in guides
Fix spelling errors in the guide docs.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Rami Rosen <ramirose@gmail.com>
|
| #
3456b5ea |
| 26-Jun-2018 |
Anatoly Burakov <anatoly.burakov@intel.com> |
doc: add IPC callback limitations
For asynchronous requests, user callback may be triggered either from
IPC thread or from interrupt thread. Because of this, delivery of
other interrupt-based events
doc: add IPC callback limitations
For asynchronous requests, user callback may be triggered either from
IPC thread or from interrupt thread. Because of this, delivery of
other interrupt-based events such as alarms may not be possible inside
the asynchronous IPC request callback handler. Document this
limitation.
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
show more ...
|
| #
b3173932 |
| 25-May-2018 |
Anatoly Burakov <anatoly.burakov@intel.com> |
doc: update guides for memory subsystem
Document new command-line switches and the principles behind the
new memory subsystem. Also, replace outdated malloc heap picture.
Signed-off-by: Anatoly Bur
doc: update guides for memory subsystem
Document new command-line switches and the principles behind the
new memory subsystem. Also, replace outdated malloc heap picture.
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
show more ...
|
| #
e2226666 |
| 25-May-2018 |
Anatoly Burakov <anatoly.burakov@intel.com> |
doc: add IPC guide
Describe all the capabilities of DPDK IPC, and provide some
insight into how to best make use of it.
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
|
| #
7e323fea |
| 11-May-2018 |
Vipin Varghese <vipin.varghese@intel.com> |
doc: add note about device options for multi-process
Update information for blacklist and whitelist options for secondary
process to share same from primary process.
Signed-off-by: Vipin Varghese <
doc: add note about device options for multi-process
Update information for blacklist and whitelist options for secondary
process to share same from primary process.
Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
show more ...
|
| #
5630257f |
| 01-Feb-2018 |
Ferruh Yigit <ferruh.yigit@intel.com> |
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>
|
| #
deedc8d9 |
| 29-Nov-2017 |
Junjie Chen <junjie.j.chen@intel.com> |
doc: add a restriction to multi-process support
This patch add a restriction to multi-process support: secondary
processes should only run alongside primary process with same DPDK
version, so that s
doc: add a restriction to multi-process support
This patch add a restriction to multi-process support: secondary
processes should only run alongside primary process with same DPDK
version, so that secondary processes can use the same hugepage mmap
layout as primary process.
Signed-off-by: Junjie Chen <junjie.j.chen@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
show more ...
|
| #
35b09d76 |
| 27-Feb-2017 |
Keith Wiles <keith.wiles@intel.com> |
doc: use corelist instead of coremask
The coremask option in DPDK is difficult to use and we should be
promoting the use of the corelist (-l) option. The patch
adjusts the docs to use -l EAL option
doc: use corelist instead of coremask
The coremask option in DPDK is difficult to use and we should be
promoting the use of the corelist (-l) option. The patch
adjusts the docs to use -l EAL option instead of the -c option.
The patch only changes the docs and not the code as the -c option
will continue to exist unless it is removed in the future. The -c
option should be kept to maintain backward compatibility.
Signed-off-by: Keith Wiles <keith.wiles@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
show more ...
|
| #
dab1d475 |
| 27-Oct-2016 |
Jerin Jacob <jerin.jacob@caviumnetworks.com> |
doc: remove Intel reference from multi-process guide
multi-process support has been verified on non IA such as ARMv8.
Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: John McNa
doc: remove Intel reference from multi-process guide
multi-process support has been verified on non IA such as ARMv8.
Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
show more ...
|
| #
29e30cbc |
| 11-Apr-2016 |
Thomas Monjalon <thomas.monjalon@6wind.com> |
doc: fix references in guides
Replace some hard-coded section numbers by dynamic links.
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
|
| #
f02730ab |
| 02-Feb-2016 |
Ferruh Yigit <ferruh.yigit@intel.com> |
doc: fix multi-process guide
* remove outdated chapter reference to Multi-process support.
* html output converts "--" to "-", this is wrong when explaining the
command arguments, used fixed widt
doc: fix multi-process guide
* remove outdated chapter reference to Multi-process support.
* html output converts "--" to "-", this is wrong when explaining the
command arguments, used fixed width quotes for them.
Fixes: fc1f2750a3ec ("doc: programmers guide")
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
show more ...
|
| #
4a22e6ee |
| 18-May-2015 |
John McNamara <john.mcnamara@intel.com> |
doc: refactor figure numbers into references
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 s
doc: refactor figure numbers into references
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>
show more ...
|
| #
ba9e05cb |
| 03-Feb-2015 |
John McNamara <john.mcnamara@intel.com> |
doc: convert image extensions to wildcard
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
doc: convert image extensions to wildcard
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>
show more ...
|
| #
48624fd9 |
| 19-Dec-2014 |
Siobhan Butler <siobhan.a.butler@intel.com> |
doc: remove Intel references from prog guide
Removed redundant references to Intel(R) DPDK in Programmers Guide.
Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Acked-by: Bernard Iremong
doc: remove Intel references from prog guide
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>
show more ...
|
| #
fc1f2750 |
| 14-Nov-2014 |
Bernard Iremonger <bernard.iremonger@intel.com> |
doc: programmers guide
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
doc: programmers guide
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>
show more ...
|