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 CD76ACCD18E for ; Tue, 14 Oct 2025 08:56:04 +0000 (UTC) Received: from picard.linux.it (localhost [IPv6:::1]) by picard.linux.it (Postfix) with ESMTP id 4D6D93CEC6A for ; Tue, 14 Oct 2025 10:56:03 +0200 (CEST) Received: from in-6.smtp.seeweb.it (in-6.smtp.seeweb.it [IPv6:2001:4b78:1:20::6]) (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 D5E653C0485 for ; Tue, 14 Oct 2025 10:55:45 +0200 (CEST) Received: from smtp-out2.suse.de (smtp-out2.suse.de [195.135.223.131]) (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-6.smtp.seeweb.it (Postfix) with ESMTPS id E722A14004E1 for ; Tue, 14 Oct 2025 10:55:43 +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-out2.suse.de (Postfix) with ESMTPS id 0F7821FFC2; Tue, 14 Oct 2025 08:55:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1760432143; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=TkKNMEoJu+bLu8h+2pDdXQaxvNjo3eLESAPCo1LoD6Q=; b=bh+PRwMGv9M+AK7TrEV++M2fSShN2DNX82MjbV1At/+wCCxE+zLIR2rsyfeFGLxPOUB7Xo DtxleceN54stNEOmJ0TOQZ7/JSlGO6KXu8TtwUROeBiBuuroP+kNh3PBgZSzfbmRv+9RRT yLYE+hvfSWdaja2QInDFJdqyupTqbHU= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1760432143; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=TkKNMEoJu+bLu8h+2pDdXQaxvNjo3eLESAPCo1LoD6Q=; b=iIjugDNmZDJNbagMfuozgImgkVARciy65khP/T2tggpmG6UBYQjxCpvbQF7suh5MnKVGTD ib/SzHs4xu2pgcBA== Authentication-Results: smtp-out2.suse.de; none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1760432142; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=TkKNMEoJu+bLu8h+2pDdXQaxvNjo3eLESAPCo1LoD6Q=; b=IzlQ+IAWI3c+r67C39sBdKLjduS+aP5tvqv1Dc4YS/JgJI4XDYhqmT3r3Or0TpFtkpFpXt PxBaCHqbLJO6lQZWxgRYM2xXkg6uRq7oDcfOkl3o1Ul8WhLmntBM9bSa0/jilOL9x6fTXT TUO2lREVIRqkYHIJXNXTTd/fS5OrwW4= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1760432142; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=TkKNMEoJu+bLu8h+2pDdXQaxvNjo3eLESAPCo1LoD6Q=; b=LbgZcbdTn5tzGBYddY0jwdMx9ZfoTTEiEwJrjIlYipXqefUeBrIqm4DhO62HQhnfg34vM4 M6vz3v4Z99Sz4HCw== 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 E1F1313A44; Tue, 14 Oct 2025 08:55:41 +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 n8Z3NQ0Q7mhhLgAAD6G6ig (envelope-from ); Tue, 14 Oct 2025 08:55:41 +0000 From: Andrea Cervesato Date: Tue, 14 Oct 2025 10:55:41 +0200 MIME-Version: 1.0 Message-Id: <20251014-remove_todo-v5-1-2793dffdec2d@suse.com> X-B4-Tracking: v=1; b=H4sIAAwQ7mgC/33NTQ7CIBCG4asY1mIYGPrjynsYY2g7KAvFQCWap neXdtUa4/Kb5HlnYJGCo8j2m4EFSi46f89DbzesvZr7hbjr8mZSSA1CFDzQzSc6977zvJW10ZW mqhHAsngEsu41146nvK8u9j6853iC6fq7k4AD141ptC1sWVp9iM9Iu9bf2JRJckFBranMtBMGC 9MBksIvqv5QNX1VirBEVZv6m+KS4ppiplBUtrWmRClhQcdx/ADUy9NLVgEAAA== X-Change-ID: 20251006-remove_todo-c29a585e8b01 To: ltp@lists.linux.it X-Mailer: b4 0.14.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1760432141; l=6912; i=andrea.cervesato@suse.com; s=20250922; h=from:subject:message-id; bh=VhgfJDCxhGZWaBJgctYz7NDIMscoRc1fB4YWKW/hq6Q=; b=VIS2Is1NTFpwj73qlrlQGV0LBn+AcebZibX257v02062IWgkYZKhqex4U+Wpony30Hpxf8rYJ SG1n1X27foCB11iB0CE3Fh+lKGnH9idIgI7sk/VvV0tD/m3NScHS09O X-Developer-Key: i=andrea.cervesato@suse.com; a=ed25519; pk=+8M3XgViLdcdNBM+Jdd90m3pV4jCw2tNsGCy5Rd+qHk= X-Spamd-Result: default: False [-4.30 / 50.00]; BAYES_HAM(-3.00)[100.00%]; NEURAL_HAM_LONG(-1.00)[-1.000]; NEURAL_HAM_SHORT(-0.20)[-0.997]; MIME_GOOD(-0.10)[text/plain]; RCVD_VIA_SMTP_AUTH(0.00)[]; MIME_TRACE(0.00)[0:+]; ARC_NA(0.00)[]; TO_DN_SOME(0.00)[]; FUZZY_RATELIMITED(0.00)[rspamd.com]; RCVD_TLS_ALL(0.00)[]; DKIM_SIGNED(0.00)[suse.de:s=susede2_rsa,suse.de:s=susede2_ed25519]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[3]; FROM_EQ_ENVFROM(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; RCVD_COUNT_TWO(0.00)[2]; DBL_BLOCKED_OPENRESOLVER(0.00)[suse.com:mid,suse.com:email,suse.cz:email] X-Virus-Scanned: clamav-milter 1.0.7 at in-6.smtp.seeweb.it X-Virus-Status: Clean Subject: [LTP] [PATCH v5] Remove TODO 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: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ltp-bounces+ltp=archiver.kernel.org@lists.linux.it Sender: "ltp" From: Andrea Cervesato TODO file is not updated and it talks about goals we already reached via new LTP documentation. In general, it contains generic and random topics which none is updating anymore, so it's better to remove it in order to create less confusion for newcomers. Instead, we create a todo list in the new documentation, providing a more clear intention of what are the current LTP goals. Acked-by: Petr Vorel Signed-off-by: Andrea Cervesato --- Changes in v5: - ref to tst_test - ref to runltp - better explanation of shell loader - Link to v4: https://lore.kernel.org/r/20251014-remove_todo-v4-1-168fcfa74221@suse.com Changes in v4: - fix commit message - point to tst_run_shell.c - moved to developers - fix git grep command - Link to v3: https://lore.kernel.org/r/20251013-remove_todo-v3-1-533e47439a94@suse.com Changes in v3: - fix typo - update command to generate test with old API - add kirk link in TODO - shell loader reference - Link to v2: https://lore.kernel.org/r/20251013-remove_todo-v2-1-d0a46ad14e34@suse.com Changes in v2: - add doc/users/todo.rst section - Link to v1: https://lore.kernel.org/r/20251006-remove_todo-v1-1-5bab5f6f77f5@suse.com --- TODO | 39 ------------------------- doc/developers/todo.rst | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 4 +++ 3 files changed, 79 insertions(+), 39 deletions(-) diff --git a/TODO b/TODO deleted file mode 100644 index fe0a3ab9b..000000000 --- a/TODO +++ /dev/null @@ -1,39 +0,0 @@ -LTP TODO --------- - - -Write more syscall tests -~~~~~~~~~~~~~~~~~~~~~~~~ - -Syscalls and new syscall flags are added to Linux kernel each development cycle -and LTP still falls behind. Unfortunately there is no single place that would -store comprehensive list of syscalls, but there are a few places to look at: - -One of the options would be looking at changes in man-pages git[1] in man2/ -directory to find out newly documented functionality. - -Another good source of information are kernel pages in LWN[2] weekly -editions. - -Then there is linux-api mailing list[3] where changes in kernel userspace API -should be discussed. - -[1] http://git.kernel.org/cgit/docs/man-pages/man-pages.git -[2] http://lwn.net -[3] http://dir.gmane.org/gmane.linux.kernel.api - - -Rewrite old and add new controller testcases -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -We already started working on this with rewriting cgroup_fj testcases and -newly added pids testcases. Have a look at testcases/kernel/controllers/. - - -Shell tests cleanups -~~~~~~~~~~~~~~~~~~~~ - -There are numerous testcases written in shell that does not follow single style -and use the broken-by-design binaries from tools/apicmds. These should be -cleaned up and fixed to use the test.sh test library. These include most of -tests in testcases/commands/ for example. diff --git a/doc/developers/todo.rst b/doc/developers/todo.rst new file mode 100644 index 000000000..7daac7322 --- /dev/null +++ b/doc/developers/todo.rst @@ -0,0 +1,75 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +List of ongoing tasks +===================== + +This is a comprehensive list of tasks where LTP maintainers are currently +working on. Priorities might change over time, but these are the most important +points which are currently being achieved. + +Fade out old tests runner +------------------------- + +:master:`runltp` script is old and unmaintaned. We are slowly shifting to +`kirk `_, that will be our official +tests runner in the next future. + +kirk provides support for remote testing via Qemu, SSH, LTX, parallel +execution and much more. + +Test new syscalls +----------------- + +Syscalls and new syscalls flags are added to Linux kernel each development +cycle and LTP still falls behind. Unfortunately there is no single place that +would store comprehensive list of syscalls, but there are a few places to look +at: + +- `man-pages repository `_ + or the ``man2`` directory, where it's possible to find newly documented + functionalities. +- `LWN `_ weekly editions. +- `linux-api mailing list `_ where + changes in kernel userspace API are discussed. +- `LTP Github issues `_ + +Rewrite old API tests +--------------------- + +LTP has a long story and, at certain point of its development, new API were +introduced to make kernel testing easier and more efficient. This happened when +lots of tests were still using old, messy API. + +Some of these tests have been converted to the new API, but this process is +still ongoing for many others. To have an overview of the tests using old API, +please run the following command inside the LTP root folder: + +.. code-block:: bash + + git --no-pager grep -l 'include "test\.h"' testcases/ + +Fade out shell scripts +---------------------- + +LTP was initially thought as a generic framework for running tests with both +shell and plain-C languages. Even if writing tests in shell script might seem +easy, the reality is that debugging and maintaining certain test cases is +difficult and slow down the whole validation process. This is particularly +visible for cgroup tests, since shell doesn't add enough control over race +conditions. + +LTP maintainers are working on converting shell scripts to plain-C tests, in +order to reduce the impact that shell scripts might have on the overall kernel +testing. + +For a complete list of shell tests, please run the following command inside the +LTP root folder: + +.. code-block:: bash + + git --no-pager grep -l -e '^\. .*_lib\.sh' -e '^\. .*test.sh' + +LTP also provides a shell loader implementation for plain-C tests inside +:master:`testcases/lib/tst_run_shell.c` and it permits to run shell tests +into plain-C LTP API, featuring :ref:`struct tst_test` initializations and a +direct access to kernel syscalls. diff --git a/doc/index.rst b/doc/index.rst index acd16cdbf..06b75616f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -30,6 +30,7 @@ developers/build_system developers/debugging developers/documentation + developers/todo .. toctree:: :maxdepth: 3 @@ -97,6 +98,9 @@ For developers :doc:`developers/documentation` How to use and develop LTP documentation +:doc:`developers/todo` + List of tasks maintainers are working on + For maintainers --------------- --- base-commit: cc420865c291c04c902957a6f3375c8017239e52 change-id: 20251006-remove_todo-c29a585e8b01 Best regards, -- Andrea Cervesato -- Mailing list info: https://lists.linux.it/listinfo/ltp