Remove TODO
PATCH v5 1/1 Remove TODO
From: Andrea Cervesato <[email protected]>
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.
---
Changes in v5:
- ref to tst_test
- ref to runltp
- better explanation of shell loader
- Link to v4: https://lore.kernel.org/r/[email protected]
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/[email protected]
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/[email protected]
Changes in v2:
- add doc/users/todo.rst section
- Link to v1: https://lore.kernel.org/r/[email protected]
--- TODO | 39 ------------------------- doc/developers/todo.rst | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 4 +++ 3 files changed, 79 insertions(+), 39 deletions(-)
TODO deleted +0 -39
@@ -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.
doc/developers/todo.rst new file +75 -0
75 lines not on this page · raw message
doc/index.rst +4 -0
@@ -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,
Signature · 5 lines
Andrea Cervesato <[email protected]> -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Andrea and Petr,
Quoted 12 lines · Andrea Cervesato
From: Andrea Cervesato <[email protected]>
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 <[email protected]>Signed-off-by Andrea Cervesato <[email protected]>
Quoted 7 lines
---
Changes in v5:
- ref totst_test
- ref to runltp
- better explanation of shell loader
- Link to v4:
https://lore.kernel.org/r/[email protected]
To me, v5 looks pretty good, and honestly, I rarely see anyone take to-do list so seriously :-).
Because I usually think the final achievement may be a big difference from the beginning idea due to many code iterations, so a rough TODO to describe simple picture should be good enough.
Please accept my respect for the writing:
Quoted 213 lines
Changes in v4:
- fix commit message
- point totst_run_shell.c
- moved to developers
- fix git grep command
- Link to v3:
https://lore.kernel.org/r/[email protected]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/[email protected]Changes in v2:
- adddoc/users/todo.rstsection
- Link to v1:
https://lore.kernel.org/r/[email protected]--- TODO | 39 ------------------------- doc/developers/todo.rst | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 4 +++ 3 files changed, 79 insertions(+), 39 deletions(-)TODO deleted +0
-8@@ -1,39 +0,0 @@ -LTP TODO --------- - - -Write more syscall tests -~~~~~~~~~~~~~~~~~~~~~~~~ - -Syscalls and new syscall flags are added to Linux kernel each developmentcycle
-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:TODO deleted +0
-2- -One of the options would be looking at changes in man-pages git[1] inman2/
TODO deleted +0
-6-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 userspaceAPI
TODO deleted +0
-18-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 singlestyle
TODO deleted +0
-2-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 mostof
TODO deleted +0
-1-tests in testcases/commands/ for example.doc/developers/todo.rst new file +7
-0@@ -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 mostimportant
doc/developers/todo.rst new file +7
-0+points which are currently being achieved. + +Fade out old tests runner +------------------------- + +:master:`runltp` script is old and unmaintaned. We are slowly shifting to +`kirk <https://github.com/linux-test-project/kirk>`_, that will be ourofficial
doc/developers/todo.rst new file +10
-0+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 placethat
+would store comprehensive list of syscalls, but there are a few places to lookdoc/developers/todo.rst new file +3
-0+at: + +- `man-pages repository <http://git.kernel.org/cgit/docs/man-pages/man-pages.git>`_
doc/developers/todo.rst new file +11
-0+ or the ``man2`` directory, where it's possible to find newly documented + functionalities. +- `LWN <http://lwn.net>`_ weekly editions. +- `linux-api mailing list <https://lore.kernel.org/linux-api/>`_ where + changes in kernel userspace API are discussed. +- `LTP Github issues <https://github.com/linux-test-project/ltp/issues>`_ + +Rewrite old API tests +--------------------- + +LTP has a long story and, at certain point of its development, new APIwere
+introduced to make kernel testing easier and more efficient. This happened whendoc/developers/todo.rst new file +3
-0+lots of tests were still using old, messy API. + +Some of these tests have been converted to the new API, but this processis
+still ongoing for many others. To have an overview of the tests using old API,doc/developers/todo.rst new file +10
-0+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 withboth
+shell and plain-C languages. Even if writing tests in shell script might seemdoc/developers/todo.rst new file +6
-0+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 kerneldoc/developers/todo.rst new file +3
-0+testing. + +For a complete list of shell tests, please run the following commandinside the
doc/developers/todo.rst new file +9
-0+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` initializationsand a
doc/developers/todo.rst new file +1
-0+direct access to kernel syscalls.doc/index.rst +4
-1@@ -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-c29a585e8b01Best regards,
--
Andrea Cervesato <[email protected]>--
Mailing list info: https://lists.linux.it/listinfo/ltp
Signature · 5 lines
Regards, Li Wang -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi!
Quoted 11 lines
doc/developers/todo.rst new file +5
-0@@ -0,0 +1,75 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +List of ongoing tasks +===================== +
doc/developers/todo.rst line 15
Quoted 10 lines
doc/developers/todo.rst new file +10
-0+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 <https://github.com/linux-test-project/kirk>`_, that will be our official +tests runner in the next future.
^
Just: "in the future."
"next future" sounds like we are moving to a parallel reality or some kind of scifi stuff.
doc/developers/todo.rst line 17
Quoted 1 line
doc/developers/todo.rst new file +1
-0+kirk provides support for remote testing via Qemu, SSH, LTX, parallel
^
Kirk
Quoted 48 lines
doc/developers/todo.rst new file +48
-0+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 <http://git.kernel.org/cgit/docs/man-pages/man-pages.git>`_ + or the ``man2`` directory, where it's possible to find newly documented + functionalities. +- `LWN <http://lwn.net>`_ weekly editions. +- `linux-api mailing list <https://lore.kernel.org/linux-api/>`_ where + changes in kernel userspace API are discussed. +- `LTP Github issues <https://github.com/linux-test-project/ltp/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
doc/developers/todo.rst line 75
Quoted 10 lines
doc/developers/todo.rst new file +10
-0+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.
Maybe we should link the (now empty) shell API page here:
https://linux-test-project.readthedocs.io/en/latest/developers/api_shell_tests.html
I plan to add the shell loader documentation there one day.
Otherwise it looks good to me, thanks for writing this.
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi,
Quoted 5 lines
Maybe we should link the (now empty) shell API page here:
https://linux-test-project.readthedocs.io/en/latest/developers/api_shell_tests.html
I don't know if it makes sense to link a documentation that is empty. It would be nice to write it first.
Kind Regards,
Signature · 7 lines
Andrea Cervesato SUSE QE Automation Engineer Linux [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Quoted 10 lines
Hi,
Quoted 3 lines
Maybe we should link the (now empty) shell API page here:
https://linux-test-project.readthedocs.io/en/latest/developers/api_shell_tests.html
I don't know if it makes sense to link a documentation that is empty. It would be nice to write it first.
+1.
Let's merge it with 2 other typos/wording Cyril found.
And afterwards, if somebody writes shell loader doc, we can add it there and link the document.
Kind regards,
Petr
Quoted 1 line
Kind Regards,
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Andrea,
Quoted 9 lines
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 <[email protected]>
Thanks for your patience!
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Quoted 10 lines · Petr Vorel
Hi Andrea,
Quoted 7 lines
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.
Quoted 8 lines
Quoted 1 line
Acked-by Petr Vorel <[email protected]>Reviewed-by Petr Vorel <[email protected]>Thanks for your patience!
Kind regards,
Petr
Merged thanks.
Signature · 7 lines
Andrea Cervesato SUSE QE Automation Engineer Linux [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp