History log of /dpdk/doc/guides/contributing/documentation.rst (Results 1 – 25 of 30)
Revision (<<< Hide revision tags) (Show revision tags >>>) Date Author Comments
Revision tags: v22.03, v22.03-rc4, v22.03-rc3, v22.03-rc2, v22.03-rc1, v21.11, v21.11-rc4, v21.11-rc3, v21.11-rc2, v21.11-rc1
# fb11ae88 19-Oct-2021 Andrew Rybchenko <[email protected]>

mempool: deprecate unused physical page defines

MEMPOOL_PG_NUM_DEFAULT and MEMPOOL_PG_SHIFT_MAX are not used.

Fixes: fd943c764a63 ("mempool: deprecate xmem functions")

Signed-off-by: Andrew Rybche

mempool: deprecate unused physical page defines

MEMPOOL_PG_NUM_DEFAULT and MEMPOOL_PG_SHIFT_MAX are not used.

Fixes: fd943c764a63 ("mempool: deprecate xmem functions")

Signed-off-by: Andrew Rybchenko <[email protected]>
Acked-by: Olivier Matz <[email protected]>

show more ...


Revision tags: v21.08, v21.08-rc4, v21.08-rc3, v21.08-rc2, v21.08-rc1, v21.05, v21.05-rc4, v21.05-rc3
# 413c75c3 06-May-2021 Conor Walsh <[email protected]>

doc: show how to include code in guides

Currently the documentation describes how to add code snippets to the
docs using code blocks. This can be problematic as the code snippets
in the docs may fal

doc: show how to include code in guides

Currently the documentation describes how to add code snippets to the
docs using code blocks. This can be problematic as the code snippets
in the docs may fall out of sync with the actual code it is referencing
within DPDK. This patch adds instructions to the contribution guide
about how to include code in the docs using literalinclude which will
dynamically get the code from source when the docs are generated. This
will help to ensure that the code within the docs is up to date and not
out of sync with the actual code.

Signed-off-by: Conor Walsh <[email protected]>
Acked-by: John McNamara <[email protected]>
Acked-by: David Marchand <[email protected]>
Acked-by: Thomas Monjalon <[email protected]>

show more ...


# 428eaeb8 11-May-2021 Thomas Monjalon <[email protected]>

doc: remove PDF requirements

The documentation is generated in HTML only.
The PDF format is abandoned since DPDK 20.11
while dropping support of the make-based build.

This decision has been mention

doc: remove PDF requirements

The documentation is generated in HTML only.
The PDF format is abandoned since DPDK 20.11
while dropping support of the make-based build.

This decision has been mentioned by the Technical Board:
https://mails.dpdk.org/archives/dev/2021-January/195549.html

Fixes: 3cc6ecfdfe85 ("build: remove makefiles")
Cc: [email protected]

Signed-off-by: Thomas Monjalon <[email protected]>
Reviewed-by: Ruifeng Wang <[email protected]>

show more ...


Revision tags: v21.05-rc2, v21.05-rc1
# 99a2dd95 20-Apr-2021 Bruce Richardson <[email protected]>

lib: remove librte_ prefix from directory names

There is no reason for the DPDK libraries to all have 'librte_' prefix on
the directory names. This prefix makes the directory names longer and also
m

lib: remove librte_ prefix from directory names

There is no reason for the DPDK libraries to all have 'librte_' prefix on
the directory names. This prefix makes the directory names longer and also
makes it awkward to add features referring to individual libraries in the
build - should the lib names be specified with or without the prefix.
Therefore, we can just remove the library prefix and use the library's
unique name as the directory name, i.e. 'eal' rather than 'librte_eal'

Signed-off-by: Bruce Richardson <[email protected]>

show more ...


Revision tags: v21.02, v21.02-rc4, v21.02-rc3, v21.02-rc2, v21.02-rc1, v20.11, v20.11-rc5, v20.11-rc4, v20.11-rc3, v20.11-rc2
# 532e4e48 21-Oct-2020 Ciara Power <[email protected]>

doc: remove references to make from contributing guide

Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <ciara.power@intel

doc: remove references to make from contributing guide

Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <[email protected]>
Signed-off-by: Louise Kilheeney <[email protected]>

show more ...


Revision tags: v20.11-rc1
# b1df4163 02-Oct-2020 Robin Jarry <[email protected]>

doc: remove references to python 2

Python 2 support has now been dropped. Remove references to it in the
documentation.

Since all python scripts now have a proper shebang that calls python3,
execut

doc: remove references to python 2

Python 2 support has now been dropped. Remove references to it in the
documentation.

Since all python scripts now have a proper shebang that calls python3,
execute the scripts directly without specifying the interpreter.

