From: Donald Hunter <donald.hunter@gmail.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
"Akira Yokosawa" <akiyks@gmail.com>,
"Breno Leitao" <leitao@debian.org>,
"David S. Miller" <davem@davemloft.net>,
"Eric Dumazet" <edumazet@google.com>,
"Ignacio Encinas Rubio" <ignacio@iencinas.com>,
"Jan Stancek" <jstancek@redhat.com>,
"Marco Elver" <elver@google.com>,
"Paolo Abeni" <pabeni@redhat.com>,
"Ruben Wauters" <rubenru09@aol.com>,
"Shuah Khan" <skhan@linuxfoundation.org>,
joel@joelfernandes.org, linux-kernel-mentees@lists.linux.dev,
linux-kernel@vger.kernel.org, lkmm@lists.linux.dev,
netdev@vger.kernel.org, peterz@infradead.org,
stern@rowland.harvard.edu
Subject: Re: [PATCH v3 12/16] docs: conf.py: don't handle yaml files outside Netlink specs
Date: Fri, 13 Jun 2025 14:06:24 +0100 [thread overview]
Message-ID: <m2ecvnlrjj.fsf@gmail.com> (raw)
In-Reply-To: <d4b8d090ce728fce9ff06557565409539a8b936b.1749812870.git.mchehab+huawei@kernel.org>
Mauro Carvalho Chehab <mchehab+huawei@kernel.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@kernel.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 drop this patch from the series.
> # The reST default role (used for this markup: `text`) to use for all
> # documents.
next prev parent reply other threads:[~2025-06-13 13:10 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-13 11:42 [PATCH v3 00/16] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 01/16] tools: ynl_gen_rst.py: create a top-level reference Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 02/16] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 03/16] docs: netlink: don't ignore generated rst files Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 04/16] tools: ynl_gen_rst.py: make the index parser more generic Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 05/16] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 06/16] scripts: lib: netlink_yml_parser.py: use classes Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 07/16] tools: ynl_gen_rst.py: do some coding style cleanups Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 08/16] scripts: netlink_yml_parser.py: improve index.rst generation Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 09/16] docs: sphinx: add a parser template for yaml files Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 10/16] docs: sphinx: parser_yaml.py: add Netlink specs parser Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 11/16] docs: use parser_yaml extension to handle Netlink specs Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 12/16] docs: conf.py: don't handle yaml files outside " Mauro Carvalho Chehab
2025-06-13 13:06 ` Donald Hunter [this message]
2025-06-13 11:42 ` [PATCH v3 13/16] docs: conf.py: add include_pattern to speedup Mauro Carvalho Chehab
2025-06-13 13:02 ` Donald Hunter
2025-06-13 11:42 ` [PATCH v3 14/16] docs: uapi: netlink: update netlink specs link Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 15/16] MAINTAINERS: add maintainers for netlink_yml_parser.py Mauro Carvalho Chehab
2025-06-13 11:42 ` [PATCH v3 16/16] docs: Makefile: disable check rules on make cleandocs Mauro Carvalho Chehab
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=m2ecvnlrjj.fsf@gmail.com \
--to=donald.hunter@gmail.com \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=elver@google.com \
--cc=ignacio@iencinas.com \
--cc=joel@joelfernandes.org \
--cc=jstancek@redhat.com \
--cc=leitao@debian.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=lkmm@lists.linux.dev \
--cc=mchehab+huawei@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=peterz@infradead.org \
--cc=rubenru09@aol.com \
--cc=skhan@linuxfoundation.org \
--cc=stern@rowland.harvard.edu \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.