History log of /dpdk/doc/guides/contributing/coding_style.rst (Results 1 – 25 of 35)
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
# cadb255e 16-Dec-2021 Bruce Richardson <[email protected]>

eal: add OS defines for C conditional checks

Define a set of macros in the build configuration to allow C runtime
code to check the current OS environment. This saves the user having to
use ifdefs f

eal: add OS defines for C conditional checks

Define a set of macros in the build configuration to allow C runtime
code to check the current OS environment. This saves the user having to
use ifdefs for e.g. disabling particular tests on Windows.
See included documentation changes for usage examples.

Signed-off-by: Bruce Richardson <[email protected]>
Acked-by: Dmitry Kozlyuk <[email protected]>
Acked-by: Jerin Jacob <[email protected]>

show more ...


Revision tags: v21.11, v21.11-rc4, v21.11-rc3, v21.11-rc2
# 6965091e 29-Oct-2021 Dariusz Sosnowski <[email protected]>

doc: fix typo in coding style

This patch fixes a typo in DPDK Coding Style, in Return Values section,
i.e. replaces "indicated may" with "indicated by".

Fixes: 36032e46be40 ("doc: add coding style"

doc: fix typo in coding style

This patch fixes a typo in DPDK Coding Style, in Return Values section,
i.e. replaces "indicated may" with "indicated by".

Fixes: 36032e46be40 ("doc: add coding style")
Cc: [email protected]

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

show more ...


Revision tags: v21.11-rc1
# 8f86ffa6 20-Oct-2021 Bruce Richardson <[email protected]>

devtools: clarify that lines up to 100 characters are ok

Since we allow line lengths of up to 100, and the CI checkpatches job
only check for that amount, the rest of our tooling and docs should
ref

devtools: clarify that lines up to 100 characters are ok

Since we allow line lengths of up to 100, and the CI checkpatches job
only check for that amount, the rest of our tooling and docs should
reflect this reality. Therefore we can:

* adjust the editorconfig to use that value, to save editors (e.g. vim)
from automatically wrapping lines at 80 characters when typing.
[Since python checkers all seem to expect 79 character lines max, add
for python only a 79-char max line length.]

* change the default line length setting in checkpatches script to 100
so as it matches CI and pre-merge checks.

* update the docs to clarify that while 80 chars is recommended, up to
100 characters is acceptable.

Signed-off-by: Bruce Richardson <[email protected]>
Acked-by: Andrew Rybchenko <[email protected]>
Acked-by: Jerin Jacob <[email protected]>
Acked-by: Chenbo Xia <[email protected]>
Acked-by: Chengwen Feng <[email protected]>
Acked-by: Conor Walsh <[email protected]>
Acked-by: Thomas Monjalon <[email protected]>

show more ...


# dad3fd5f 15-Sep-2021 Bruce Richardson <[email protected]>

doc: add line continuation note in Meson coding style

Add a note for the preference of using "()" rather than "\" for line
continuations in Meson.

Suggested-by: David Marchand <david.marchand@redha

doc: add line continuation note in Meson coding style

Add a note for the preference of using "()" rather than "\" for line
continuations in Meson.

Suggested-by: David Marchand <[email protected]>
Signed-off-by: Bruce Richardson <[email protected]>
Reviewed-by: David Marchand <[email protected]>

show more ...


Revision tags: v21.08, v21.08-rc4, v21.08-rc3
# 9c30a6f3 29-Jul-2021 Henry Nadeau <[email protected]>

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: [email protected]

Signed-off-by: Henry Nadeau <[email protected]>

show more ...


Revision tags: v21.08-rc2, v21.08-rc1, v21.05, v21.05-rc4, v21.05-rc3, 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 ...


# f2cdd95f 20-Apr-2021 Bruce Richardson <[email protected]>

doc: add Meson coding style to contributors guide

To help with consistency across all files, add a section to the
contributors guide on meson coding style. Although short, this covers
the basics for

doc: add Meson coding style to contributors guide

To help with consistency across all files, add a section to the
contributors guide on meson coding style. Although short, this covers
the basics for now, and can be extended in future as we see the need.

Meson style guide recommends four-space indents, like for python,
so add to editorconfig file.

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

show more ...


# bc461743 25-Feb-2021 Bruce Richardson <[email protected]>

build: enable a developer mode setting

To allow support for additional build checks and tests only really
relevant for developers, we add support for a developer mode option to
DPDK. The default, "a

build: enable a developer mode setting

To allow support for additional build checks and tests only really
relevant for developers, we add support for a developer mode option to
DPDK. The default, "auto", value for this enables developer mode if a
".git" folder is found at the root of the source tree - as was the case
with the previous "make" build system. There is also support for
explicitly enabling or disabling this option using "meson configure" if
so desired.

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

show more ...


Revision tags: v21.02, v21.02-rc4, v21.02-rc3, v21.02-rc2
# 05050ac4 29-Jan-2021 Bruce Richardson <[email protected]>

build: add header includes check

To verify that all DPDK headers are ok for inclusion directly in a C file,
and are not missing any other pre-requisite headers, we can auto-generate
for each header

build: add header includes check

To verify that all DPDK headers are ok for inclusion directly in a C file,
and are not missing any other pre-requisite headers, we can auto-generate
for each header an empty C file that includes that header. Compiling these
files will throw errors if any header has unmet dependencies.

For some libraries, there may be some header files which are not for direct
inclusion, but rather are to be included via other header files. To allow
later checking of these files for missing includes, we separate out the
indirect include files from the direct ones.

To ensure ongoing compliance, we enable this build test as part of the
default x86 build in "test-meson-builds.sh".

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

show more ...


Revision tags: v21.02-rc1, v20.11, v20.11-rc5, v20.11-rc4, v20.11-rc3, v20.11-rc2
# 30105f66 22-Oct-2020 David Marchand <[email protected]>

drivers: add headers install helper

A lot of drivers export headers, reproduce the same facility than for
libraries.

Note: this change fixes an issue with the crypto scheduler headers which
were no

drivers: add headers install helper

A lot of drivers export headers, reproduce the same facility than for
libraries.

Note: this change fixes an issue with the crypto scheduler headers which
were not installed properly. A separate backport will be sent to stable
branches.

Suggested-by: Bruce Richardson <[email protected]>
Signed-off-by: David Marchand <[email protected]>
Acked-by: Bruce Richardson <[email protected]>

show more ...


Revision tags: v20.11-rc1
# cb056611 15-Oct-2020 Stephen Hemminger <[email protected]>

eal: rename lcore master and slave

Replace master lcore with main lcore and
replace slave lcore with worker lcore.

Keep the old functions and macros but mark them as deprecated
for this release.

T

eal: rename lcore master and slave

Replace master lcore with main lcore and
replace slave lcore with worker lcore.

Keep the old functions and macros but mark them as deprecated
for this release.

The "--master-lcore" command line option is also deprecated
and any usage will print a warning and use "--main-lcore"
as replacement.

Signed-off-by: Stephen Hemminger <[email protected]>
Acked-by: Anatoly Burakov <[email protected]>

show more ...


# 57c789fd 15-Oct-2020 Stephen Hemminger <[email protected]>

doc: add policy about master/slave words

Update the coding style document to include a policy against
introducing new master/slave usage. This is taken from the similar
place in the Linux kernel cod

doc: add policy about master/slave words

Update the coding style document to include a policy against
introducing new master/slave usage. This is taken from the similar
place in the Linux kernel coding style.

Signed-off-by: Stephen Hemminger <[email protected]>
Acked-by: Anatoly Burakov <[email protected]>

show more ...


# 3f6f8362 30-Sep-2020 Louise Kilheeney <[email protected]>

support python 3 only

Changed scripts to explicitly use Python 3 only, to avoid
maintaining Python 2.
Removed deprecation notices.

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

support python 3 only

Changed scripts to explicitly use Python 3 only, to avoid
maintaining Python 2.
Removed deprecation notices.

Signed-off-by: Louise Kilheeney <[email protected]>
Signed-off-by: Kevin Laatz <[email protected]>
Acked-by: Bruce Richardson <[email protected]>
Acked-by: Robin Jarry <[email protected]>
Acked-by: Stephen Hemminger <[email protected]>
Acked-by: Ray Kinsella <[email protected]>

show more ...


# 3cc6ecfd 03-Sep-2020 Ciara Power <[email protected]>

build: remove makefiles

A decision was made [1] to no longer support Make in DPDK, this patch
removes all Makefiles that do not make use of pkg-config, along with
the mk directory previously used by

build: remove makefiles

A decision was made [1] to no longer support Make in DPDK, this patch
removes all Makefiles that do not make use of pkg-config, along with
the mk directory previously used by make.

[1] https://mails.dpdk.org/archives/dev/2020-April/162839.html

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

show more ...


Revision tags: v20.08, v20.08-rc4, v20.08-rc3, v20.08-rc2
# 525d8031 14-Jul-2020 Stephen Hemminger <[email protected]>

devtools: add new SPDX license compliance checker

Simple script to look for drivers and scripts that
are missing requires SPDX header.

Signed-off-by: Stephen Hemminger <[email protected]>


Revision tags: v20.08-rc1, v20.05, v20.05-rc4, v20.05-rc3, v20.05-rc2, v20.05-rc1
# acec04c4 13-Apr-2020 Pavan Nikhilesh <[email protected]>

build: disable experimental API check internally

Remove setting ALLOW_EXPERIMENTAL_API individually for each Makefile and
meson.build. Instead, enable ALLOW_EXPERIMENTAL_API flag across app, lib
and

build: disable experimental API check internally

Remove setting ALLOW_EXPERIMENTAL_API individually for each Makefile and
meson.build. Instead, enable ALLOW_EXPERIMENTAL_API flag across app, lib
and drivers.
This changes reduces the clutter across the project while still
maintaining the functionality of ALLOW_EXPERIMENTAL_API i.e. warning
external applications about experimental API usage.

Signed-off-by: Pavan Nikhilesh <[email protected]>
Acked-by: Hemant Agrawal <[email protected]>
Signed-off-by: David Marchand <[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
# cba806e0 20-Nov-2019 Marcin Baran <[email protected]>

build: change ABI versioning to global

As per new ABI policy [1], all of the libraries are now versioned using
one global ABI version. Stable libraries use the MAJOR.MINOR ABI
version for their shar

build: change ABI versioning to global

As per new ABI policy [1], all of the libraries are now versioned using
one global ABI version. Stable libraries use the MAJOR.MINOR ABI
version for their shared objects, while experimental libraries
use the 0.MAJORMINOR convention for their versioning.
Experimental library versioning is managed globally. Changes in this
patch implement the necessary steps to enable that.

The CONFIG_RTE_MAJOR_ABI option was introduced to permit multiple
DPDK versions installed side by side. The problem is now addressed
through the new ABI policy, and thus can be removed.

[David] For external libraries relying on Makefile, LIBABIVER is
preserved to avoid using DPDK global ABI version.

[1] https://doc.dpdk.org/guides/contributing/abi_policy.html

Signed-off-by: Marcin Baran <[email protected]>
Signed-off-by: Pawel Modrak <[email protected]>
Signed-off-by: Anatoly Burakov <[email protected]>
Acked-by: Bruce Richardson <[email protected]>
Signed-off-by: David Marchand <[email protected]>
Acked-by: Thomas Monjalon <[email protected]>

show more ...


# f43d3dbb 12-Nov-2019 David Marchand <[email protected]>

doc/guides: clean repeated words

Shoot repeated words in all our guides.

Cc: [email protected]

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


Revision tags: v19.11-rc2, v19.11-rc1
# a5d4ea59 07-Oct-2019 Bruce Richardson <[email protected]>

build: support building ABI versioned files twice

Any file with ABI versioned functions needs different macros for shared and
static builds, so we need to accommodate that. Rather than building
ever

build: support building ABI versioned files twice

Any file with ABI versioned functions needs different macros for shared and
static builds, so we need to accommodate that. Rather than building
everything twice, we just flag to the build system which libraries need
that handling, by setting use_function_versioning in the meson.build files.

To ensure we don't get silent errors at build time due to this meson flag
being missed, we add an explicit error to the function versioning header
file if a known C macro is not defined. Since "make" builds always only
build one of shared or static libraries, this define can be always set, and
so is added to the global CFLAGS. For meson, the build flag - and therefore
the C define - is set for the three libraries that need the function
versioning: "distributor", "lpm" and "timer".

Signed-off-by: Bruce Richardson <[email protected]>
Acked-by: Stephen Hemminger <[email protected]>
Tested-by: Andrzej Ostruszka <[email protected]>
Reviewed-by: Andrzej Ostruszka <[email protected]>

show more ...


Revision tags: v19.08, v19.08-rc4, v19.08-rc3, v19.08-rc2, v19.08-rc1
# 8baad6f8 05-Jun-2019 Bruce Richardson <[email protected]>

build: print list of disabled components

When configuring with meson we print out a list of enabled components, but
it is also useful to list out the disabled components and the reasons why.

Signed

build: print list of disabled components

When configuring with meson we print out a list of enabled components, but
it is also useful to list out the disabled components and the reasons why.

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

show more ...


Revision tags: v19.05, v19.05-rc4, v19.05-rc3, v19.05-rc2
# adf93ca5 09-Apr-2019 Bruce Richardson <[email protected]>

build: increase readability via shortcut variables

Define variables for "is_linux", "is_freebsd" and "is_windows"
to make the code shorter for comparisons and more readable.

Signed-off-by: Bruce Ri

build: increase readability via shortcut variables

Define variables for "is_linux", "is_freebsd" and "is_windows"
to make the code shorter for comparisons and more readable.

Signed-off-by: Bruce Richardson <[email protected]>
Reviewed-by: David Marchand <[email protected]>
Acked-by: Luca Boccassi <[email protected]>

show more ...


Revision tags: v19.05-rc1
# eeafaf40 15-Mar-2019 Rami Rosen <[email protected]>

doc: fix two typos in contributing guide

This patch fixes two typos in the coding style part of
DPDK contributing guide:

- The header entry should have .h file instead of .c file.
- The will->This

doc: fix two typos in contributing guide

This patch fixes two typos in the coding style part of
DPDK contributing guide:

- The header entry should have .h file instead of .c file.
- The will->This will

Fixes: 44a6dface13b ("doc: describe how to add new components")
Cc: [email protected]

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

show more ...


Revision tags: v19.02, v19.02-rc4, v19.02-rc3, v19.02-rc2, v19.02-rc1, v18.11, v18.11-rc5, v18.11-rc4, v18.11-rc3, v18.11-rc2, v18.11-rc1
# 904ffb2e 17-Sep-2018 Marko Kovacevic <[email protected]>

doc: add note about bool into coding style

Added a note into the coding style to
highlight the use of a bool within a struct

Signed-off-by: Marko Kovacevic <[email protected]>
Reviewed-by:

doc: add note about bool into coding style

Added a note into the coding style to
highlight the use of a bool within a struct

Signed-off-by: Marko Kovacevic <[email protected]>
Reviewed-by: Ferruh Yigit <[email protected]>

show more ...


# 9631253f 09-Oct-2018 Ferruh Yigit <[email protected]>

drivers/net: fix log type string

Syntax for log type string is "pmd.<subsystem>.<driver>[.<pmd_local>]"

Fixes: 3e92fd4e4ec0 ("net/bnxt: use dynamic log type")
Fixes: d7f4562ab10a ("net/bonding: con

drivers/net: fix log type string

Syntax for log type string is "pmd.<subsystem>.<driver>[.<pmd_local>]"

Fixes: 3e92fd4e4ec0 ("net/bnxt: use dynamic log type")
Fixes: d7f4562ab10a ("net/bonding: convert to dynamic logging")
Fixes: 6086ab3bb3d2 ("net/vdev_netvsc: introduce Hyper-V platform driver")
Fixes: 7db274b9ada2 ("doc: describe dynamic logging format")
Fixes: a10a988a0ba6 ("net/dpaa2: support dynamic logging")
Cc: [email protected]

Signed-off-by: Ferruh Yigit <[email protected]>
Acked-by: Stephen Hemminger <[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]>


12