{"id":2215827,"url":"http://patchwork.ozlabs.org/api/patches/2215827/?format=json","web_url":"http://patchwork.ozlabs.org/project/ltp/patch/20260325120629.113245-1-pvorel@suse.cz/","project":{"id":59,"url":"http://patchwork.ozlabs.org/api/projects/59/?format=json","name":"Linux Test Project development","link_name":"ltp","list_id":"ltp.lists.linux.it","list_email":"ltp@lists.linux.it","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20260325120629.113245-1-pvorel@suse.cz>","list_archive_url":null,"date":"2026-03-25T12:06:29","name":"[1/1] tst_test.h: Convert rest of doc to kerneldoc","commit_ref":null,"pull_url":null,"state":"changes-requested","archived":false,"hash":"b6ef5f56469f7e5e39efd85d90e97e82cef6d438","submitter":{"id":70792,"url":"http://patchwork.ozlabs.org/api/people/70792/?format=json","name":"Petr Vorel","email":"pvorel@suse.cz"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/ltp/patch/20260325120629.113245-1-pvorel@suse.cz/mbox/","series":[{"id":497428,"url":"http://patchwork.ozlabs.org/api/series/497428/?format=json","web_url":"http://patchwork.ozlabs.org/project/ltp/list/?series=497428","date":"2026-03-25T12:06:29","name":"[1/1] tst_test.h: Convert rest of doc to kerneldoc","version":1,"mbox":"http://patchwork.ozlabs.org/series/497428/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/2215827/comments/","check":"success","checks":"http://patchwork.ozlabs.org/api/patches/2215827/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":["incoming@patchwork.ozlabs.org","ltp@lists.linux.it"],"Delivered-To":["patchwork-incoming@legolas.ozlabs.org","ltp@picard.linux.it"],"Authentication-Results":["legolas.ozlabs.org;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n unprotected) header.d=suse.cz header.i=@suse.cz header.a=rsa-sha256\n header.s=susede2_rsa header.b=s0OapVbH;\n\tdkim=fail reason=\"signature verification failed\" header.d=suse.cz\n header.i=@suse.cz header.a=ed25519-sha256 header.s=susede2_ed25519\n header.b=kOhWT7SR;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key)\n header.d=suse.cz header.i=@suse.cz header.a=rsa-sha256 header.s=susede2_rsa\n header.b=s0OapVbH;\n\tdkim=neutral header.d=suse.cz header.i=@suse.cz header.a=ed25519-sha256\n header.s=susede2_ed25519 header.b=kOhWT7SR;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=lists.linux.it\n (client-ip=213.254.12.146; helo=picard.linux.it;\n envelope-from=ltp-bounces+incoming=patchwork.ozlabs.org@lists.linux.it;\n receiver=patchwork.ozlabs.org)","smtp-out2.suse.de;\n\tnone"],"Received":["from picard.linux.it (picard.linux.it [213.254.12.146])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\t key-exchange x25519 server-signature ECDSA (secp384r1) server-digest SHA384)\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4fglxs2vNhz1xy1\n\tfor ; Wed, 25 Mar 2026 23:06:40 +1100 (AEDT)","from picard.linux.it (localhost [IPv6:::1])\n\tby picard.linux.it (Postfix) with ESMTP id BD5033E2FFD\n\tfor ; Wed, 25 Mar 2026 13:06:37 +0100 (CET)","from in-6.smtp.seeweb.it (in-6.smtp.seeweb.it [217.194.8.6])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature ECDSA (secp384r1))\n (No client certificate requested)\n by picard.linux.it (Postfix) with ESMTPS id 919493E143F\n for ; Wed, 25 Mar 2026 13:06:35 +0100 (CET)","from smtp-out2.suse.de (smtp-out2.suse.de [195.135.223.131])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by in-6.smtp.seeweb.it (Postfix) with ESMTPS id D1C141400993\n for ; Wed, 25 Mar 2026 13:06:34 +0100 (CET)","from imap1.dmz-prg2.suse.org (unknown [10.150.64.97])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest\n SHA256)\n (No client certificate requested)\n by smtp-out2.suse.de (Postfix) with ESMTPS id B4C965BCCF;\n Wed, 25 Mar 2026 12:06:33 +0000 (UTC)","from imap1.dmz-prg2.suse.org (localhost [127.0.0.1])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest\n SHA256)\n (No client certificate requested)\n by imap1.dmz-prg2.suse.org (Postfix) with ESMTPS id 98E67443B9;\n Wed, 25 Mar 2026 12:06:33 +0000 (UTC)","from dovecot-director2.suse.de ([2a07:de40:b281:106:10:150:64:167])\n by imap1.dmz-prg2.suse.org with ESMTPSA id E56UI8nPw2klMgAAD6G6ig\n (envelope-from ); Wed, 25 Mar 2026 12:06:33 +0000"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz;\n s=susede2_rsa;\n t=1774440393;\n h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc:\n mime-version:mime-version:\n content-transfer-encoding:content-transfer-encoding;\n bh=0jebzcFYuJi/2LEhKGAURZSL3KhxqqII9zrdHtPmbPM=;\n b=s0OapVbHZ+W9DFJkzL/RwJxi3lFpHehic7+BBz+LFUfQIKl5nRbHmGp0c2TlOmy5e8rg4D\n 4R13wjZNJiEgwijc0wZqxucZCjSdjupDhZEl6OUMrYXItIuXZzoNwC7N3JgKGy/mUq1rBI\n tPcj4ldQ6dsZ5IFUCRWTttIiBFY92Bg=","v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz;\n s=susede2_ed25519; t=1774440393;\n h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc:\n mime-version:mime-version:\n content-transfer-encoding:content-transfer-encoding;\n bh=0jebzcFYuJi/2LEhKGAURZSL3KhxqqII9zrdHtPmbPM=;\n b=kOhWT7SR5Imb+8P+kqYsKVQ9QF3uwlNOC8XMBO/Dhg7aOZvIkd2llHp2dd6+j2uM+zCEoT\n YM6jObgan+o9Q8AA==","v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz;\n s=susede2_rsa;\n t=1774440393;\n h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc:\n mime-version:mime-version:\n content-transfer-encoding:content-transfer-encoding;\n bh=0jebzcFYuJi/2LEhKGAURZSL3KhxqqII9zrdHtPmbPM=;\n b=s0OapVbHZ+W9DFJkzL/RwJxi3lFpHehic7+BBz+LFUfQIKl5nRbHmGp0c2TlOmy5e8rg4D\n 4R13wjZNJiEgwijc0wZqxucZCjSdjupDhZEl6OUMrYXItIuXZzoNwC7N3JgKGy/mUq1rBI\n tPcj4ldQ6dsZ5IFUCRWTttIiBFY92Bg=","v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz;\n s=susede2_ed25519; t=1774440393;\n h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc:\n mime-version:mime-version:\n content-transfer-encoding:content-transfer-encoding;\n bh=0jebzcFYuJi/2LEhKGAURZSL3KhxqqII9zrdHtPmbPM=;\n b=kOhWT7SR5Imb+8P+kqYsKVQ9QF3uwlNOC8XMBO/Dhg7aOZvIkd2llHp2dd6+j2uM+zCEoT\n YM6jObgan+o9Q8AA=="],"From":"Petr Vorel ","To":"ltp@lists.linux.it","Date":"Wed, 25 Mar 2026 13:06:29 +0100","Message-ID":"<20260325120629.113245-1-pvorel@suse.cz>","X-Mailer":"git-send-email 2.53.0","MIME-Version":"1.0","X-Spam-Score":"-2.80","X-Spam-Level":"","X-Spamd-Result":"default: False [-2.80 / 50.00]; BAYES_HAM(-3.00)[100.00%];\n MID_CONTAINS_FROM(1.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000];\n R_MISSING_CHARSET(0.50)[]; NEURAL_HAM_SHORT(-0.20)[-1.000];\n MIME_GOOD(-0.10)[text/plain]; RCVD_VIA_SMTP_AUTH(0.00)[];\n MIME_TRACE(0.00)[0:+]; FUZZY_RATELIMITED(0.00)[rspamd.com];\n TO_DN_SOME(0.00)[]; ARC_NA(0.00)[];\n DKIM_SIGNED(0.00)[suse.cz:s=susede2_rsa,suse.cz:s=susede2_ed25519];\n URIBL_BLOCKED(0.00)[suse.cz:mid,suse.cz:email,imap1.dmz-prg2.suse.org:helo];\n FROM_EQ_ENVFROM(0.00)[]; FROM_HAS_DN(0.00)[];\n RCPT_COUNT_THREE(0.00)[3]; RCVD_COUNT_TWO(0.00)[2];\n TO_MATCH_ENVRCPT_ALL(0.00)[];\n DBL_BLOCKED_OPENRESOLVER(0.00)[imap1.dmz-prg2.suse.org:helo];\n RCVD_TLS_ALL(0.00)[]","X-Spam-Status":"No, score=0.1 required=7.0 tests=DKIM_SIGNED,DKIM_VALID,\n DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS shortcircuit=no\n autolearn=disabled version=4.0.1","X-Spam-Checker-Version":"SpamAssassin 4.0.1 (2024-03-25) on in-6.smtp.seeweb.it","X-Virus-Scanned":"clamav-milter 1.0.9 at in-6.smtp.seeweb.it","X-Virus-Status":"Clean","Subject":"[LTP] [PATCH 1/1] tst_test.h: Convert rest of doc to kerneldoc","X-BeenThere":"ltp@lists.linux.it","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"Linux Test Project ","List-Unsubscribe":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"ltp-bounces+incoming=patchwork.ozlabs.org@lists.linux.it","Sender":"\"ltp\" "},"content":"Signed-off-by: Petr Vorel \n---\n include/tst_test.h | 66 ++++++++++++++++++++++++++++++++++++----------\n 1 file changed, 52 insertions(+), 14 deletions(-)","diff":"diff --git a/include/tst_test.h b/include/tst_test.h\nindex ddfe9d4d6c..fa336207e9 100644\n--- a/include/tst_test.h\n+++ b/include/tst_test.h\n@@ -694,11 +694,25 @@ void tst_reinit(void);\n */\n int tst_run_script(const char *script_name, char *const params[]);\n \n-/*\n- * Sets entire timeout in seconds.\n+/**\n+ * tst_set_timeout() - Sets entire timeout in seconds.\n+ *\n+ * Allows to sett the overall timeout dynamically during the test setup phase.\n+ * The timeout is specified in seconds and defines the total time allowed for a\n+ * single test iteration, including the setup, runtime, and teardown phases.\n+ *\n+ * @timeout: A timeout in seconds.\n */\n void tst_set_timeout(int timeout);\n \n+/**\n+ * tst_multiply_timeout() - Multiply the timeout with LTP_TIMEOUT_MUL\n+ * environment variable.\n+ *\n+ * @timeout: A timeout in seconds.\n+ *\n+ * Return: timeout multiplied with LTP_TIMEOUT_MUL environment variable.\n+ */\n unsigned int tst_multiply_timeout(unsigned int timeout);\n \n /*\n@@ -710,19 +724,40 @@ unsigned int tst_multiply_timeout(unsigned int timeout);\n */\n unsigned int tst_remaining_runtime(void);\n \n-/*\n- * Sets maximal test runtime in seconds.\n+/**\n+ * tst_set_runtime() - Sets maximal test runtime in seconds.\n+ *\n+ * Allows for setting the runtime per test iteration dynamically during the test\n+ * setup phase. The runtime is specified in seconds and defines how long the\n+ * test is allowed to execute its main workload, excluding the setup and\n+ * teardown phases.\n+ *\n+ * This function is useful for tests where the duration of the main workload can\n+ * be controlled or needs to be adjusted dynamically. For example, tests that\n+ * run in a loop until the runtime expires can use this function to define how\n+ * long they should execute.\n+ *\n+ * @runtime: A timeout in seconds.\n */\n void tst_set_runtime(int runtime);\n \n-/*\n- * Create and open a random file inside the given dir path.\n- * It unlinks the file after opening and return file descriptor.\n+/**\n+ * tst_creat_unlinked() - Create and open a random file inside the given\n+ * directory path, unlinks the file after opening and return file descriptor.\n+ *\n+ * @path: Path to the directory.\n+ * @flags: :manpage:`open(2)` flags.\n+ * @mode: :manpage:`open(2)` mode.\n+ *\n+ * Return: the file descriptor.\n */\n int tst_creat_unlinked(const char *path, int flags, mode_t mode);\n \n-/*\n- * Returns path to the test temporary directory root (TMPDIR).\n+/**\n+ * tst_get_tmpdir_root() - Returns path to the test temporary directory root\n+ * (TMPDIR environment variable).\n+ *\n+ * Return: the path to TMPDIR.\n */\n const char *tst_get_tmpdir_root(void);\n \n@@ -738,13 +773,16 @@ const char *tst_get_tmpdir_root(void);\n */\n bool tst_cmd_present(const char *cmd);\n \n-/*\n- * Validates exit status of child processes\n- */\n int tst_validate_children_(const char *file, const int lineno,\n \tunsigned int count);\n-#define tst_validate_children(child_count) \\\n-\ttst_validate_children_(__FILE__, __LINE__, (child_count))\n+\n+/**\n+ * tst_validate_children() - Validates exit status of the child processes.\n+ *\n+ * @count: Number of the child processes.\n+ */\n+#define tst_validate_children(count) \\\n+\ttst_validate_children_(__FILE__, __LINE__, (count))\n \n #ifndef TST_NO_DEFAULT_MAIN\n \n","prefixes":["1/1"]}