From: Jonathan Corbet <corbet@lwn.net>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux Kernel Tracing <linux-trace-kernel@vger.kernel.org>
Cc: Steven Rostedt <rostedt@goodmis.org>,
Tomas Glozar <tglozar@redhat.com>,
Crystal Wood <crwood@redhat.com>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Gopi Krishna Menon <krishnagopi487@gmail.com>
Subject: Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
Date: Fri, 17 Oct 2025 14:27:01 -0600 [thread overview]
Message-ID: <87zf9pz33e.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20251013092719.30780-2-bagasdotme@gmail.com>
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> From: Gopi Krishna Menon <krishnagopi487@gmail.com>
>
> Sphinx reports htmldocs errors:
>
> Documentation/tools/rtla/common_options.rst:58: ERROR: Undefined substitution referenced: "threshold".
> Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tool".
> Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "thresharg".
> Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tracer".
> Documentation/tools/rtla/common_options.rst:92: ERROR: Undefined substitution referenced: "tracer".
> Documentation/tools/rtla/common_options.rst:98: ERROR: Undefined substitution referenced: "actionsperf".
> Documentation/tools/rtla/common_options.rst:113: ERROR: Undefined substitution referenced: "tool".
>
> common_*.rst files are snippets that are intended to be included by rtla
> docs (rtla*.rst). common_options.rst in particular contains
> substitutions which depend on other common_* includes, so building it
> independently as reST source results in above errors.
>
> Rename all common_*.rst files to common_*.txt to prevent Sphinx from
> building these snippets as standalone reST source and update all include
> references accordingly.
Applied, thanks.
jon
next prev parent reply other threads:[~2025-10-17 20:27 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-13 9:27 [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Bagas Sanjaya
2025-10-14 3:39 ` Randy Dunlap
2025-10-17 20:27 ` Jonathan Corbet [this message]
2025-10-18 5:49 ` Bagas Sanjaya
2025-10-18 14:20 ` Jonathan Corbet
2025-10-18 14:30 ` Bagas Sanjaya
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=87zf9pz33e.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=bagasdotme@gmail.com \
--cc=crwood@redhat.com \
--cc=krishnagopi487@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=tglozar@redhat.com \
/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