linux-kernel - Re: [PATCH v2] 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] [day] [month] [year] [list]

Message-ID: <CAP4=nvQT5xkOCvVK9J-aYMjwqPv=F8bJ6m1yj2W9OcUwwJw+7A@mail.gmail.com>
Date: Thu, 9 Oct 2025 16:26:56 +0200
From: Tomas Glozar <tglozar@...hat.com>
To: Gopi Krishna Menon <krishnagopi487@...il.com>
Cc: rostedt@...dmis.org, corbet@....net, linux-trace-kernel@...r.kernel.org, 
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, 
	skhan@...uxfoundation.org, david.hunter.linux@...il.com, khalid@...nel.org, 
	linux-kernel-mentees@...ts.linux.dev, crwood@...hat.com, 
	costa.shul@...hat.com, jkacur@...hat.com, 
	Bagas Sanjaya <bagasdotme@...il.com>
Subject: Re: [PATCH v2] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt

st 8. 10. 2025 v 20:45 odesílatel Gopi Krishna Menon
<krishnagopi487@...il.com> napsal:
>
> Running "make htmldocs" reports the following build errors for
> common_options.rst:
>
> 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 intended to be included by other rtla documents
> and are not meant to be built as a standalone document.
> common_options.rst in particular contains substitutions that are only
> resolved by other documents, so building it independently results in
> 'undefined substitution referenced' errors.
>
> Rename all common_*.rst files to common_*.txt to prevent Sphinx from
> building them as standalone documents and update all include references
> accordingly.
>
> Suggested-by: Tomas Glozar <tglozar@...hat.com>
> Suggested-by: Bagas Sanjaya <bagasdotme@...il.com>
> Signed-off-by: Gopi Krishna Menon <krishnagopi487@...il.com>
> ---

Looks good!

Reviewed-by: Tomas Glozar <tglozar@...hat.com>

Tomas