Re: [PATCH] docs: sphinx: add missing SPDX tags

[Mauro Carvalho Chehab <mchehab+huawei@kernel.org>]

Em Wed, 25 Jun 2025 12:41:01 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > Several Sphinx extensions and tools are missing SPDX tags.
> > Add them.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  Documentation/sphinx/cdomain.py           | 1 +
> >  Documentation/sphinx/kernel_include.py    | 1 +
> >  Documentation/sphinx/kerneldoc.py         | 1 +
> >  Documentation/sphinx/kfigure.py           | 1 +
> >  Documentation/sphinx/load_config.py       | 1 +
> >  Documentation/sphinx/min_requirements.txt | 1 +
> >  Documentation/sphinx/parse-headers.pl     | 5 ++++-
> >  Documentation/sphinx/requirements.txt     | 1 +
> >  Documentation/sphinx/rstFlatTable.py      | 1 +
> >  9 files changed, 12 insertions(+), 1 deletion(-)  
> 
> I've applied this, but the patch led me to wonder...

Thanks!

> 
> > diff --git a/Documentation/sphinx/cdomain.py b/Documentation/sphinx/cdomain.py
> > index e8ea80d4324c..3dc285dc70f5 100644
> > --- a/Documentation/sphinx/cdomain.py
> > +++ b/Documentation/sphinx/cdomain.py
> > @@ -1,4 +1,5 @@
> >  # -*- coding: utf-8; mode: python -*-  
> 
> Do we really need these lines?  UTF8 should be the default almost
> anywhere, and Emacs understands that a .py file will require Python
> mode...

Heh, I had the same filling when I saw that. I almost dropped ;-)

perhaps we could run some linters on it and so some cleanups,
inclusing the removal of those, placing instead some copyright
notes on the top of it... well, there are already copyrights there
(and at the other Sphinx extensions). In this specific case:

"""
    cdomain
    ~~~~~~~

    Replacement for the sphinx c-domain.

    :copyright:  Copyright (C) 2016  Markus Heiser
    :license:    GPL Version 2, June 1991 see Linux/COPYING for details.

So, not sure about it. What do you think?

Thanks,
Mauro