linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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 13/16] docs: conf.py: add include_pattern to speedup
Date: Fri, 13 Jun 2025 14:02:55 +0100	[thread overview]
Message-ID: <m2ikkzlrpc.fsf@gmail.com> (raw)
In-Reply-To: <62f2de3a195dc47ba6919721e460a8dd7ae95bc3.1749812870.git.mchehab+huawei@kernel.org>

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> Now that we have a parser for yaml, use include_pattern, adding
> just yaml files from the only directory we currently process.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/conf.py | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index b8668bcaf090..60e6998e49e1 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -222,10 +222,13 @@ language = 'en'
>  
>  # List of patterns, relative to source directory, that match files and
>  # directories to ignore when looking for source files.
> +include_patterns = [
> +	'**.rst',
> +	'netlink/specs/*.yaml',
> +]

It's unfortunate where you added the include patterns because the
adjacent comment is specific to exclude patterns. I suggest rewording
the comment to be relevant to both.

> +
>  exclude_patterns = [
>  	'output',
> -	'devicetree/bindings/**.yaml',
> -	'netlink/*.yaml',
>  ]
>  
>  # The reST default role (used for this markup: `text`) to use for all

  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
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 [this message]
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=m2ikkzlrpc.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).