From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from picard.linux.it (picard.linux.it [213.254.12.146]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 97517CD6E55 for ; Mon, 1 Jun 2026 13:55:29 +0000 (UTC) Received: from picard.linux.it (localhost [IPv6:::1]) by picard.linux.it (Postfix) with ESMTP id D92793E56D5 for ; Mon, 1 Jun 2026 15:55:27 +0200 (CEST) Received: from in-4.smtp.seeweb.it (in-4.smtp.seeweb.it [217.194.8.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by picard.linux.it (Postfix) with ESMTPS id D70143E1EA0 for ; Mon, 1 Jun 2026 15:55:10 +0200 (CEST) Received: from smtp-out1.suse.de (smtp-out1.suse.de [195.135.223.130]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by in-4.smtp.seeweb.it (Postfix) with ESMTPS id B7FA81000759 for ; Mon, 1 Jun 2026 15:55:09 +0200 (CEST) Received: from imap1.dmz-prg2.suse.org (unknown [10.150.64.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id 1251D6BC01; Mon, 1 Jun 2026 13:55:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1780322109; h=from:from:reply-to:reply-to:date:date:message-id:message-id:to:to: cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=VPVasXXm5LN1NMsvS6kF+HM3V8x0GaDyo2MI9ZFcHPQ=; b=vlqHdRe5gHHj7TJHFEN9Mq+0b5LAN5Gglb2VfHQavQzH2+rdDWcb1GB0BxZf9QVg3Jy334 KOvLVo7jVCDEeD3shXVPTEklBDfnjOnrp0uh2WRNq1gh94OnWHaLQq9CGPfNun5SlJ7Af9 xmQwB7yf54Lmbt9AvZ657C3Ydqii0LM= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1780322109; h=from:from:reply-to:reply-to:date:date:message-id:message-id:to:to: cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=VPVasXXm5LN1NMsvS6kF+HM3V8x0GaDyo2MI9ZFcHPQ=; b=tLVPDyQEoxx3gTloxdi+rpIu9GBXXQs7XrspJyO6t9rwUNjJAim/eAOC6kAaRfG/llTv4z sjC0Uy7rAc55sgCA== Authentication-Results: smtp-out1.suse.de; none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1780322109; h=from:from:reply-to:reply-to:date:date:message-id:message-id:to:to: cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=VPVasXXm5LN1NMsvS6kF+HM3V8x0GaDyo2MI9ZFcHPQ=; b=vlqHdRe5gHHj7TJHFEN9Mq+0b5LAN5Gglb2VfHQavQzH2+rdDWcb1GB0BxZf9QVg3Jy334 KOvLVo7jVCDEeD3shXVPTEklBDfnjOnrp0uh2WRNq1gh94OnWHaLQq9CGPfNun5SlJ7Af9 xmQwB7yf54Lmbt9AvZ657C3Ydqii0LM= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1780322109; h=from:from:reply-to:reply-to:date:date:message-id:message-id:to:to: cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=VPVasXXm5LN1NMsvS6kF+HM3V8x0GaDyo2MI9ZFcHPQ=; b=tLVPDyQEoxx3gTloxdi+rpIu9GBXXQs7XrspJyO6t9rwUNjJAim/eAOC6kAaRfG/llTv4z sjC0Uy7rAc55sgCA== Received: from imap1.dmz-prg2.suse.org (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by imap1.dmz-prg2.suse.org (Postfix) with ESMTPS id E4A99779A7; Mon, 1 Jun 2026 13:55:08 +0000 (UTC) Received: from dovecot-director2.suse.de ([2a07:de40:b281:106:10:150:64:167]) by imap1.dmz-prg2.suse.org with ESMTPSA id GNHONTyPHWoCXwAAD6G6ig (envelope-from ); Mon, 01 Jun 2026 13:55:08 +0000 Date: Mon, 1 Jun 2026 15:55:07 +0200 From: Petr Vorel To: Andrea Cervesato Message-ID: <20260601135507.GB3391768@pevik> References: <20260601-doc_update-v1-0-b0f59834fbae@suse.com> <20260601-doc_update-v1-1-b0f59834fbae@suse.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20260601-doc_update-v1-1-b0f59834fbae@suse.com> X-Spamd-Result: default: False [-7.50 / 50.00]; REPLY(-4.00)[]; BAYES_HAM(-3.00)[100.00%]; NEURAL_HAM_LONG(-1.00)[-1.000]; MID_RHS_NOT_FQDN(0.50)[]; HAS_REPLYTO(0.30)[pvorel@suse.cz]; NEURAL_HAM_SHORT(-0.20)[-1.000]; MIME_GOOD(-0.10)[text/plain]; RCVD_VIA_SMTP_AUTH(0.00)[]; ARC_NA(0.00)[]; MIME_TRACE(0.00)[0:+]; FUZZY_RATELIMITED(0.00)[rspamd.com]; MISSING_XM_UA(0.00)[]; RCVD_TLS_ALL(0.00)[]; DKIM_SIGNED(0.00)[suse.cz:s=susede2_rsa,suse.cz:s=susede2_ed25519]; FROM_EQ_ENVFROM(0.00)[]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_TWO(0.00)[2]; DBL_BLOCKED_OPENRESOLVER(0.00)[imap1.dmz-prg2.suse.org:helo,linux-test-project.readthedocs.io:url,suse.cz:email,suse.cz:replyto,suse.com:email]; RCVD_COUNT_TWO(0.00)[2]; TO_MATCH_ENVRCPT_ALL(0.00)[]; TO_DN_ALL(0.00)[]; REPLYTO_EQ_FROM(0.00)[] X-Virus-Scanned: clamav-milter 1.0.9 at in-4.smtp.seeweb.it X-Virus-Status: Clean Subject: Re: [LTP] [PATCH 1/4] doc: Fix broken references and outdated content X-BeenThere: ltp@lists.linux.it X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux Test Project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Petr Vorel Cc: Linux Test Project Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ltp-bounces+ltp=archiver.kernel.org@lists.linux.it Sender: "ltp" Hi Andrea, > Fix kernel-doc reference to renamed tse_numa.h header, correct > TST_EXP_POSSITIVE typo and RST formatting in tst_test_macros.h, > use :c:struct: instead of :ref: for struct cross-references, fix > broken lapi/ :master: links, drop stale lapi/stat.h notes, correct > kirk invocation example and use md5sum/sha1sum commands. Maybe add: Fixes: eef750db28 ("libs: adopt tse_ prefix for extended (non-core) library") (there are more fixes but this one is the most obvious.) And I'm sorry I touched the docs (you might need to resolve conflict during rebasing), I haven't noticed this patchset otherwise I'd wait. > Signed-off-by: Andrea Cervesato > --- > doc/developers/api_c_tests.rst | 2 +- > doc/developers/api_shell_tests.rst | 2 +- > doc/developers/test_case_tutorial.rst | 19 ++++++++----------- > doc/developers/todo.rst | 2 +- > doc/developers/writing_tests.rst | 6 +++--- > doc/maintainers/ltp_release_procedure.rst | 4 ++-- > doc/maintainers/patch_review.rst | 6 +++--- > include/tst_test_macros.h | 8 ++++---- > 8 files changed, 23 insertions(+), 26 deletions(-) > diff --git a/doc/developers/api_c_tests.rst b/doc/developers/api_c_tests.rst > index 26b46d92d9f0aa724f10a960b6c5cce59ae1d3e8..65cf6d6cd0be5cb4cd9c986e09df021071d968f1 100644 > --- a/doc/developers/api_c_tests.rst > +++ b/doc/developers/api_c_tests.rst > @@ -50,7 +50,7 @@ Process state > NUMA > ---- > -.. kernel-doc:: ../../include/tst_numa.h > +.. kernel-doc:: ../../include/tse_numa.h > Option parsing > -------------- > diff --git a/doc/developers/api_shell_tests.rst b/doc/developers/api_shell_tests.rst > index 51bb04a4e155e83c3302b4664886d49624f51a9f..9a3ff795f1b0cedbfa3b126fe0acad8d24e5c704 100644 > --- a/doc/developers/api_shell_tests.rst > +++ b/doc/developers/api_shell_tests.rst > @@ -30,7 +30,7 @@ documentation at https://linux-test-project.readthedocs.io/en/latest/users/test_ > The shell loader test library uses the :doc:`../developers/api_c_tests` > internally by parsing a special JSON formatted comment and > initializing it accordingly. The JSON format is nearly 1:1 serialization of the > -:ref:`struct tst_test` into a JSON. The environment must be always preset even > +:c:struct:`tst_test` into a JSON. The environment must be always preset even > when it's empty. OK, *.rst files require to use :c:struct: instead of :ref:. It's probably my error (I haven't noticed the syntax is different from C files). > .. code-block:: shell > diff --git a/doc/developers/test_case_tutorial.rst b/doc/developers/test_case_tutorial.rst > index 240897e36b8fd7c5f70cf426f81ef4bfc0e562a0..28eda5ae69f7e358383ae44d5d23bd2e4d79b487 100644 > --- a/doc/developers/test_case_tutorial.rst > +++ b/doc/developers/test_case_tutorial.rst > @@ -137,7 +137,7 @@ initialization code. It is important to note that this is a completely > ordinary, independent C program, however ``main()`` is missing because it is > implemented in :master:`include/tst_test.h`. > -We specify what code we want to run as part of the test using :ref:`struct tst_test`. > +We specify what code we want to run as part of the test using :c:struct:`tst_test`. > Various callbacks can be set by the test writer, including > ``test.test_all``, which we have set to ``run()``. The test harness will execute > this callback in a separate process (using ``fork()``), forcibly terminating it > @@ -205,8 +205,8 @@ please do: nit: could you please use :manpage:`fork()` ? > This should build the test and then run it. However, even though the test is > in :master:`testcases/kernel/syscalls` directory it won't be automatically ran > -as part of the syscalls test group (e.g. not run via ``kirk -r math``. For > -this we need to add it to the runtest file. So open :master:`runtest/syscalls` > +as part of the syscalls test group (e.g. not run via ``kirk -f syscalls``). > +For this we need to add it to the runtest file. So open :master:`runtest/syscalls` IMHO math is fast => good as example. > and add the lines starting with a ``+``. > .. code-block:: > @@ -517,15 +517,14 @@ that should be by setting ``.needs_tmpdir = 1``. > /*************** statx structure and wrapper goes here ! ***************/ > ... > -We have added an extra include :master:`lapi/fcntl.h` which wraps the system header by > +We have added an extra include :master:`include/lapi/fcntl.h` which wraps the system header by > the same name (``#include ``). This header ensures we have definitions > for recently added macros such as ``AT_FDCWD`` by providing fall backs if the > -system header does not have them. The :master:`lapi/` directory contains a number of > +system header does not have them. The :master:`include/lapi/` directory contains a number of > headers like this. +1 > -At some point we may wish to add :master:`lapi/stat.h` to provide a fall back for > -macros such as ``STATX_BASIC_STATS``. However for the time being we have just > -defined it in the test. > +The :master:`include/lapi/stat.h` header provides similar fall backs for > +macros such as ``STATX_BASIC_STATS`` used by this test. +1 ... > Shell coding style > @@ -361,7 +361,7 @@ LTP C And Shell Test API Comparison > .. list-table:: > :header-rows: 1 > - * - C API :ref:`struct tst_test` members > + * - C API :c:struct:`tst_test` members > - Shell API ``$TST_*`` variables > * - .all_filesystems > @@ -531,5 +531,5 @@ LTP C And Shell Test API Comparison > * - C API other structs > - Shell API ``$TST_*`` variables > - * - :ref:`struct tst_device` > + * - ``struct tst_device`` I'd even add :c:struct:`struct tst_device` as a preparation for a new commit but you might add it in the following patchset. > - TST_DEVICE > diff --git a/doc/maintainers/ltp_release_procedure.rst b/doc/maintainers/ltp_release_procedure.rst > index 6dbafa4f81ebd3c843ef66547340012c59521fb8..7851440125ba54707026d3d380e2b3ef0def368d 100644 > --- a/doc/maintainers/ltp_release_procedure.rst > +++ b/doc/maintainers/ltp_release_procedure.rst > @@ -112,8 +112,8 @@ metadata documentation: > tar -cJf ltp-full-YYYYMMDD.tar.xz ltp-full-YYYYMMDD --exclude .git > # Generate checksums > - md5 ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.md5 > - sha1 ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha1 > + md5sum ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.md5 > + sha1sum ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha1 +1 > sha256sum ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha256 > You can use :master:`tools/create-tarballs-metadata.sh` script to have the above > diff --git a/doc/maintainers/patch_review.rst b/doc/maintainers/patch_review.rst > index 28bc4faf343047edfcf647b38f053f923b7de5c7..a328948094029c2a6c2b550c66df8e0236c0ab42 100644 > --- a/doc/maintainers/patch_review.rst > +++ b/doc/maintainers/patch_review.rst > @@ -146,12 +146,12 @@ New test should > C tests > ~~~~~~~ > -* Use :doc:`../developers/api_c_tests`, implementing :ref:`struct tst_test` > +* Use :doc:`../developers/api_c_tests`, implementing :c:struct:`tst_test` +1 > * Test binaries are added into corresponding ``.gitignore`` files > * Check coding style with ``make check`` > * Metadata documentation > -* If a test is a regression test it should include :ref:`.tags` in the > - :ref:`struct tst_test` definition > +* If a test is a regression test it should include :c:struct:`.tags ` in the > + :c:struct:`tst_test` definition > Shell tests > ~~~~~~~~~~~ > diff --git a/include/tst_test_macros.h b/include/tst_test_macros.h > index b1e74278d5ddb25293d38507482dc5a5cdafdbd0..f06c8aeb77558c0c09880f905ccc5b85d9f277a3 100644 > --- a/include/tst_test_macros.h > +++ b/include/tst_test_macros.h > @@ -146,7 +146,7 @@ extern int TST_PASS; > * @SCALL: Tested syscall. > * @...: A printf-like parameters. > * > - * This is a variant of the TST_EXP_POSSITIVE() for a more specific case that > + * This is a variant of the TST_EXP_POSITIVE() for a more specific case that > * the returned value is a file descriptor. > */ > #define TST_EXP_FD(SCALL, ...) \ > @@ -200,7 +200,7 @@ extern int TST_PASS; > * @SCALL: Tested syscall. > * @...: A printf-like parameters. > * > - * This is a variant of the TST_EXP_POSSITIVE() for a more specific case that > + * This is a variant of the TST_EXP_POSITIVE() for a more specific case that > * the returned value is a pid. > */ > #define TST_EXP_PID(SCALL, ...) \ > @@ -379,8 +379,8 @@ extern int TST_PASS; > * @...: A printf-like parameters. > * > * This macro works like TST_EXP_PASS_PTR_VOID() but checks the return > - * value against NULL instead of (void *)-1. Use this for libc functions > - * such as fopen() that return NULL on failure. > + * value against NULL instead of ``(void *)-1``. Use this for libc functions > + * such as :manpage:`fopen(3)` that return NULL on failure. +1 > */ > #define TST_EXP_PASS_PTR_NULL(SCALL, ...) \ > TST_EXP_PASS_PTR_(SCALL, #SCALL, NULL, ##__VA_ARGS__) Reviewed-by: Petr Vorel Kind regards, Petr -- Mailing list info: https://lists.linux.it/listinfo/ltp