[LTP] [PATCH 1/9] doc: Fix examples and generated links
Andrea Cervesato
andrea.cervesato@suse.de
Thu Sep 10 10:33:41 CEST 2026
From: Andrea Cervesato <andrea.cervesato@suse.com>
Correct invalid tags array syntax and the missing block terminator in
the shell API example. Fix the musl git commit URL and the getdents64
path in Sphinx configuration. Replace a hardcoded HTML anchor with a
Sphinx reference so it resolves across all documentation builders.
Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
doc/conf.py | 4 ++--
doc/developers/api_shell_tests.rst | 5 +++--
doc/users/testers_guide.rst | 4 ++--
3 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index c28db7af1..2854fe199 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -89,7 +89,7 @@ def generate_supported_syscalls(_):
'file_getattr': f'{ltp_syscalls_path}/file_attr',
'file_setattr': f'{ltp_syscalls_path}/file_attr',
'futex': f'{ltp_syscalls_path}/futex',
- 'getdents64': f'{ltp_syscalls_path}/gettdents',
+ 'getdents64': f'{ltp_syscalls_path}/getdents',
'inotify_add_watch': f'{ltp_syscalls_path}/inotify',
'inotify_init': f'{ltp_syscalls_path}/inotify',
'inotify_rm_watch': f'{ltp_syscalls_path}/inotify',
@@ -293,7 +293,7 @@ def _generate_tags_table(tags):
"linux-git": "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=",
"linux-stable-git": "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/commit/?id=",
"glibc-git": "https://sourceware.org/git/?p=glibc.git;a=commit;h=",
- "musl-git": "https://git.musl-libc.org/cgit/musl/commit/src/linux/clone.c?id=",
+ "musl-git": "https://git.musl-libc.org/cgit/musl/commit/?id=",
"CVE": cve_url + 'CVE-',
}
diff --git a/doc/developers/api_shell_tests.rst b/doc/developers/api_shell_tests.rst
index 937ffee2e..22cab6803 100644
--- a/doc/developers/api_shell_tests.rst
+++ b/doc/developers/api_shell_tests.rst
@@ -41,10 +41,11 @@ when it's empty.
# "needs_root": true,
# "needs_tmpdir": true,
# "needs_kconfigs": ["CONFIG_NUMA=y"],
- # "tags": {
+ # "tags": [
# ["linux-git", "432fd03240fa"]
- # }
+ # ]
# }
+ # ---
After the documentation and environment has been laid out we finally import the
:shell_lib:`tst_loader.sh`. This will, among other things, start the
diff --git a/doc/users/testers_guide.rst b/doc/users/testers_guide.rst
index c0eba64bf..b30b7ac7a 100644
--- a/doc/users/testers_guide.rst
+++ b/doc/users/testers_guide.rst
@@ -61,8 +61,8 @@ devices for these testcases, that can be changed with environment variables as
well. Lastly but not least a few testcases repeat the test for all supported
filesystem, if you are interested in testing on a single filesystem only, you
can limit these tests to a single filesystem too. See the tests setup for a
-comprehensive list of the `environment variables
-<setup_tests.html#library-environment-variables>`_.
+comprehensive list of the :ref:`environment variables
+<users/setup_tests:Library environment variables>`.
Then you also have to decide if you are going to run tests in virtual machine
e.g. `qemu-kvm`, on bare metal or both. Testing in virtual machine will give you
--
2.51.0
More information about the ltp
mailing list