Sphinx version from most Linux distros is OK in 2020, do not encourage
people to break their system by installing with pip. Use the distros
official packages.

Signed-off-by: Robin Jarry <[email protected]>
Acked-by: Bruce Richardson <[email protected]>
Acked-by: Kevin Laatz <[email protected]>

show more ...


Revision tags: v20.08, v20.08-rc4, v20.08-rc3, v20.08-rc2, v20.08-rc1, v20.05, v20.05-rc4, v20.05-rc3, v20.05-rc2, v20.05-rc1
# 3d4b2afb 19-Mar-2020 David Marchand <[email protected]>

doc: prefer https when pointing to dpdk.org

for file in $(git grep -l http://.*dpdk.org doc/); do
sed -i -e 's#http://\(.*dpdk.org\)#https://\1#g' $file;
done

Cc: [email protected]

Signed-off-by:

doc: prefer https when pointing to dpdk.org

for file in $(git grep -l http://.*dpdk.org doc/); do
sed -i -e 's#http://\(.*dpdk.org\)#https://\1#g' $file;
done

Cc: [email protected]

Signed-off-by: David Marchand <[email protected]>
Acked-by: Kevin Traynor <[email protected]>

show more ...


Revision tags: v20.02, v20.02-rc4, v20.02-rc3, v20.02-rc2, v20.02-rc1, v19.11, v19.11-rc4, v19.11-rc3, v19.11-rc2, v19.11-rc1, v19.08, v19.08-rc4
# e85373ed 05-Aug-2019 Thomas Monjalon <[email protected]>

doc: remove major in designation of normal releases

The word "major" was used to differentiate with release candidates
or stable maintenance releases.
However the word "major" can be understood as "

doc: remove major in designation of normal releases

The word "major" was used to differentiate with release candidates
or stable maintenance releases.
However the word "major" can be understood as "LTS",
so it is less confusing to avoid this word.

Reported-by: Ori Kam <[email protected]>
Signed-off-by: Thomas Monjalon <[email protected]>
Acked-by: Kevin Traynor <[email protected]>

show more ...


Revision tags: v19.08-rc3, v19.08-rc2, v19.08-rc1
# f98f4fb2 22-May-2019 Thomas Monjalon <[email protected]>

doc: fix PDF with greek letter

For an unknown reason, the sign "μ" is not accepted by some environments,
probably due to the version of some Latex packages or dependencies.

! Package inputenc Erro

doc: fix PDF with greek letter

For an unknown reason, the sign "μ" is not accepted by some environments,
probably due to the version of some Latex packages or dependencies.

! Package inputenc Error: Unicode character μ (U+03BC)
(inputenc) not set up for use with LaTeX.

It is fixed by installing texlive-langgreek.

Fixes: d0dff9ba445e ("doc: sample application user guide")
Cc: [email protected]

Signed-off-by: Thomas Monjalon <[email protected]>
Acked-by: John McNamara <[email protected]>

show more ...


Revision tags: v19.05, v19.05-rc4, v19.05-rc3, v19.05-rc2, v19.05-rc1
# 047b663a 03-Apr-2019 Dekel Peled <[email protected]>

doc: fix links to doxygen and sphinx sites

Update broken links, replace with valid links.

Fixes: 7798f17a0d62 ("doc: add documentation guidelines")
Cc: [email protected]

Signed-off-by: Dekel Peled <

doc: fix links to doxygen and sphinx sites

Update broken links, replace with valid links.

Fixes: 7798f17a0d62 ("doc: add documentation guidelines")
Cc: [email protected]

Signed-off-by: Dekel Peled <[email protected]>

show more ...


# b543d1a7 06-Feb-2019 Bruce Richardson <[email protected]>

compat: merge compat library into EAL

Since compat library is only a single header, we can easily move it into
the EAL common headers instead of tracking it separately. The downside of
this is that

compat: merge compat library into EAL

Since compat library is only a single header, we can easily move it into
the EAL common headers instead of tracking it separately. The downside of
this is that it becomes a little more difficult to have any libs that are
built before EAL depend on it. Thankfully, this is not a major problem as
the only library which uses rte_compat.h and is built before EAL (kvargs)
already has the path to the compat.h header file explicitly called out as
an include path.

However, to ensure that we don't hit problems later with this, we can add
EAL common headers folder to the global include list in the meson build
which means that all common headers can be safely used by all libraries, no
matter what their build order.

As a side-effect, this patch also fixes an issue with building on BSD using
meson, due to compat lib no longer needing to be listed as a dependency.

Fixes: a8499f65a1d1 ("log: add missing experimental tag")
Cc: [email protected]

Signed-off-by: Bruce Richardson <[email protected]>
Reviewed-by: David Marchand <[email protected]>
Tested-by: David Marchand <[email protected]>
Tested-by: Anatoly Burakov <[email protected]>
Acked-by: Thomas Monjalon <[email protected]>

show more ...


Revision tags: v19.02, v19.02-rc4, v19.02-rc3
# 63a71926 20-Jan-2019 Rami Rosen <[email protected]>

doc: add dependency for PDF in contributing guide

There is a missing depenency for building docs with "make doc-guides-pdf".
This causes it to break with "make[3]: latexmk: Command not found". This

doc: add dependency for PDF in contributing guide

There is a missing depenency for building docs with "make doc-guides-pdf".
This causes it to break with "make[3]: latexmk: Command not found". This
was observed and reported in https://bugs.dpdk.org/show_bug.cgi?id=182
This patch fixes this issue by adding the latexmk package dependency in
sub-section 4.3.1 of the contributing guide ("Dependencies").

Bugzilla ID: 182
Cc: [email protected]

Signed-off-by: Rami Rosen <[email protected]>

show more ...


Revision tags: v19.02-rc2, v19.02-rc1, v18.11
# 43d162bc 26-Nov-2018 Thomas Monjalon <[email protected]>

fix dpdk.org URLs

The DPDK website has a new URL scheme since June 2018.

Cc: [email protected]

Signed-off-by: Thomas Monjalon <[email protected]>
Acked-by: John McNamara <[email protected]>


Revision tags: v18.11-rc5, v18.11-rc4, v18.11-rc3, v18.11-rc2, v18.11-rc1
# 5f63d635 23-Oct-2018 Thomas Monjalon <[email protected]>

doc: replace doxygen example in contribution guide

The provided example of doxygen header is about a deprecated function.
It is replaced by rte_spinlock_trylock() which is small and
good enough for

doc: replace doxygen example in contribution guide

The provided example of doxygen header is about a deprecated function.
It is replaced by rte_spinlock_trylock() which is small and
good enough for the purpose.

Signed-off-by: Thomas Monjalon <[email protected]>
Reviewed-by: Andrew Rybchenko <[email protected]>

show more ...


# 71ac6399 21-Sep-2018 Tiwei Bie <[email protected]>

doc: update commands for virtio-user

Update the doc for virtio-user to use the latest testpmd
parameters and commands.

Signed-off-by: Tiwei Bie <[email protected]>
Reviewed-by: Maxime Coquelin <m

doc: update commands for virtio-user

Update the doc for virtio-user to use the latest testpmd
parameters and commands.

Signed-off-by: Tiwei Bie <[email protected]>
Reviewed-by: Maxime Coquelin <[email protected]>

show more ...


Revision tags: v18.08, v18.08-rc3, v18.08-rc2, v18.08-rc1
# 77c79de0 05-Jun-2018 Hemant Agrawal <[email protected]>

doc: add SPDX and copyright to contributing guide

Signed-off-by: Hemant Agrawal <[email protected]>
Acked-by: Thomas Monjalon <[email protected]>


Revision tags: v18.05, v18.05-rc6, v18.05-rc5, v18.05-rc4, v18.05-rc3, v18.05-rc2, v18.05-rc1, v18.02, v18.02-rc4, v18.02-rc3, v18.02-rc2
# 8b9bd0ef 31-Jan-2018 Moti Haimovsky <[email protected]>

app/testpmd: disable Rx VLAN offloads by default

Removed the hardcoded preconfigured Rx VLAN offload configuration
from testpmd and changed the Rx offload command line parameters from
disable to ena

app/testpmd: disable Rx VLAN offloads by default

Removed the hardcoded preconfigured Rx VLAN offload configuration
from testpmd and changed the Rx offload command line parameters from
disable to enable.

It has been decided by the Technical Board that testers who wish to
use these offloads will now have to explicitly write them in the
command-line when running testpmd.
The agreement is to keep two exceptions enabled by default in 18.02:
Rx CRC strip and Tx fast free.

Motivation:
Some PMDs such at the mlx4 may not implement all the offloads.
After the offload API rework assuming no offload is enabled by default,
commit ce17eddefc20 ("ethdev: introduce Rx queue offloads API")
commit cba7f53b717d ("ethdev: introduce Tx queue offloads API") trying
to enable a not supported offload is clearly an error which will cause
configuration failing.

Considering that testpmd is an application to test the PMD, it should
not fail on a configuration which was not explicitly requested.
The behavior of this test application is then turned to an opt-in
model.

Signed-off-by: Moti Haimovsky <[email protected]>
Acked-by: Thomas Monjalon <[email protected]>

show more ...


Revision tags: v18.02-rc1, v17.11, v17.11-rc4, v17.11-rc3, v17.11-rc2, v17.11-rc1
# f26ab687 14-Sep-2017 Jianfeng Tan <[email protected]>

eal: remove Xen dom0 support

We remove xen-specific code in EAL, including the option --xen-dom0,
memory initialization code, compiling dependency, etc.

Related documents are removed or updated, an

eal: remove Xen dom0 support

We remove xen-specific code in EAL, including the option --xen-dom0,
memory initialization code, compiling dependency, etc.

Related documents are removed or updated, and bump the eal library
version.

Signed-off-by: Jianfeng Tan <[email protected]>

show more ...


Revision tags: v17.08, v17.08-rc4, v17.08-rc3, v17.08-rc2, v17.08-rc1
# 24c7008f 11-May-2017 John McNamara <[email protected]>

doc: change line length limit in contributors guide

The DPDK documentation guidelines state that lines should be wrapped as
follows:

* The recommended style for the DPDK documentation is to put sen

doc: change line length limit in contributors guide

The DPDK documentation guidelines state that lines should be wrapped as
follows:

* The recommended style for the DPDK documentation is to put sentences on
separate lines. This allows for easier reviewing of patches. ...
* Long sentences should be wrapped at 120 characters +/- 10 characters.
They should be wrapped at words.

http://dpdk.org/doc/guides/contributing/documentation.html#line-length

However, in practice, users almost never submit doc patches in this format.
Instead most users wrap their doc patches at 80 characters.

This patch updates the documentation contributors guide to reflect this
as the recommended guideline.

Signed-off-by: John McNamara <[email protected]>
Reviewed-by: Yuanhan Liu <[email protected]>
Reviewed-by: Shreyansh Jain <[email protected]>

show more ...


Revision tags: v17.05, v17.05-rc4, v17.05-rc3, v17.05-rc2, v17.05-rc1
# 35b09d76 27-Feb-2017 Keith Wiles <[email protected]>

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 <[email protected]>
Acked-by: John McNamara <[email protected]>

show more ...


Revision tags: v17.02, v17.02-rc3, v17.02-rc2, v17.02-rc1
# bc474e72 09-Dec-2016 Yong Wang <[email protected]>

doc: fix mistakes in contribution guide

Signed-off-by: Yong Wang <[email protected]>
Acked-by: John McNamara <[email protected]>


# a56d1d55 06-Dec-2016 Yong Wang <[email protected]>

doc: remove repeated words in contribution guide

Signed-off-by: Yong Wang <[email protected]>
Acked-by: John McNamara <[email protected]>


Revision tags: v16.11, v16.11-rc3, v16.11-rc2, v16.11-rc1
# 58c82067 06-Oct-2016 Thomas Monjalon <[email protected]>

app/testpmd: use consistent vdev names

The vdev eth_bond has been renamed to net_bond.
testpmd is creating a bonding device with the old prefix.
It is changed for consistency.

The script test-null.

app/testpmd: use consistent vdev names

The vdev eth_bond has been renamed to net_bond.
testpmd is creating a bonding device with the old prefix.
It is changed for consistency.

The script test-null.sh was failing because using the old name
for the null vdev.

Fixes also the bonding and testpmd doc.

Fixes: 2f45703c17ac ("drivers: make driver names consistent")

Signed-off-by: Thomas Monjalon <[email protected]>
Acked-by: Pablo de Lara <[email protected]>

show more ...


# 5fc07e3e 06-Oct-2016 Thomas Monjalon <[email protected]>

app/test: fix vdev names

The vdev eth_ring has been renamed to net_ring.
Some unit tests are using the old name and fail.

Fixes also the vdev comments in EAL and ethdev.

Fixes: 2f45703c17ac ("driv

app/test: fix vdev names

The vdev eth_ring has been renamed to net_ring.
Some unit tests are using the old name and fail.

Fixes also the vdev comments in EAL and ethdev.

Fixes: 2f45703c17ac ("drivers: make driver names consistent")

Signed-off-by: Thomas Monjalon <[email protected]>
Acked-by: Pablo de Lara <[email protected]>

show more ...


Revision tags: v16.07, v16.07-rc5, v16.07-rc4
# 4b677a3b 17-Jul-2016 John McNamara <[email protected]>

doc: update sphinx installation instructions

Update the Sphinx installation instructions in the documentation
contributors guide to reflect the fact that in the 1.4+ versions
of Sphinx the ReadTheDo

doc: update sphinx installation instructions

Update the Sphinx installation instructions in the documentation
contributors guide to reflect the fact that in the 1.4+ versions
of Sphinx the ReadTheDocs theme must also be installed. Previously,
in version 1.3.x, it was installed by default.

Also change 'yum' to 'dnf' for package installations.

Signed-off-by: John McNamara <[email protected]>

show more ...


12