[v2] 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 <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(-)
  

On 10/20/21 5:26 PM, Bruce Richardson wrote:
> 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>

Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
  

On Wed, Oct 20, 2021 at 7:58 PM Andrew Rybchenko
<andrew.rybchenko@oktetlabs.ru> wrote:
>
> On 10/20/21 5:26 PM, Bruce Richardson wrote:
> > 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>
>
> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>

Acked-by: Jerin Jacob <jerinj@marvell.com>


>
  

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Bruce Richardson
> Sent: Wednesday, October 20, 2021 10:26 PM
> To: dev@dpdk.org
> Cc: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>; Richardson, Bruce
> <bruce.richardson@intel.com>
> Subject: [dpdk-dev] [PATCH v2] 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 <bruce.richardson@intel.com>
> ---
> 2.32.0

Glad to see this :)

Acked-by: Chenbo Xia <chenbo.xia@intel.com>
  

On 2021/10/20 22:26, Bruce Richardson wrote:
> 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>

Acked-by: Chengwen Feng <fengchengwen@huawei.com>
  

> From: dev <dev-bounces@dpdk.org> On Behalf Of Bruce Richardson
> Sent: Wednesday 20 October 2021 15:26
> To: dev@dpdk.org
> Cc: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>; Richardson,
> Bruce <bruce.richardson@intel.com>
> Subject: [dpdk-dev] [PATCH v2] 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 <bruce.richardson@intel.com>
> ---

I think it would be great to have clarity around this, since it seems to already be allowed.
Acked-by: Conor Walsh <conor.walsh@intel.com>
  

22/10/2021 02:11, Jerin Jacob:
> On Wed, Oct 20, 2021 at 7:58 PM Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru> wrote:
> > On 10/20/21 5:26 PM, Bruce Richardson wrote:
> > > 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>
> >
> > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Acked-by: Chenbo Xia <chenbo.xia@intel.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
Acked-by: Conor Walsh <conor.walsh@intel.com>

As long as we keep a preference/recommandation for 80 chars, I'm fine.
In general I like short lines, but I dislike some "forced" wrapping.
So allowing for longer lines and trusting authors to do what fits best
is a good call.

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks.