[LTP] [PATCH 0/4] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[LTP] [PATCH 0/4] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[Petr Vorel]

Hi Andrea, all,

FYI I tested this in readthedocs.org. Therefore I pushed this branch as
readthedocs-ubuntu-26.04 to our upstream git repo [1]. Build worked [2]:

	Collecting sphinx==8.2.3 (from -r doc/requirements.txt (line 3))
	  Downloading sphinx-8.2.3-py3-none-any.whl.metadata (7.0 kB)
	Collecting sphinx-rtd-theme==3.1.0 (from -r doc/requirements.txt (line 4))
	  Downloading sphinx_rtd_theme-3.1.0-py2.py3-none-any.whl.metadata (4.5 kB)
	Collecting linuxdoc==20260504 (from -r doc/requirements.txt (line 6))
	  Downloading linuxdoc-20260504-py3-none-any.whl.metadata (5.3 kB)
	Collecting sphinxcontrib-spelling==8.0.2 (from -r doc/requirements.txt (line 7))
	  Downloading sphinxcontrib_spelling-8.0.2-py3-none-any.whl.metadata (2.9 kB)
	...
	Successfully installed docutils-0.21.2 fspath-20230629
	linuxdoc-20260504 pyenchant-3.3.0 roman-numerals-py-4.1.0 six-1.17.0
	sphinx-8.2.3 sphinx-rtd-theme-3.1.0 sphinxcontrib-jquery-4.1
	sphinxcontrib-spelling-8.0.2

I of course restore back the master branch and going to delete branch
readthedocs-ubuntu-26.04 after you have look at it.

We could also delete dependabot/pip/doc/setuptools-83.0.0 (branch bot
created without even asking, huh!), because CVE-2026-59890 (score 6.1)
is handled by 3rd commit.

Kind regards,
Petr

[1] https://github.com/linux-test-project/ltp/tree/readthedocs-ubuntu-26.04
[2] https://app.readthedocs.org/projects/linux-test-project/builds/33923113/
[3] https://github.com/linux-test-project/ltp/tree/dependabot/pip/doc/setuptools-83.0.0

Petr Vorel (4):
  readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3
  doc: Reduce default sphinx verbosity with -q
  doc: Update linuxdoc, sphinxcontrib-spelling
  tst_kvercmp.h: Further links to manpage

 .readthedocs.yml      |  2 +-
 doc/Makefile          | 11 +++++++++--
 doc/requirements.txt  | 11 ++++-------
 include/tst_kvercmp.h | 13 +++++++------
 4 files changed, 21 insertions(+), 16 deletions(-)

-- 
2.55.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

[LTP] [PATCH 1/4] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[Petr Vorel]

Update readthedocs.org environment + local requirements.txt
* Ubuntu 24.04 => 26.04
* Sphinx 7.2.6 => 8.2.3 (based on Ubuntu 26.04 version to match local
  development with readthedocs.org)
* sphinx-rtd-theme 2.0.0 => 3.1.0 (required by Sphinx 8.2.3 update)

This helps to use newer Sphinx features.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 .readthedocs.yml     | 2 +-
 doc/requirements.txt | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.readthedocs.yml b/.readthedocs.yml
index 51825da77f..bb70bce70d 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,7 +1,7 @@
 version: 2
 
 build:
-  os: "ubuntu-24.04"
+  os: "ubuntu-26.04"
   tools:
     python: "3.12"
   apt_packages:
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 442ff2eee6..f04676c7bd 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,7 +1,7 @@
 # Use the same sphinx as on readthedocs.org. When updated, make sure
 # sphinx-rtd-theme is compatible with sphinx.
-sphinx==7.2.6
-sphinx-rtd-theme==2.0.0
+sphinx==8.2.3
+sphinx-rtd-theme==3.1.0
 
 linuxdoc==20240924
 sphinxcontrib-spelling==7.7.0
-- 
2.55.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

[LTP] [PATCH 2/4] doc: Reduce default sphinx verbosity with -q

[Petr Vorel]

Guard sphinx -v opt with V=1 make variable. This will be useful for
linuxdoc update which uses Sphinx logging in this version.

Actually '-q' is needed because even without '-v' the output would get
over thousand of kernel-doc INFO level messages like:

    include/tst_test_macros.h:811: [kernel-doc INFO] : prototype --> '#define TST_EXP_EQ_LI_SILENT(VAL_A, VAL_B) \'
    include/tst_test_macros.h:815: [kernel-doc INFO] : scanning doc for: function 'TST_EXP_EQ_LU'
    include/tst_test_macros.h:817: [kernel-doc INFO] : section: @VAL_A
    include/tst_test_macros.h:818: [kernel-doc INFO] : section: @VAL_B

which would easily hide a real error.

While at it, use this also for 'spelling' make target.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/Makefile | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/doc/Makefile b/doc/Makefile
index 1da240530c..76248c3ed4 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -8,6 +8,13 @@ include $(top_srcdir)/include/mk/env_pre.mk
 PYTHON := python3
 VENV_DIR := .venv
 
+ifdef VERBOSE
+OPTS := -v
+else
+# linuxdoc 20260504 is too verbose by default
+OPTS := -q
+endif
+
 # only fish and bash/zsh supported
 VENV_CMD := if [ "x${FISH_VERSION}" != "x" ]; then . $(VENV_DIR)/bin/activate.fish; else . $(VENV_DIR)/bin/activate; fi
 
@@ -24,10 +31,10 @@ ${abs_top_builddir}/metadata/ltp.json:
 	$(MAKE) -C ${abs_top_builddir}/metadata
 
 all: ${abs_top_builddir}/metadata/ltp.json
-	$(RUN_VENV); sphinx-build -v -b html . html
+	$(RUN_VENV); sphinx-build $(OPTS) -b html . html
 
 spelling:
-	$(RUN_VENV); sphinx-build -b spelling -d build/doctree . build/spelling
+	$(RUN_VENV); sphinx-build $(OPTS) -b spelling -d build/doctree . build/spelling
 
 clean:
 	rm -rf html/ build/ _static/syscalls.rst _static/tests.rst syscalls.tbl \
-- 
2.55.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

[LTP] [PATCH 3/4] doc: Update linuxdoc, sphinxcontrib-spelling

[Petr Vorel]

Update to the latest versions:
* linuxdoc: 20240924 => 20260504 (allowed to remove workaround
  installing setuptools==81.0.0, required previous commit to not run
  sphinx -v by default otherwise there would be too many kernel-doc INFO
  messages)
* sphinxcontrib-spelling: 7.7.0 => 8.0.2

Removing setuptools==81.0.0 dependency fixes CVE-2026-59890 (score 6.1).

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/requirements.txt | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index f04676c7bd..ac5b43e415 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -3,8 +3,5 @@
 sphinx==8.2.3
 sphinx-rtd-theme==3.1.0
 
-linuxdoc==20240924
-sphinxcontrib-spelling==7.7.0
-
-# workaround for linuxdoc <= 20240924
-setuptools==81.0.0
+linuxdoc==20260504
+sphinxcontrib-spelling==8.0.2
-- 
2.55.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

[LTP] [PATCH 4/4] tst_kvercmp.h: Further links to manpage

[Petr Vorel]

Add further manpage links (requires Sphinx 7.3):
* struct utsname.release => uname(2)
* uname -r => uname(1)

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 include/tst_kvercmp.h | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/include/tst_kvercmp.h b/include/tst_kvercmp.h
index 2bc7c53f12..26e8f8e3c1 100644
--- a/include/tst_kvercmp.h
+++ b/include/tst_kvercmp.h
@@ -10,7 +10,7 @@
 /**
  * tst_kvcmp() - Compare given kernel version with kernel in string.
  *
- * @cur_kver: Kernel version string (struct utsname.release).
+ * @cur_kver: Kernel version string (:manpage:`struct utsname.release <uname(2)>`).
  * @r1: Major kernel version.
  * @r2: Minor kernel version.
  * @r3: Kernel patch level.
@@ -28,7 +28,7 @@ int tst_kvcmp(const char *cur_kver, int r1, int r2, int r3);
 /**
  * tst_parse_kver() - Parses a version string into three integers.
  *
- * @str_kver: Kernel version string (struct utsname.release).
+ * @str_kver: Kernel version string (:manpage:`struct utsname.release <uname(2)>`).
  * @v1: Major kernel version.
  * @v2: Minor kernel version.
  * @v3: Kernel patch level.
@@ -43,7 +43,7 @@ int tst_parse_kver(const char *str_kver, int *v1, int *v2, int *v3);
 /**
  * tst_kvcmp_distname() - Get the distribution name from kernel version string.
  *
- * @cur_kver: Kernel version string (struct utsname.release).
+ * @cur_kver: Kernel version string (:manpage:`struct utsname.release <uname(2)>`).
  *
  * Return: The distribution name parsed from kernel version string or NULL.
  */
