Re: [LTP] [PATCH 0/6] Remove asciidoc{,tor} doc

[Andrea Cervesato via ltp <ltp@lists.linux.it>]

Hi Petr,

On 2/7/25 11:55, Petr Vorel wrote:
> Hi,
>
> This is a follow up for Andrea's 1bf344a3db ("doc: add tests catalog page").
>
> Besides these changes I plan:
>
> 1) Configure readthedocs to generate html/pdf doc for user to be able to
> download it.
+1
> 2) Generate html/pdf documentation as a part of the release process
> (build it locally with sphinx), to be able to add it to the release
> as we did with the doc generated by asciidoc{,tor}.
This is a bit tricky. Did you try already?
> 3) Andrea refused to do have virtualenv support in Makefile.
> https://lore.kernel.org/ltp/3032b376-8f7a-4b1c-8422-f5a61e59b680@suse.com/
> I would still prefer to have it, as optional, when some variable is
> passed to make. It's better than copy paste the commands all the time,
> also it would help 2).

Yeah, we can have sphinx + dependences packages installed in the system, 
via pip or using a Dockerfile. virtualenv is just an optional tool we 
don't want to be dependent from.

>
> WDYT?
>
> Tested:
> https://github.com/pevik/ltp/actions/runs/13198229443
> https://github.com/pevik/ltp/actions/runs/13198229440
>
> Kind regards,
> Petr
>
> Petr Vorel (6):
>    create-tarballs-metadata.sh: Remove metadata generation
>    github: Stop building asciidoc{,tor} documentation
>    ci: Don't install asciidoc{,tor}
>    doc: Replace docparse info with sphinx
>    Move docparse/README.md to metadata/
>    docparse: Remove
>
>   .github/workflows/ci-docker-build.yml     |  14 +-
>   ci/alpine.sh                              |   2 -
>   ci/debian.sh                              |   8 -
>   ci/fedora.sh                              |   2 -
>   ci/tumbleweed.sh                          |   3 -
>   configure.ac                              |  32 --
>   doc/developers/writing_tests.rst          |  13 +-
>   doc/maintainers/ltp_release_procedure.rst |   6 -
>   doc/maintainers/patch_review.rst          |   4 +-
>   docparse/.gitignore                       |   5 -
>   docparse/Makefile                         |  69 ---
>   docparse/testinfo.pl                      | 526 ----------------------
>   lib/tst_test.c                            |   4 +-
>   m4/ax_prog_perl_modules.m4                |  77 ----
>   m4/ltp-docparse.m4                        | 118 -----
>   metadata/Makefile                         |   9 -
>   {docparse => metadata}/README.md          |   0
>   tools/create-tarballs-metadata.sh         |   9 +-
>   18 files changed, 13 insertions(+), 888 deletions(-)
>   delete mode 100644 docparse/.gitignore
>   delete mode 100644 docparse/Makefile
>   delete mode 100755 docparse/testinfo.pl
>   delete mode 100644 m4/ax_prog_perl_modules.m4
>   delete mode 100644 m4/ltp-docparse.m4
>   rename {docparse => metadata}/README.md (100%)

The rest looks good. Feel free to push it:

Acked-by: Andrea Cervesato <andrea.cervesato@suse.com>

Andrea


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