mirror of
git://git.yoctoproject.org/linux-yocto.git
synced 2026-03-11 03:30:36 +01:00
ce1d0f5c7b
commit 96b546c241b11a97ba1247580208c554458e7866 upstream.
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@redhat.com>
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
Reviewed-by: Tomas Glozar <tglozar@redhat.com>
Fixes:
|
||
|---|---|---|
| .. | ||
| common_appendix.txt | ||
| common_hist_options.txt | ||
| common_options.txt | ||
| common_osnoise_description.txt | ||
| common_osnoise_options.txt | ||
| common_timerlat_aa.txt | ||
| common_timerlat_description.txt | ||
| common_timerlat_options.txt | ||
| common_top_options.txt | ||
| index.rst | ||
| Makefile | ||
| rtla-hwnoise.rst | ||
| rtla-osnoise-hist.rst | ||
| rtla-osnoise-top.rst | ||
| rtla-osnoise.rst | ||
| rtla-timerlat-hist.rst | ||
| rtla-timerlat-top.rst | ||
| rtla-timerlat.rst | ||
| rtla.rst | ||