linux-kernel - Re: [PATCH v2 12/12] docs: conf.py: don't handle yaml files outside Netlink specs

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: <20250613143030.3f78f367@foz.lan>
Date: Fri, 13 Jun 2025 14:30:30 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Donald Hunter <donald.hunter@...il.com>
Cc: Linux Doc Mailing List <linux-doc@...r.kernel.org>, Jonathan Corbet
 <corbet@....net>, "Akira Yokosawa" <akiyks@...il.com>, "Breno Leitao"
 <leitao@...ian.org>, "David S. Miller" <davem@...emloft.net>, "Eric
 Dumazet" <edumazet@...gle.com>, "Ignacio Encinas Rubio"
 <ignacio@...cinas.com>, "Jan Stancek" <jstancek@...hat.com>, "Marco Elver"
 <elver@...gle.com>, "Paolo Abeni" <pabeni@...hat.com>, "Ruben Wauters"
 <rubenru09@....com>, "Shuah Khan" <skhan@...uxfoundation.org>,
 joel@...lfernandes.org, linux-kernel-mentees@...ts.linux.dev,
 linux-kernel@...r.kernel.org, lkmm@...ts.linux.dev, netdev@...r.kernel.org,
 peterz@...radead.org, stern@...land.harvard.edu
Subject: Re: [PATCH v2 12/12] docs: conf.py: don't handle yaml files outside
 Netlink specs

Em Fri, 13 Jun 2025 12:52:35 +0100
Donald Hunter <donald.hunter@...il.com> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:
> 
> > The parser_yaml extension already has a logic to prevent
> > handing all yaml documents. However, if we don't also exclude
> > the patterns at conf.py, the build time would increase a lot,
> > and warnings like those would be generated:
> >
> >     Documentation/netlink/genetlink.yaml: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/genetlink-c.yaml: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/genetlink-legacy.yaml: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/index.rst: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/netlink-raw.yaml: WARNING: o documento não está incluído em nenhum toctree
> >
> > Add some exclusion rules to prevent that.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> > ---
> >  Documentation/conf.py | 6 +++++-
> >  1 file changed, 5 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/conf.py b/Documentation/conf.py
> > index add6ce78dd80..b8668bcaf090 100644
> > --- a/Documentation/conf.py
> > +++ b/Documentation/conf.py
> > @@ -222,7 +222,11 @@ language = 'en'
> >  
> >  # List of patterns, relative to source directory, that match files and
> >  # directories to ignore when looking for source files.
> > -exclude_patterns = ['output']
> > +exclude_patterns = [
> > +	'output',
> > +	'devicetree/bindings/**.yaml',
> > +	'netlink/*.yaml',
> > +]  
> 
> Please merge this with the earlier patch that changes these lines so
> that the series doesn't contain unnecessary intermediate steps.

OK.

> 
> >  # The reST default role (used for this markup: `text`) to use for all
> >  # documents.  

Thanks,
Mauro