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] [day] [month] [year] [list]

Message-ID: <80c32643-d2ac-4a12-a213-be4657cd6243@infradead.org>
Date: Mon, 13 Oct 2025 20:39:25 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 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: Daniel Bristot de Oliveira <bristot@...nel.org>,
 Steven Rostedt <rostedt@...dmis.org>, Jonathan Corbet <corbet@....net>,
 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 10/13/25 2:27 AM, Bagas Sanjaya wrote:
> 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.
> 
> Link: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
> Suggested-by: Tomas Glozar <tglozar@...hat.com>
> Suggested-by: Bagas Sanjaya <bagasdotme@...il.com>
> Signed-off-by: Gopi Krishna Menon <krishnagopi487@...il.com>
> Reviewed-by: Tomas Glozar <tglozar@...hat.com>
> Fixes: 05b7e10687c6 ("tools/rtla: Add remaining support for osnoise actions")
> Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>
> Link: https://lore.kernel.org/r/20251008184522.13201-1-krishnagopi487@gmail.com
> [Bagas: massage commit message and apply trailers]
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
> This patch targets trace/fixes branch of linux-trace.git tree.
> 
>  .../{common_appendix.rst => common_appendix.txt}     |  0
>  ...mmon_hist_options.rst => common_hist_options.txt} |  0
>  .../rtla/{common_options.rst => common_options.txt}  |  0
>  ...escription.rst => common_osnoise_description.txt} |  0
>  ...snoise_options.rst => common_osnoise_options.txt} |  0
>  ...common_timerlat_aa.rst => common_timerlat_aa.txt} |  0
>  ...scription.rst => common_timerlat_description.txt} |  0
>  ...erlat_options.rst => common_timerlat_options.txt} |  0
>  ...common_top_options.rst => common_top_options.txt} |  0
>  Documentation/tools/rtla/rtla-hwnoise.rst            |  8 ++++----
>  Documentation/tools/rtla/rtla-osnoise-hist.rst       | 10 +++++-----
>  Documentation/tools/rtla/rtla-osnoise-top.rst        | 10 +++++-----
>  Documentation/tools/rtla/rtla-osnoise.rst            |  4 ++--
>  Documentation/tools/rtla/rtla-timerlat-hist.rst      | 12 ++++++------
>  Documentation/tools/rtla/rtla-timerlat-top.rst       | 12 ++++++------
>  Documentation/tools/rtla/rtla-timerlat.rst           |  4 ++--
>  Documentation/tools/rtla/rtla.rst                    |  2 +-
>  17 files changed, 31 insertions(+), 31 deletions(-)
>  rename Documentation/tools/rtla/{common_appendix.rst => common_appendix.txt} (100%)
>  rename Documentation/tools/rtla/{common_hist_options.rst => common_hist_options.txt} (100%)
>  rename Documentation/tools/rtla/{common_options.rst => common_options.txt} (100%)
>  rename Documentation/tools/rtla/{common_osnoise_description.rst => common_osnoise_description.txt} (100%)
>  rename Documentation/tools/rtla/{common_osnoise_options.rst => common_osnoise_options.txt} (100%)
>  rename Documentation/tools/rtla/{common_timerlat_aa.rst => common_timerlat_aa.txt} (100%)
>  rename Documentation/tools/rtla/{common_timerlat_description.rst => common_timerlat_description.txt} (100%)
>  rename Documentation/tools/rtla/{common_timerlat_options.rst => common_timerlat_options.txt} (100%)
>  rename Documentation/tools/rtla/{common_top_options.rst => common_top_options.txt} (100%)


-- 
~Randy