Re: [LTP] [RFC] Remove [Description] subtitle from docparse

[Petr Vorel <pvorel@suse.cz>]

Hi Andrea,

> On 1/31/25 11:34, Petr Vorel wrote:
> > Hi Andrea,

> > > Hi Petr,
> > > I'm currently working on parsing metadata in order to produce a tests list
> > > in the LTP documentation.
> > FYI I planned to work on it (announced in ML [1]), but since you started I stop
> > working on it.
> I'm sorry, I didn't read carefully. The results will come out soon tho, I
> will send the patch-set soon.

Not a big deal, just sometimes it might happen more people are implementing the
same thing.

> > > I just replace "[Description]" with "**Description**". Same for
> > > "[Algorithm]".
> > > I would keep the bold version tho, with the double star **.
> > We talk about a different things. You about the conversion of the subtitles to
> > the final documentation (previously was done in docparse/testinfo.pl, now you
> > will do it in python).

> > But I'm suggesting to entirely remove subtitle "Description". It looks to me
> > useless and some people don't add it thus docs looks inconsistent.
> The thing is that there's not only [Description], but there's also
> [Algorithm]. Maybe we can think about the tests description as a whole RST
> code that will be injected inside the documentation website once it's
> published. In this way, conversion would be much easier.

As I wrote to Cyril:
The reason why suggested to remove it is that I don't see much information value
in "Description" title. "Algorithm" has at least little bit of information value.

Besides these two we have only:
* [Prerequisites] (testcases/kernel/mem/ksm/ksm07.c)
* [Race Description] (testcases/kernel/syscalls/fork/fork13.c)

Kind regards,
Petr

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