linux-kernel - Re: [PATCH v3 14/15] docs: conf.py: several coding style fixes

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250622234109.1aecc840@foz.lan>
Date: Sun, 22 Jun 2025 23:41:09 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: Linux Doc Mailing List <linux-doc@...r.kernel.org>, Akira Yokosawa
 <akiyks@...il.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 14/15] docs: conf.py: several coding style fixes

Em Sun, 22 Jun 2025 14:55:26 -0600
Jonathan Corbet <corbet@....net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:
> 
> > conf.py is missing a SPDX header and doesn't really have
> > a proper python coding style. It also has an obsolete
> > commented LaTeX syntax that doesn't work anymore.
> >
> > Clean it up a little bit with some help from autolints
> > and manual adjustments.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> > ---
> >  Documentation/conf.py | 351 +++++++++++++++++++++---------------------
> >  1 file changed, 172 insertions(+), 179 deletions(-)  
> 
> This file is definitely getting out of hand...:)

Yes. I almost removed all commented code to make it a little more
palatable.

> I notice a lot of the changes are just from 'single quotes' to "double
> quotes".  That adds a lot of churn; is there a reason for it?

Those churns are from black/autopep8, which also addressed other 
coding style issues(*).

I don't mind much about using either single or double quote, but
having a standard is a good thing. At the plus side, as C uses 
double quotes for strings this is closer to the kernel coding style.

So, I opted to merge such changes from the lint tools.

(*) I didn't blidnly accept all coding style changes from linters,
    dropping the ones that would make the final code worse.

Thanks,
Mauro