Linux Test Project
 help / color / mirror / Atom feed
From: Andrea Cervesato <andrea.cervesato@suse.de>
To: Linux Test Project <ltp@lists.linux.it>
Subject: [LTP] [PATCH v2 1/9] doc: Fix examples and generated links
Date: Fri, 11 Sep 2026 09:04:17 +0200	[thread overview]
Message-ID: <20260911-fix_documentation-v2-1-716b2613c477@suse.com> (raw)
In-Reply-To: <20260911-fix_documentation-v2-0-716b2613c477@suse.com>

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>
Reviewed-by: Petr Vorel <pvorel@suse.cz>
---
 doc/conf.py                        | 4 ++--
 doc/developers/api_shell_tests.rst | 7 ++++---
 doc/users/testers_guide.rst        | 4 ++--
 3 files changed, 8 insertions(+), 7 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..a972900b1 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": {
-   #   ["linux-git", "432fd03240fa"]
-   #  }
+   #  "tags": [
+   #   ["linux-git", "cf01fb9985e8deb25ccf0ea54d916b8871ae0e62"]
+   #  ]
    # }
+   # ---
 
 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


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

  reply	other threads:[~2026-09-11  7:05 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-11  7:04 [LTP] [PATCH v2 0/9] doc: Improve and fix documentation and API comments Andrea Cervesato
2026-09-11  7:04 ` Andrea Cervesato [this message]
2026-09-11  7:04 ` [LTP] [PATCH v2 2/9] doc: Correct guide and API descriptions Andrea Cervesato
2026-09-11 10:59   ` Petr Vorel
2026-09-11  7:04 ` [LTP] [PATCH v2 3/9] doc: Clarify API coverage and navigation Andrea Cervesato
2026-09-11  7:04 ` [LTP] [PATCH v2 4/9] include: Document assertion API macros Andrea Cervesato
2026-09-11 11:10   ` Petr Vorel
2026-09-11  7:04 ` [LTP] [PATCH v2 5/9] include: Document filesystem test utilities Andrea Cervesato
2026-09-11 11:19   ` Petr Vorel
2026-09-11  7:04 ` [LTP] [PATCH v2 6/9] include: Document memory " Andrea Cervesato
2026-09-11 11:39   ` Petr Vorel
2026-09-11  7:04 ` [LTP] [PATCH v2 7/9] include: Document safe file operations Andrea Cervesato
2026-09-11  7:04 ` [LTP] [PATCH v2 8/9] doc: Document CPU and common test helpers Andrea Cervesato
2026-09-11 11:56   ` Petr Vorel
2026-09-11  7:04 ` [LTP] [PATCH v2 9/9] include: Fix API comment spelling and style Andrea Cervesato
2026-09-11 12:21   ` Petr Vorel
2026-09-11 12:34 ` [LTP] [PATCH v2 0/9] doc: Improve and fix documentation and API comments Andrea Cervesato via ltp
2026-09-11 13:06 ` Andrea Cervesato via ltp

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260911-fix_documentation-v2-1-716b2613c477@suse.com \
    --to=andrea.cervesato@suse.de \
    --cc=ltp@lists.linux.it \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox