On Tue, 1 Apr 2025 16:45:45 -0700 Nandini Persad <nandinipersad...@gmail.com> wrote:
> I'm reviewing the Contributor's Guidelines to be more > clear and concise where necessary. > > Signed-off-by: Nandini Persad <nandinipersad...@gmail.com> > --- > doc/guides/contributing/coding_style.rst | 105 +++++++++++------------ > doc/guides/contributing/design.rst | 9 +- > doc/guides/contributing/new_library.rst | 31 ++++--- > 3 files changed, 77 insertions(+), 68 deletions(-) > > diff --git a/doc/guides/contributing/coding_style.rst > b/doc/guides/contributing/coding_style.rst > index 1ebc79ca3c..c465bd0f1f 100644 > --- a/doc/guides/contributing/coding_style.rst > +++ b/doc/guides/contributing/coding_style.rst > @@ -15,14 +15,13 @@ It is based on the Linux Kernel coding guidelines and the > FreeBSD 7.2 Kernel Dev > General Guidelines > ------------------ > > -The rules and guidelines given in this document cannot cover every > situation, so the following general guidelines should be used as a fallback: > +This document's rules and guidelines cannot cover every scenario, so the > following general principles > +should be used as a fallback. > > -* The code style should be consistent within each individual file. > -* In the case of creating new files, the style should be consistent within > each file in a given directory or module. > -* The primary reason for coding standards is to increase code readability > and comprehensibility, therefore always use whatever option will make the > code easiest to read. > - > -Line length is recommended to be not more than 80 characters, including > comments. > -[Tab stop size should be assumed to be 8-characters wide]. > +* Maintain a consistent coding style within each file. > +* When creating new files, ensure consistency with other files in the same > directory or module. > +* Prioritize readability and clarity. Choose the style that makes the code > easiest to read. > +* Keep line length within 80 characters, including comments. Assume a tab > stop size of 8 characters. DPDK has updated to allow up to 100 characters (happened in last year or so).