@@ -51,8 +51,8 @@ const char *tst_kvcmp_distname(const char *cur_kver);
 
 /**
  * tst_kvexcmp() - Compares versions up to five version numbers long.
- * @tst_exv: The tested kernel version string (struct utsname.release).
- * @cur_kver: The current version in string (struct utsname.release).
+ * @tst_exv: The tested kernel version string (:manpage:`struct utsname.release <uname(2)>`).
+ * @cur_kver: The current version in string (:manpage:`struct utsname.release <uname(2)>`).
  *
  * The return value is similar to the :manpage:`strcmp(3)` function, i.e. zero means
  * equal, negative value means that the kernel is older than the expected value
@@ -70,7 +70,8 @@ int tst_kvexcmp(const char *tst_exv, const char *cur_kver);
  * @r3: Kernel patch level.
  *
  * Parse the output from :manpage:`uname(2)` and compare it to the passed values.
- * This is shortcut for calling tst_kvcmp() with ``uname -r`` as str_kver.
+ * This is shortcut for calling tst_kvcmp() with :manpage:`uname -r <uname(1)>`
+ * as str_kver.
  *
  * Return: Negative if older, 0 if the same and positive if newer.
  */
-- 
2.55.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[linuxtestproject.agent]

Hi Petr,

On Aug 5, 2026, Petr Vorel wrote:
> [PATCH 1/4] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

--- [PATCH 2/4] ---

> +# linuxdoc 20260504 is too verbose by default

Could this change be folded into patch 3? At this point the requirements
still pin linuxdoc 20240924, so the comment names a version that is not
present in this commit, and the commit message explicitly depends on the
following patch.

Verdict - Needs revision

---
Note:

The agent can sometimes produce false positives although often its
findings are genuine. If you find issues with the review, please
comment this email or ignore the suggestions.

Regards,
LTP AI Reviewer

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[Petr Vorel]

> Hi Petr,

> On Aug 5, 2026, Petr Vorel wrote:
> > [PATCH 1/4] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

> --- [PATCH 2/4] ---

> > +# linuxdoc 20260504 is too verbose by default

> Could this change be folded into patch 3? At this point the requirements
> still pin linuxdoc 20240924, so the comment names a version that is not
> present in this commit, and the commit message explicitly depends on the
> following patch.

I deliberately wanted to fix it before updating linuxdoc + document the reason
even in the source code. But, if preferred, I can swap 2rd and 3nd patch.

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/4] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[Andrea Cervesato via ltp]

Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com>

--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 4/4] tst_kvercmp.h: Further links to manpage

[Andrea Cervesato via ltp]

Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com>

--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 3/4] doc: Update linuxdoc, sphinxcontrib-spelling

[Andrea Cervesato via ltp]

Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com>

--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 2/4] doc: Reduce default sphinx verbosity with -q

[Andrea Cervesato via ltp]

Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com>

--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[Andrea Cervesato via ltp]

Hi Petr,

> I deliberately wanted to fix it before updating linuxdoc + document the reason
> even in the source code. But, if preferred, I can swap 2rd and 3nd patch.

that was just a suggestion, feel free to merge like it is now.

Regards,
--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] readthedocs: Update to Ubuntu 26.04, Sphinx 8.2.3

[Petr Vorel]

Hi Andrea,

> Hi Petr,

> > I deliberately wanted to fix it before updating linuxdoc + document the reason
> > even in the source code. But, if preferred, I can swap 2rd and 3nd patch.

> that was just a suggestion, feel free to merge like it is now.

Thanks, patchset merged!

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp