linux-kernel - Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common

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: <aPMqTSbPucoqNhA1@archie.me>
Date: Sat, 18 Oct 2025 12:49:01 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Jonathan Corbet <corbet@....net>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Linux Kernel Tracing <linux-trace-kernel@...r.kernel.org>
Cc: Steven Rostedt <rostedt@...dmis.org>, Tomas Glozar <tglozar@...hat.com>,
	Crystal Wood <crwood@...hat.com>,
	Gopi Krishna Menon <krishnagopi487@...il.com>
Subject: Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to
 common_xxx.txt

On Fri, Oct 17, 2025 at 02:27:01PM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@...il.com> writes:
> 
> > From: Gopi Krishna Menon <krishnagopi487@...il.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.

Shouldn't this more appropriate as a fix for current cycle (6.18)? I see
the warnings on Linus's tree, though.

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)