[LTP] [PATCH] Remove TODO

[LTP] [PATCH] Remove TODO

[Andrea Cervesato]

From: Andrea Cervesato <andrea.cervesato@suse.com>

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 new comers. If we really want to have a TODO
list, probably the best place would be doc/ folder.

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 TODO | 39 ---------------------------------------
 1 file changed, 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.

---
base-commit: d2550ffbbcfe163212cd7e9c132db65ae0fa06ed
change-id: 20251006-remove_todo-c29a585e8b01

Best regards,
-- 
Andrea Cervesato <andrea.cervesato@suse.com>


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

Re: [LTP] [PATCH] Remove TODO

[Petr Vorel]

Hi Andrea,

> 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 new comers. If we really want to have a TODO
> list, probably the best place would be doc/ folder.

I vote to have it. So yes, update it and convert it to REST format and move to
doc/.

Kind regards,
Petr

> Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
> ---
>  TODO | 39 ---------------------------------------
>  1 file changed, 39 deletions(-)

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

Re: [LTP] [PATCH] Remove TODO

[Cyril Hrubis]

Hi!
> > 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 new comers. If we really want to have a TODO
> > list, probably the best place would be doc/ folder.
> 
> I vote to have it. So yes, update it and convert it to REST format and move to
> doc/.

Well the TODO list points in there are mostly generic and are not going
to be finished anytime soon. E.g. "write more syscall tests" I'm not
sure how useful such documentation will be. Maybe we need a "where to
start" guide for a new devs, but I'm afraid that it would have to be
written from scratch.

-- 
Cyril Hrubis
chrubis@suse.cz

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

Re: [LTP] [PATCH] Remove TODO

[Petr Vorel]

> Hi!
> > > 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 new comers. If we really want to have a TODO
> > > list, probably the best place would be doc/ folder.

> > I vote to have it. So yes, update it and convert it to REST format and move to
> > doc/.

> Well the TODO list points in there are mostly generic and are not going
> to be finished anytime soon. E.g. "write more syscall tests" I'm not
> sure how useful such documentation will be. Maybe we need a "where to
> start" guide for a new devs, but I'm afraid that it would have to be
> written from scratch.

I'm not against the removal. "Write more syscall tests" contains valid points
(LWN, man pages git repo), but agree it'd have to be completely rewritten.
If anybody writes that, mentioning CVE reproducers in kernel and (g)libc commit
messages would be also useful.

Acked-by: Petr Vorel <pvorel@suse.cz>

Kind regards,
Petr

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

Re: [LTP] [PATCH] Remove TODO

[Petr Vorel]

> > Hi!
> > > > 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 new comers. If we really want to have a TODO
> > > > list, probably the best place would be doc/ folder.

> > > I vote to have it. So yes, update it and convert it to REST format and move to
> > > doc/.

> > Well the TODO list points in there are mostly generic and are not going
> > to be finished anytime soon. E.g. "write more syscall tests" I'm not
> > sure how useful such documentation will be. Maybe we need a "where to
> > start" guide for a new devs, but I'm afraid that it would have to be
> > written from scratch.

> I'm not against the removal. "Write more syscall tests" contains valid points
> (LWN, man pages git repo), but agree it'd have to be completely rewritten.
> If anybody writes that, mentioning CVE reproducers in kernel and (g)libc commit
> messages would be also useful.

-[3] http://dir.gmane.org/gmane.linux.kernel.api
And link to https://lore.kernel.org/linux-api/ might be useful, although I
personally don't follow it.

Kind regards,
Petr

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