linux-kernel - Re: [PATCH] Documentation: tools/rtla: remove undefined substitutions in 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: <68a739f3-5484-4846-b87f-94a7ce306e43@infradead.org>
Date: Fri, 28 Nov 2025 13:43:41 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Sameeksha Sankpal <sameekshasankpal@...il.com>, rostedt@...dmis.org,
 corbet@....net
Cc: linux-trace-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation: tools/rtla: remove undefined substitutions
 in common_options.rst

Hi,

On 11/28/25 7:18 AM, Sameeksha Sankpal wrote:
> The RTLA common options documentation uses several Sphinx substitution
> placeholders (|threshold|, |tool|, |thresharg|, |tracer|, |actionsperf|)
> that are not defined anywhere in the tree. This causes the htmldocs
> build to fail with multiple "Undefined substitution" errors.
> 
> Replace these undefined substitutions with plain text or generic
> placeholders (<tool>, <threshold-option>, <tracer>) to ensure the
> documentation builds cleanly while preserving the intended meaning of
> the examples.
> 
> Signed-off-by: Sameeksha Sankpal <sameekshasankpal@...il.com>
> ---
>  Documentation/tools/rtla/common_options.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/tools/rtla/common_options.rst
> index 77ef35d3f831..bd5a6f32f5bf 100644
> --- a/Documentation/tools/rtla/common_options.rst
> +++ b/Documentation/tools/rtla/common_options.rst

Does this patch apply to the mainline (Linus) kernel?
This is already fixed in linux-next or docs-next.
You should usually check -next trees for fixes like this.

See:

commit 96b546c241b1
Author: Gopi Krishna Menon <krishnagopi487@...il.com>
Date:   Mon Oct 13 16:27:20 2025 +0700
    Documentation/rtla: rename common_xxx.rst files to common_xxx.txt

Thanks.
-- 
~Randy