[LTP] [PATCH 2/2] doc: Add URL to the sources in syscalls list

[Andrea Cervesato]

Hi Petr,

On 11/15/24 12:04, Petr Vorel wrote:
> @Andrea @Cyril: Other think I would like to have our metadata doc somehow
> generated for the master. But that would require to have installed asciidoctor
> on container, that will not work for sphinx. Also our metadata syntax is somehow
> LTP specific (at least /*\ starter) and having doc on 2 places
> (readthedocshttps://linux-test-project.readthedocs.io/ and static metadata doc
> file uploaded to releases (e.g.
> https://github.com/linux-test-project/ltp/releases/download/20240930/metadata.20240930.html)
> is not optimal. I also like python scripting more than perl (used for metadata).

I remember we talked with Cyril long time ago about this. Yes, it's 
possibly something which requires a move from asciidoc to sphinx syntax. 
It's not so difficult. The rules are pretty simple, since we really 
don't have much information inside the asciidoc format.

Most of the times, it's only a matter of replacing /*\ with /** and to 
change [Description/Algorithm] with ===== underline.

> Other option would be to drop metadata syntax and transform docs to sphinx
> format. But that would require a lot of scripting, we would not want to do it manually.
>
> Also, doc added to releases vs. online doc:
> * Should we add generated readthedocs to releases? One could have docs forever.
> * Should we have also the latest release doc in online readthedocs? Or even for
> * all releases? ATM we have just master.

I think it makes sense to have it in the release, but I don't know if 
it's possible to generate a single file in a easy way. Maybe take a look 
at singlehtml.

Andrea