From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>,
Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH v2] devtools: clarify that lines up to 100 characters are ok
Date: Wed, 20 Oct 2021 15:26:01 +0100 [thread overview]
Message-ID: <20211020142601.157649-1-bruce.richardson@intel.com> (raw)
In-Reply-To: <20211020134840.2421686-1-bruce.richardson@intel.com>
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 <bruce.richardson@intel.com>
---
V2: update the checkpatches default and the docs.
---
.editorconfig | 3 ++-
devtools/checkpatches.sh | 2 +-
doc/guides/contributing/coding_style.rst | 2 +-
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/.editorconfig b/.editorconfig
index 5101630c8c..ab41c95085 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -11,11 +11,12 @@ trim_trailing_whitespace = true
charset = utf-8
indent_style = tab
tab_width = 8
-max_line_length = 80
+max_line_length = 100
[*.py]
indent_style = space
indent_size = 4
+max_line_length = 79
[meson.build]
indent_style = space
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index c314d83a29..205b8a52bf 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -15,7 +15,7 @@ VALIDATE_NEW_API=$(dirname $(readlink -f $0))/check-symbol-change.sh
# Codespell can also be enabled by setting DPDK_CHECKPATCH_CODESPELL to a valid path
# to a dictionary.txt file if dictionary.txt is not in the default location.
codespell=${DPDK_CHECKPATCH_CODESPELL:-enable}
-length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
+length=${DPDK_CHECKPATCH_LINE_LENGTH:-100}
# override default Linux options
options="--no-tree"
diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index b27b5fcfdb..1ce5d00e36 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -27,7 +27,7 @@ Line length is recommended to be not more than 80 characters, including comments
.. note::
The above is recommendation, and not a hard limit.
- However, it is expected that the recommendations should be followed in all but the rarest situations.
+ Generally, line lengths up to 100 characters are acceptable in the code.
C Comment Style
---------------
--
2.32.0
next prev parent reply other threads:[~2021-10-20 14:26 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-20 13:48 [dpdk-dev] [PATCH] editorconfig: bump line length to 100 Bruce Richardson
2021-10-20 13:57 ` Andrew Rybchenko
2021-10-20 14:11 ` Bruce Richardson
2021-10-20 14:14 ` Bruce Richardson
2021-10-20 14:26 ` Bruce Richardson [this message]
2021-10-20 14:28 ` [dpdk-dev] [PATCH v2] devtools: clarify that lines up to 100 characters are ok Andrew Rybchenko
2021-10-22 0:11 ` Jerin Jacob
2021-11-25 10:51 ` Thomas Monjalon
2021-10-22 8:21 ` Xia, Chenbo
2021-10-26 0:30 ` fengchengwen
2021-10-28 13:14 ` Walsh, Conor
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211020142601.157649-1-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).