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

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

[Petr Vorel]

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.

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}.

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).

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%)

-- 
2.47.2


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

[LTP] [PATCH 1/6] create-tarballs-metadata.sh: Remove metadata generation

[Petr Vorel]

1bf344a3db started to generate test catalog as part of online sphinx
documentation, which replaces metadata generation done with
asciidoc{,tor} and docparse/testinfo.pl.

This means that whole docparse/ will be deleted, but tools in metadata/
will stay (JSON is input also for sphinx).

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 tools/create-tarballs-metadata.sh | 9 +--------
 1 file changed, 1 insertion(+), 8 deletions(-)

diff --git a/tools/create-tarballs-metadata.sh b/tools/create-tarballs-metadata.sh
index d0b9d0d97b..227f7e69f8 100755
--- a/tools/create-tarballs-metadata.sh
+++ b/tools/create-tarballs-metadata.sh
@@ -1,7 +1,7 @@
 #!/bin/sh -eu
 # SPDX-License-Identifier: GPL-2.0-or-later
 # Copyright (c) 2023 Petr Vorel <pvorel@suse.cz>
-# Create tarballs and metadata for uploading after tagging release.
+# Create tarballs for uploading after tagging release.
 # https://github.com/linux-test-project/ltp/wiki/LTP-Release-Procedure
 
 basedir="$(dirname "$0")"
@@ -47,11 +47,4 @@ for alg in $checksums; do
 	done
 done
 
-# metadata documentation
-title "Generate metadata documentation"
-cd $tarball_dir
-rod ./configure --with-metadata-generator=asciidoctor
-rod make -C metadata
-cp -v docparse/metadata.html $dir/metadata.$tag.html
-
 echo "Generated files are in '$dir', upload them to github"
-- 
2.47.2


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

[LTP] [PATCH 2/6] github: Stop building asciidoc{, tor} documentation

[Petr Vorel]

It will be removed.

$CONFIGURE_OPT_EXTRA is kept in build.sh, if somebody wants to use it
for a local build (unused in CI).

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 .github/workflows/ci-docker-build.yml | 14 +-------------
 1 file changed, 1 insertion(+), 13 deletions(-)

diff --git a/.github/workflows/ci-docker-build.yml b/.github/workflows/ci-docker-build.yml
index f33dd83566..44dcca0550 100644
--- a/.github/workflows/ci-docker-build.yml
+++ b/.github/workflows/ci-docker-build.yml
@@ -49,7 +49,6 @@ jobs:
           - container: "alpine:latest"
             env:
               CC: gcc
-              METADATA: asciidoctor
 
           # build with minimal dependencies
           - container: "debian:stable"
@@ -66,13 +65,11 @@ jobs:
           - container: "quay.io/centos/centos:stream9"
             env:
               CC: gcc
-              METADATA: asciidoc-pdf
               TREE: out
 
           - container: "debian:testing"
             env:
               CC: gcc
-              METADATA: asciidoctor-pdf
 
           - container: "debian:oldstable"
             env:
@@ -83,33 +80,27 @@ jobs:
             env:
               CC: clang
               MAKE_INSTALL: 1
-              METADATA: asciidoctor-pdf
 
           - container: "opensuse/leap:latest"
             env:
               CC: gcc
-              METADATA: asciidoc-pdf
 
           - container: "debian:oldstable"
             env:
               CC: gcc
-              METADATA: asciidoctor
 
           - container: "debian:testing"
             env:
               CC: clang
-              METADATA: asciidoctor-pdf
 
           - container: "ubuntu:jammy"
             env:
               CC: gcc
-              METADATA: asciidoctor
               TREE: out
 
           - container: "ubuntu:bionic"
             env:
               CC: gcc
-              METADATA: asciidoc-pdf
 
     container:
       image: ${{ matrix.container }}
@@ -142,11 +133,8 @@ jobs:
 
     - name: Configure
       run: |
-        if [ "$METADATA" = "asciidoc-pdf" ]; then CONFIGURE_OPT_EXTRA="--with-metadata-generator=asciidoc --enable-metadata-pdf"; fi
-        if [ "$METADATA" = "asciidoctor" ]; then CONFIGURE_OPT_EXTRA="--with-metadata-generator=asciidoctor"; fi
-        if [ "$METADATA" = "asciidoctor-pdf" ]; then CONFIGURE_OPT_EXTRA="--with-metadata-generator=asciidoctor --enable-metadata-pdf"; fi
         case "$VARIANT" in cross-compile*) BUILD="cross";; i386) BUILD="32";; *) BUILD="native";; esac
-        CONFIGURE_OPT_EXTRA="$CONFIGURE_OPT_EXTRA" ./build.sh -r configure -o ${TREE:-in} -t $BUILD -c $CC
+        ./build.sh -r configure -o ${TREE:-in} -t $BUILD -c $CC
 
     - name: Compile
       run: ./build.sh -r build -o ${TREE:-in}
-- 
2.47.2


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

[LTP] [PATCH 3/6] ci: Don't install asciidoc{,tor}

[Petr Vorel]

It was removed from GitHub Actions build previous commit.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 ci/alpine.sh     | 2 --
 ci/debian.sh     | 8 --------
 ci/fedora.sh     | 2 --
 ci/tumbleweed.sh | 3 ---
 4 files changed, 15 deletions(-)

diff --git a/ci/alpine.sh b/ci/alpine.sh
index 93acd6267b..f486cd51ea 100755
--- a/ci/alpine.sh
+++ b/ci/alpine.sh
@@ -6,8 +6,6 @@ apk update
 
 apk add \
 	acl-dev \
-	asciidoc \
-	asciidoctor \
 	autoconf \
 	automake \
 	clang \
diff --git a/ci/debian.sh b/ci/debian.sh
index fc1c1b3ec6..06eedb47c9 100755
--- a/ci/debian.sh
+++ b/ci/debian.sh
@@ -35,9 +35,6 @@ pkg_minimal="
 
 pkg_nonessential="
 	acl-dev
-	asciidoc-base
-	asciidoc-dblatex
-	asciidoctor
 	libacl1-dev
 	libaio-dev
 	libcap-dev
@@ -50,9 +47,6 @@ pkg_nonessential="
 	libssl-dev
 "
 
-# Missing on Ubuntu 18.04 LTS (Bionic Beaver)
-pkg_maybe_nonessential="ruby-asciidoctor-pdf"
-
 case "$ACTION" in
 	minimal)
 		echo "=== Installing only minimal dependencies ==="
@@ -61,12 +55,10 @@ case "$ACTION" in
 	remove-nonessential)
 		echo "=== Make sure devel libraries are removed ==="
 		$remove $pkg_nonessential
-		$remove $pkg_maybe_nonessential || true
 		;;
 	*)
 		echo "=== Installing dependencies ==="
 		$install $pkg_minimal $pkg_nonessential
-		$install $pkg_maybe_nonessential || true
 		;;
 esac
 
diff --git a/ci/fedora.sh b/ci/fedora.sh
index 623dbb5cb6..d1f3c78113 100755
--- a/ci/fedora.sh
+++ b/ci/fedora.sh
@@ -5,7 +5,6 @@
 yum="yum -y install --skip-broken"
 
 $yum \
-	asciidoc \
 	autoconf \
 	automake \
 	make \
@@ -24,4 +23,3 @@ $yum \
 
 # CentOS 8 fixes
 $yum libmnl-devel || $yum libmnl
-$yum rubygem-asciidoctor || true
diff --git a/ci/tumbleweed.sh b/ci/tumbleweed.sh
index 42d62c0e05..841ed67869 100755
--- a/ci/tumbleweed.sh
+++ b/ci/tumbleweed.sh
@@ -5,7 +5,6 @@
 zyp="zypper --non-interactive install --force-resolution --no-recommends"
 
 $zyp \
-	asciidoc \
 	autoconf \
 	automake \
 	clang \
@@ -29,5 +28,3 @@ $zyp \
 	lsb-release \
 	perl-JSON \
 	pkg-config
-
-$zyp ruby2.7-rubygem-asciidoctor || $zyp ruby2.5-rubygem-asciidoctor || true
-- 
2.47.2


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

[LTP] [PATCH 4/6] doc: Replace docparse info with sphinx

[Petr Vorel]

Update doc changes from previous commit.

* Remove docparse example output from release procedure
* Patch review links to building docs with sphinx
* Comments in lib/tst_test.c now point to sphinx

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/developers/writing_tests.rst          | 13 +++++++------
 doc/maintainers/ltp_release_procedure.rst |  6 ------
 doc/maintainers/patch_review.rst          |  4 ++--
 lib/tst_test.c                            |  4 ++--
 4 files changed, 11 insertions(+), 16 deletions(-)

diff --git a/doc/developers/writing_tests.rst b/doc/developers/writing_tests.rst
index ab633121ed..4e4f5ce34a 100644
--- a/doc/developers/writing_tests.rst
+++ b/doc/developers/writing_tests.rst
@@ -63,12 +63,13 @@ things are done.
 
 Never ever comment the obvious.
 
-In case of LTP testcases, it's customary to add an asciidoc formatted comment
-paragraph with high-level test description at the beginning of the file right
-under the GPL SPDX header. This helps other people to understand the overall
-goal of the test before they dive into the technical details. It's also
-exported into generated documentation hence it should mostly explain what is
-tested.
+In case of LTP testcases, it's customary to add an `RST
+<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
+formatted comment paragraph with high-level test description at the beginning
+of the file right under the GPL SPDX header. This helps other people to
+understand the overall goal of the test before they dive into the technical
+details. It's also exported into generated documentation hence it should mostly
+explain what is tested.
 
 DRY (Code duplication)
 ~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/maintainers/ltp_release_procedure.rst b/doc/maintainers/ltp_release_procedure.rst
index 5cb0bbb07f..6259afe0ea 100644
--- a/doc/maintainers/ltp_release_procedure.rst
+++ b/doc/maintainers/ltp_release_procedure.rst
@@ -116,11 +116,6 @@ metadata documentation:
     sha1 ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha1
     sha256sum ltp-full-YYYYMMDD.tar.xz > ltp-full-YYYYMMDD.tar.xz.sha256
 
-    # Generate metadata documentation
-    ./configure --with-metadata-generator=asciidoctor
-    make -C metadata
-    cp -v docparse/metadata.html ../metadata.YYYYMMDD.html
-
 You can use :master:`tools/create-tarballs-metadata.sh` script to have the above
 procedure automated. All generated files are placed in the
 ``ltp-release-YYYYMMDD`` directory.
@@ -143,7 +138,6 @@ procedure automated. All generated files are placed in the
     ===== Generate metadata documentation =====
     checking for a BSD-compatible install... /usr/bin/install -c
     ...
-    'docparse/metadata.html' -> '/home/foo/ltp-release-YYYYMMDD/metadata.YYYYMMDD.html'
     Generated files are in '/home/foo/ltp-release-YYYYMMDD', upload them to github
 
 Upload the generated files to GitHub
diff --git a/doc/maintainers/patch_review.rst b/doc/maintainers/patch_review.rst
index 36caaf23bd..28bc4faf34 100644
--- a/doc/maintainers/patch_review.rst
+++ b/doc/maintainers/patch_review.rst
@@ -47,7 +47,7 @@ The following are examples and may not be appropriate for all tests.
 * Compare usage of system calls with kernel code
 * Double check commit message
 * Search the LTP library for existing helper functions
-* Check doc formatting, i.e. ``make doc && chromium docparse/metadata.html``
+* Check doc formatting, see :doc:`../developers/documentation`.
 
 How to find subtle errors
 -------------------------
@@ -149,7 +149,7 @@ C tests
 * Use :doc:`../developers/api_c_tests`, implementing :ref:`struct tst_test`
 * Test binaries are added into corresponding ``.gitignore`` files
 * Check coding style with ``make check``
-* Docparse documentation
+* Metadata documentation
 * If a test is a regression test it should include :ref:`.tags<struct tst_tag>` in the
   :ref:`struct tst_test` definition
 
diff --git a/lib/tst_test.c b/lib/tst_test.c
index 934a7f866d..e2803f04a7 100644
--- a/lib/tst_test.c
+++ b/lib/tst_test.c
@@ -44,7 +44,7 @@
  */
 const char *TCID __attribute__((weak));
 
-/* update also docparse/testinfo.pl */
+/* update also doc/conf.py */
 #define LINUX_GIT_URL "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id="
 #define LINUX_STABLE_GIT_URL "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/commit/?id="
 #define GLIBC_GIT_URL "https://sourceware.org/git/?p=glibc.git;a=commit;h="
@@ -898,7 +898,7 @@ static void print_failure_hint(const char *tag, const char *hint,
 
 static int show_failure_hints;
 
-/* update also docparse/testinfo.pl */
+/* update also doc/conf.py */
 static void print_failure_hints(void)
 {
 	print_failure_hint("linux-git", "missing kernel fixes", LINUX_GIT_URL);
-- 
2.47.2


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

[LTP] [PATCH 5/6] Move docparse/README.md to metadata/

[Petr Vorel]

docparse/ will be removed in the next commit. README.md should be
converted to sphinx documentation in doc/, but keep it until done.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 {docparse => metadata}/README.md | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename {docparse => metadata}/README.md (100%)

diff --git a/docparse/README.md b/metadata/README.md
similarity index 100%
rename from docparse/README.md
rename to metadata/README.md
-- 
2.47.2


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

[LTP] [PATCH 6/6] docparse: Remove

[Petr Vorel]

Test catalog is generating via sphinx (see 1bf344a3db), unused code for
generating test catalog documentation ("docparse") is removed.

Remove whole docparse/ directory (docparse/testinfo.pl + docs), m4
custom scripts and vendored m4/ax_prog_perl_modules.m4, update
configure.ac and metadata/Makefile.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 configure.ac               |  32 ---
 docparse/.gitignore        |   5 -
 docparse/Makefile          |  69 -----
 docparse/testinfo.pl       | 526 -------------------------------------
 m4/ax_prog_perl_modules.m4 |  77 ------
 m4/ltp-docparse.m4         | 118 ---------
 metadata/Makefile          |   9 -
 7 files changed, 836 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

diff --git a/configure.ac b/configure.ac
index 672880bfc7..344b2ae2c8 100644
--- a/configure.ac
+++ b/configure.ac
@@ -266,33 +266,6 @@ else
     AC_SUBST([WITH_BASH],["no"])
 fi
 
-# metadata
-AC_ARG_ENABLE([metadata],
-  [AS_HELP_STRING([--disable-metadata],
-	[Disable metadata generation (both HTML and PDF, default no)])],
-  [], [enable_metadata=yes]
-)
-AC_ARG_ENABLE([metadata_html],
-  [AS_HELP_STRING([--disable-metadata-html],
-	[Disable metadata HTML generation (default no)])],
-  [], [enable_metadata_html=yes]
-)
-
-AC_ARG_ENABLE([metadata_pdf],
-  [AS_HELP_STRING([--enable-metadata-pdf],
-	[Enable metadata PDF generation (default no)])],
-  [], [enable_metadata_pdf=no]
-)
-
-AC_ARG_WITH([metadata_generator],
-  [AS_HELP_STRING([--with-metadata-generator=asciidoc|asciidoctor],
-	[Specify metadata generator to use (default autodetect)])],
-  [with_metadata_generator=$withval],
-  [with_metadata_generator=detect]
-)
-
-LTP_DOCPARSE
-
 # Expect
 AC_ARG_WITH([expect],
   [AS_HELP_STRING([--with-expect],
@@ -467,11 +440,6 @@ libmnl: ${have_libmnl:-yes}
 libnuma: ${have_libnuma:-no} (headers: ${have_numa_headers:-yes}, v2 headers: ${have_numa_headers_v2:-no})
 libtirpc: ${have_libtirpc:-no}
 glibc SUN-RPC: ${have_rpc_glibc:-no}
-
-METADATA
-metadata generator: $with_metadata_generator
-HTML metadata: $with_metadata_html
-PDF metadata: $with_metadata_pdf
 EOF
 
 if test "x$with_realtime_testsuite" = xyes; then
diff --git a/docparse/.gitignore b/docparse/.gitignore
deleted file mode 100644
index d786a4762b..0000000000
--- a/docparse/.gitignore
+++ /dev/null
@@ -1,5 +0,0 @@
-/*.txt
-/docbook-xsl.css
-/metadata.html
-/metadata.pdf
-/metadata.chunked/
diff --git a/docparse/Makefile b/docparse/Makefile
deleted file mode 100644
index 20851fba63..0000000000
--- a/docparse/Makefile
+++ /dev/null
@@ -1,69 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0-or-later
-# Copyright (c) 2019 Cyril Hrubis <chrubis@suse.cz>
-# Copyright (c) 2020 Petr Vorel <pvorel@suse.cz>
-
-top_srcdir		?= ..
-
-include $(top_srcdir)/include/mk/env_pre.mk
-include $(top_srcdir)/include/mk/functions.mk
-
-ifeq ($(METADATA_GENERATOR),asciidoctor)
-METADATA_GENERATOR_CMD := asciidoctor
-METADATA_GENERATOR_PARAMS := -d book metadata.txt
-METADATA_GENERATOR_PARAMS_HTML := -b xhtml
-METADATA_GENERATOR_PARAMS_PDF := -b pdf -r asciidoctor-pdf
-else ifeq ($(METADATA_GENERATOR),asciidoc)
-METADATA_GENERATOR_CMD := a2x
-METADATA_GENERATOR_PARAMS := --xsltproc-opts "--stringparam toc.section.depth 1" -d book -L  --resource="$(PWD)" metadata.txt
-METADATA_GENERATOR_PARAMS_HTML := -f xhtml
-METADATA_GENERATOR_PARAMS_PDF := -f pdf
-METADATA_GENERATOR_PARAMS_HTML_CHUNKED := -f chunked
-else ifeq ($(METADATA_GENERATOR),)
-$(error 'METADATA_GENERATOR' not configured, run ./configure in the root directory)
-else
-$(error '$(METADATA_GENERATOR)' not supported, only asciidoctor and asciidoc are supported)
-endif
-
-ifdef VERBOSE
-METADATA_GENERATOR_PARAMS += -v
-endif
-
-CLEAN_TARGETS		:= *.css *.js *.txt
-
-ifeq ($(WITH_METADATA_HTML),yes)
-MAKE_TARGETS		+= metadata.html
-ifneq ($(METADATA_GENERATOR_PARAMS_HTML_CHUNKED),)
-MAKE_TARGETS		+= metadata.chunked
-endif
-endif
-
-ifeq ($(WITH_METADATA_PDF),yes)
-MAKE_TARGETS		+= metadata.pdf
-endif
-
-INSTALL_DIR = metadata
-INSTALL_TARGETS = *.css *.js
-
-ifndef METADATA_GENERATOR
-METADATA_GENERATOR := asciidoctor
-endif
-
-txt: ${abs_top_builddir}/metadata/ltp.json
-	$(abs_srcdir)/testinfo.pl $<
-
-ifeq ($(WITH_METADATA_HTML),yes)
-metadata.html: txt
-	$(METADATA_GENERATOR_CMD) $(METADATA_GENERATOR_PARAMS) $(METADATA_GENERATOR_PARAMS_HTML)
-
-ifneq ($(METADATA_GENERATOR_PARAMS_HTML_CHUNKED),)
-metadata.chunked: txt
-	$(METADATA_GENERATOR_CMD) $(METADATA_GENERATOR_PARAMS) $(METADATA_GENERATOR_PARAMS_HTML_CHUNKED)
-endif
-endif
-
-ifeq ($(WITH_METADATA_PDF),yes)
-metadata.pdf: txt
-	$(METADATA_GENERATOR_CMD) $(METADATA_GENERATOR_PARAMS) $(METADATA_GENERATOR_PARAMS_PDF)
-endif
-
-include $(top_srcdir)/include/mk/generic_leaf_target.mk
diff --git a/docparse/testinfo.pl b/docparse/testinfo.pl
deleted file mode 100755
index 487b7d5f22..0000000000
--- a/docparse/testinfo.pl
+++ /dev/null
@@ -1,526 +0,0 @@
-#!/usr/bin/perl
-# SPDX-License-Identifier: GPL-2.0-or-later
-# Copyright (c) 2019 Cyril Hrubis <chrubis@suse.cz>
-# Copyright (c) 2020-2021 Petr Vorel <pvorel@suse.cz>
-
-use strict;
-use warnings;
-
-use JSON qw(decode_json);
-use Cwd qw(abs_path);
-use File::Basename qw(dirname);
-
-use constant OUTDIR => dirname(abs_path($0));
-
-# tags which expect git tree, also need constant for URL
-our @TAGS_GIT = ("linux-git", "linux-stable-git", "glibc-git", "musl-git");
-
-# tags should map these in lib/tst_test.c
-use constant LINUX_GIT_URL => "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=";
-use constant LINUX_STABLE_GIT_URL => "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/commit/?id=";
-use constant GLIBC_GIT_URL => "https://sourceware.org/git/?p=glibc.git;a=commit;h=";
-use constant MUSL_GIT_URL => "https://git.musl-libc.org/cgit/musl/commit/src/linux/clone.c?id=";
-use constant CVE_DB_URL => "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-";
-
-sub load_json
-{
-	my ($fname, $mode) = @_;
-	local $/;
-
-	open(my $fh, '<', $fname) or die("Can't open $fname $!");
-
-	return <$fh>;
-}
-
-sub log_info
-{
-	my $msg = shift;
-	print STDERR "INFO: $msg\n";
-}
-
-sub log_warn
-{
-	my $msg = shift;
-	print STDERR "WARN: $msg\n";
-}
-
-sub print_asciidoc_page
-{
-	my ($fh, $json, $title, $content) = @_;
-
-	print $fh <<EOL;
-// -*- mode:doc; -*-
-// vim: set syntax=asciidoc:
-
-$title
-
-$content
-EOL
-}
-
-sub tag_url {
-	my ($tag, $value, $scm_url_base) = @_;
-
-	if ($tag eq "fname") {
-		return $scm_url_base . $value;
-	}
-
-	if ($tag eq "CVE") {
-		return CVE_DB_URL . $value;
-	}
-
-	# *_GIT_URL
-	my $key = tag2env($tag) . "_URL";
-	if (defined($constant::declared{"main::$key"})) {
-		return eval("main::$key") . $value;
-	}
-
-	if ('known-fail') {
-		return '';
-	}
-
-	die("unknown constant '$key' for tag $tag, define it!");
-}
-
-sub bold
-{
-	return "*$_[0]*";
-}
-
-sub code
-{
-	return "+$_[0]+";
-}
-
-sub hr
-{
-	return "\n\n'''\n\n";
-}
-
-sub html_a
-{
-	my ($url, $text) = @_;
-
-	# escape: ] |
-	$text =~ s/([]|])/\\$1/g;
-
-	return "$url\[$text\]";
-}
-
-sub h1
-{
-	return "== $_[0]\n";
-}
-
-sub h2
-{
-	return "=== $_[0]\n";
-}
-
-sub h3
-{
-	return "==== $_[0]\n";
-}
-
-sub label
-{
-	return "[[$_[0]]]\n";
-}
-
-sub paragraph
-{
-	return "$_[0]\n\n";
-}
-
-sub reference
-{
-	my ($link, %args) = @_;
-
-	$args{text} //= $link;
-	$args{delimiter} //= "";
-
-	return "xref:$link\[$args{text}\]$args{delimiter}\n";
-}
-
-sub table
-{
-	return "|===\n";
-}
-
-sub table_escape
-{
-	my $out = $_[0];
-
-	$out =~ s/\|/\\|/g;
-	return $out;
-}
-
-sub print_defined
-{
-	my ($key, $val, $val2) = @_;
-
-	if (defined($val)) {
-		return paragraph(bold($key) . ": " . $val . (defined($val2) ? " $val2" : ""));
-	}
-}
-
-sub content_about
-{
-	my $json = shift;
-	my $content;
-
-	$content .= print_defined("URL", $json->{'testsuite'}->{'url'});
-	$content .= print_defined("Version", $json->{'testsuite'}->{'version'});
-	$content .= print_defined("Default timeout", $json->{'defaults'}->{'timeout'}, "seconds");
-
-	return $content;
-}
-
-sub uniq {
-	my %seen;
-	grep !$seen{$_}++, @_;
-}
-
-sub get_test_names
-{
-	my @names = @{$_[0]};
-	my ($letter, $prev_letter);
-	my $content;
-
-	for my $name (sort @names) {
-		$letter = substr($name, 0, 1);
-		if (defined($prev_letter) && $letter ne $prev_letter) {
-			$content .= "\n";
-		}
-
-		$content .= reference($name, delimiter => " ");
-		$prev_letter = $letter;
-	}
-	$content .= "\n";
-
-	return $content;
-}
-
-sub get_test_letters
-{
-	my @names = @{$_[0]};
-	my $letter;
-	my $prev_letter = "";
-	my $content;
-
-	for (@names) {
-		$_ = substr($_, 0, 1);
-	}
-	@names = uniq(@names);
-
-	for my $letter (@names) {
-		$content .= reference($letter);
-	}
-	$content .= "\n";
-
-	return $content;
-}
-
-sub tag2title
-{
-	my $tag = shift;
-	return code(".$tag");
-}
-
-sub get_filters
-{
-	my $json = shift;
-	my %data;
-
-	while (my ($k, $v) = each %{$json->{'tests'}}) {
-		for my $j (keys %{$v}) {
-			next if ($j eq 'fname' || $j eq 'doc');
-			$data{$j} = () unless (defined($data{$j}));
-
-			if ($j eq 'tags') {
-				for my $tags (@{$v}{'tags'}) {
-					for my $tag (@$tags) {
-						my $k2 = $$tag[0];
-						my $v2 = $$tag[1];
-						$data{$j}{$k2} = () unless (defined($data{$j}{$k2}));
-						push @{$data{$j}{$k2}}, $k unless grep{$_ eq $k} @{$data{$j}{$k2}};
-					}
-				}
-			} else {
-				push @{$data{$j}}, $k unless grep{$_ eq $k} @{$data{$j}};
-			}
-		}
-	}
-	return \%data;
-}
-
-sub content_filter
-{
-	my $k = $_[0];
-	my $title = $_[1];
-	my $desc = $_[2];
-	my $h = $_[3];
-	my ($letter, $prev_letter, $content);
-
-	$content = label($k);
-	$content .= $title;
-	$content .= paragraph("Tests containing $desc flag.");
-
-	$content .= get_test_names(\@{$h});
-
-	return $content;
-}
-
-sub content_filters
-{
-	my $json = shift;
-	my $data = get_filters($json);
-	my %h = %$data;
-	my $content;
-
-	for my $k (sort keys %$data) {
-		my $title = tag2title($k);
-		if (ref($h{$k}) eq 'HASH') {
-			$content .= label($k);
-			$content .= h2($title);
-			for my $k2 (sort keys %{$h{$k}}) {
-				my $title2 = code($k2);
-				$content .= content_filter($k2, h3($title2), "$title $title2", $h{$k}{$k2});
-			}
-		} else {
-			$content .= content_filter($k, h2($title), $title, \@{$h{$k}});
-		}
-	}
-
-	return $content;
-}
-
-sub tag2env
-{
-	my $tag = shift;
-	$tag =~ s/-/_/g;
-	return uc($tag);
-}
-
-sub detect_git
-{
-	my %data;
-
-	for my $tag (@TAGS_GIT) {
-		my $env = tag2env($tag);
-
-		unless (defined $ENV{$env} && $ENV{$env}) {
-			log_warn("git repository $tag not defined. Define it in \$$env");
-			next;
-		}
-
-		unless (-d $ENV{$env}) {
-			log_warn("\$$env does not exit ('$ENV{$env}')");
-			next;
-		}
-
-		if (system("which git >/dev/null")) {
-			log_warn("git not in \$PATH ('$ENV{'PATH'}')");
-			next;
-		}
-
-		chdir($ENV{$env});
-		if (!system("git log -1 > /dev/null")) {
-			log_info("using '$ENV{$env}' as $env repository");
-			$data{$tag} = $ENV{$env};
-		} else {
-			log_warn("git failed, git not installed or \$$env is not a git repository? ('$ENV{$env}')");
-		}
-		chdir(OUTDIR);
-	}
-
-	return \%data;
-}
-
-sub content_all_tests
-{
-	my $json = shift;
-	my @names = sort keys %{$json->{'tests'}};
-	my $letters = paragraph(get_test_letters(\@names));
-	my $git_url = detect_git();
-	my $tmp = undef;
-	my $printed = "";
-	my $content;
-
-	$content .= paragraph("Total $#names tests.");
-	$content .= $letters;
-	$content .= get_test_names(\@names);
-
-	for my $name (@names) {
-		my $letter = substr($name, 0, 1);
-
-		if ($printed ne $letter) {
-			$content .= label($letter);
-			$content .= h2($letter);
-			$printed = $letter;
-		}
-
-		$content .= hr() if (defined($tmp));
-		$content .= label($name);
-		$content .= h3($name);
-		$content .= $letters;
-
-		if (defined($json->{'testsuite'}->{'scm_url_base'}) &&
-			defined($json->{'tests'}{$name}{fname})) {
-			$content .= paragraph(html_a(tag_url("fname", $json->{'tests'}{$name}{fname},
-					$json->{'testsuite'}->{'scm_url_base'}), "source"));
-		}
-
-		if (defined $json->{'tests'}{$name}{doc}) {
-			for my $doc (@{$json->{'tests'}{$name}{doc}}) {
-
-				# fix formatting for asciidoc [DOCUMENTATION] => *Documentation*
-				if ($doc =~ s/^\[(.*)\]$/$1/) {
-					$doc = paragraph(bold(ucfirst(lc($doc))));
-				}
-
-				$content .= "$doc\n";
-			}
-			$content .= "\n";
-		}
-
-		if ($json->{'tests'}{$name}{timeout}) {
-			if ($json->{'tests'}{$name}{timeout} eq -1) {
-				$content .= paragraph("Test timeout is disabled");
-			} else {
-				$content .= paragraph("Test timeout is $json->{'tests'}{$name}{timeout} seconds");
-			}
-		} else {
-			$content .= paragraph("Test timeout defaults to $json->{'defaults'}->{'timeout'} seconds");
-		}
-
-		my $tmp2 = undef;
-		for my $k (sort keys %{$json->{'tests'}{$name}}) {
-			my $v = $json->{'tests'}{$name}{$k};
-			next if ($k eq "tags" || $k eq "fname" || $k eq "doc");
-			if (!defined($tmp2)) {
-				$content .= table . "|Key|Value\n\n"
-			}
-
-			$content .= "|" . reference($k, text => tag2title($k)) . "\n|";
-
-			if (ref($v) eq 'ARRAY') {
-				# two dimensional array
-				if (ref(@$v[0]) eq 'ARRAY') {
-					for my $v2 (@$v) {
-						# convert NULL to "NULL" string to be printed
-						for my $v3 (@$v2) {
-							$v3 = "NULL" if (!defined $v3);
-						}
-						$content .= paragraph(table_escape(join(', ', @$v2)));
-					}
-				} else {
-					# one dimensional array
-					$content .= table_escape(join(', ', @$v));
-				}
-			} else {
-				# plain content
-				$content .= table_escape($v);
-			}
-
-			$content .= "\n";
-
-			$tmp2 = 1;
-		}
-		if (defined($tmp2)) {
-			$content .= table . "\n";
-		}
-
-		$tmp2 = undef;
-		my %commits;
-		my @sorted_tags = sort { $a->[0] cmp $b->[0] } @{$json->{'tests'}{$name}{tags} // []};
-
-		for my $tag (@sorted_tags) {
-			if (!defined($tmp2)) {
-				$content .= table . "|Tag|Info\n"
-			}
-			my $k = @$tag[0];
-			my $v = @$tag[1];
-			my $url;
-
-			if (defined($$git_url{$k})) {
-				$commits{$k} = () unless (defined($commits{$k}));
-				unless (defined($commits{$k}{$v})) {
-					chdir($$git_url{$k});
-					$commits{$k}{$v} = `git log --pretty=format:'%s' -1 $v`;
-					chdir(OUTDIR);
-				}
-				$v .= ' ("' . $commits{$k}{$v} . '")';
-			}
-
-			$url = tag_url($k, @$tag[1]);
-			if ($url) {
-				$v = html_a($url, $v);
-			}
-
-			# tag value value can be split into more lines if too long
-			# i.e. URL in known-fail
-			for (@$tag[2 .. $#$tag]) {
-				$v .= " $_";
-			}
-
-			$content .= "\n|" . reference($k) . "\n|$v\n";
-			$tmp2 = 1;
-		}
-		if (defined($tmp2)) {
-			$content .= table . "\n";
-		}
-
-		$tmp = 1;
-	}
-
-	return $content;
-}
-
-
-my $json = decode_json(load_json($ARGV[0]));
-
-my $config = [
-    {
-		file => "about.txt",
-		title => h2("About $json->{'testsuite'}->{'name'}"),
-		content => \&content_about,
-    },
-    {
-		file => "filters.txt",
-		title => h1("Test filtered by used flags"),
-		content => \&content_filters,
-    },
-    {
-		file => "all-tests.txt",
-		title => h1("All tests"),
-		content => \&content_all_tests,
-    },
-];
-
-sub print_asciidoc_main
-{
-	my $config = shift;
-	my $file = "metadata.txt";
-	my $content;
-
-	open(my $fh, '>', $file) or die("Can't open $file $!");
-
-	$content = <<EOL;
-:doctype: inline
-:sectanchors:
-:toc:
-
-EOL
-	for my $c (@{$config}) {
-		$content .= "include::$c->{'file'}\[\]\n";
-	}
-	print_asciidoc_page($fh, $json, h1($json->{'testsuite'}->{'short_name'} . " test catalog"), $content);
-}
-
-for my $c (@{$config}) {
-	open(my $fh, '>', $c->{'file'}) or die("Can't open $c->{'file'} $!");
-	print_asciidoc_page($fh, $json, $c->{'title'}, $c->{'content'}->($json));
-}
-
-print_asciidoc_main($config);
diff --git a/m4/ax_prog_perl_modules.m4 b/m4/ax_prog_perl_modules.m4
deleted file mode 100644
index 70b3230ebd..0000000000
--- a/m4/ax_prog_perl_modules.m4
+++ /dev/null
@@ -1,77 +0,0 @@
-# ===========================================================================
-#   https://www.gnu.org/software/autoconf-archive/ax_prog_perl_modules.html
-# ===========================================================================
-#
-# SYNOPSIS
-#
-#   AX_PROG_PERL_MODULES([MODULES], [ACTION-IF-TRUE], [ACTION-IF-FALSE])
-#
-# DESCRIPTION
-#
-#   Checks to see if the given perl modules are available. If true the shell
-#   commands in ACTION-IF-TRUE are executed. If not the shell commands in
-#   ACTION-IF-FALSE are run. Note if $PERL is not set (for example by
-#   calling AC_CHECK_PROG, or AC_PATH_PROG), AC_CHECK_PROG(PERL, perl, perl)
-#   will be run.
-#
-#   MODULES is a space separated list of module names. To check for a
-#   minimum version of a module, append the version number to the module
-#   name, separated by an equals sign.
-#
-#   Example:
-#
-#     AX_PROG_PERL_MODULES( Text::Wrap Net::LDAP=1.0.3, ,
-#                           AC_MSG_WARN(Need some Perl modules)
-#
-# LICENSE
-#
-#   Copyright (c) 2009 Dean Povey <povey@wedgetail.com>
-#
-#   Copying and distribution of this file, with or without modification, are
-#   permitted in any medium without royalty provided the copyright notice
-#   and this notice are preserved. This file is offered as-is, without any
-#   warranty.
-
-#serial 8
-
-AU_ALIAS([AC_PROG_PERL_MODULES], [AX_PROG_PERL_MODULES])
-AC_DEFUN([AX_PROG_PERL_MODULES],[dnl
-
-m4_define([ax_perl_modules])
-m4_foreach([ax_perl_module], m4_split(m4_normalize([$1])),
-	  [
-	   m4_append([ax_perl_modules],
-		     [']m4_bpatsubst(ax_perl_module,=,[ ])[' ])
-          ])
-
-# Make sure we have perl
-if test -z "$PERL"; then
-AC_CHECK_PROG(PERL,perl,perl)
-fi
-
-if test "x$PERL" != x; then
-  ax_perl_modules_failed=0
-  for ax_perl_module in ax_perl_modules; do
-    AC_MSG_CHECKING(for perl module $ax_perl_module)
-
-    # Would be nice to log result here, but can't rely on autoconf internals
-    $PERL -e "use $ax_perl_module; exit" > /dev/null 2>&1
-    if test $? -ne 0; then
-      AC_MSG_RESULT(no);
-      ax_perl_modules_failed=1
-   else
-      AC_MSG_RESULT(ok);
-    fi
-  done
-
-  # Run optional shell commands
-  if test "$ax_perl_modules_failed" = 0; then
-    :
-    $2
-  else
-    :
-    $3
-  fi
-else
-  AC_MSG_WARN(could not find perl)
-fi])dnl
diff --git a/m4/ltp-docparse.m4 b/m4/ltp-docparse.m4
deleted file mode 100644
index 9514e5e1e9..0000000000
--- a/m4/ltp-docparse.m4
+++ /dev/null
@@ -1,118 +0,0 @@
-dnl SPDX-License-Identifier: GPL-2.0-or-later
-dnl Copyright (c) 2020 Petr Vorel <pvorel@suse.cz>
-
-AC_DEFUN([LTP_CHECK_METADATA_GENERATOR_ASCIIDOCTOR], [
-	AC_MSG_NOTICE(checking asciidoctor as metadata generator)
-	AC_PATH_TOOL(asciidoctor, "asciidoctor")
-	metadata_generator_html=$asciidoctor
-	# pdf requires both asciidoctor and asciidoctor-pdf
-	if test "x$metadata_generator_html" != x; then
-		AC_PATH_TOOL(asciidoctor_pdf, "asciidoctor-pdf")
-		metadata_generator_pdf=$asciidoctor_pdf
-	fi
-])
-
-AC_DEFUN([LTP_CHECK_METADATA_GENERATOR_ASCIIDOC], [
-	AC_MSG_NOTICE(checking asciidoc as metadata generator)
-	AC_PATH_TOOL(a2x, "a2x")
-	if test "x$a2x" != x; then
-		version="`$a2x --version | cut -d ' ' -f2 `"
-		AX_COMPARE_VERSION([$version], lt, 9, [
-		AC_MSG_WARN([a2x unsupported version: $version. Use a2x >= 9])
-		a2x=
-		])
-	fi
-	metadata_generator_html=$a2x
-	# pdf requires both asciidoc and dblatex
-	if test "x$metadata_generator_html" != x; then
-		AC_PATH_TOOL(dblatex, "dblatex")
-		metadata_generator_pdf=$dblatex
-	fi
-])
-
-AC_DEFUN([LTP_DOCPARSE], [
-with_metadata=no
-with_metadata_html=no
-with_metadata_pdf=no
-
-if test "x$enable_metadata" != xyes; then
-	enable_metadata_html=no
-	enable_metadata_pdf=no
-	with_metadata_generator=none
-fi
-
-if test "x$enable_metadata_html" = xyes -o "x$enable_metadata_pdf" = xyes; then
-	AX_PROG_PERL_MODULES(Cwd File::Basename JSON LWP::Simple)
-fi
-
-if test "x$ax_perl_modules_failed" = x0; then
-	if test "x$with_metadata_generator" = xasciidoctor -o "x$with_metadata_generator" = xdetect; then
-		LTP_CHECK_METADATA_GENERATOR_ASCIIDOCTOR
-	elif test "x$with_metadata_generator" = xasciidoc; then
-		LTP_CHECK_METADATA_GENERATOR_ASCIIDOC
-	else
-		AC_MSG_ERROR([invalid metadata generator '$with_metadata_generator', use --with-metadata-generator=asciidoc|asciidoctor])
-	fi
-
-	# autodetection: check also Asciidoc
-	if test "x$with_metadata_generator" = xdetect; then
-		with_metadata_generator='asciidoctor'
-		# problems with Asciidoctor: (html enabled && not found) || (pdf enabled && not found) => try Asciidoc
-		if test "x$enable_metadata_html" = xyes -a "x$metadata_generator_html" = x ||
-			test "x$enable_metadata_pdf" = xyes -a "x$metadata_generator_pdf" = x; then
-			backup_html="$metadata_generator_html"
-			backup_pdf="$metadata_generator_pdf"
-			AC_MSG_NOTICE(missing some dependencies for Asciidoctor => trying Asciidoc)
-			with_metadata_generator='asciidoc'
-			LTP_CHECK_METADATA_GENERATOR_ASCIIDOC
-			# prefer Asciidoctor if it's not worse than Asciidoc
-			# (html not enabled || asciidoctor html found || asciidoc html not found) && (pdf ...)
-			if test "x$enable_metadata_html" != xyes -o "x$backup_html" != x -o "x$metadata_generator_html" = x &&
-				test "x$enable_metadata_pdf" != xyes -o "x$backup_pdf" != x -o "x$metadata_generator_pdf" = x; then
-				with_metadata_generator='asciidoctor'
-				metadata_generator_html="$backup_html"
-				metadata_generator_pdf="$backup_pdf"
-			fi
-		fi
-		if test "x$metadata_generator_html" != x -o "x$metadata_generator_pdf" != x; then
-			AC_MSG_NOTICE(choosing $with_metadata_generator for metadata generation)
-		fi
-	fi
-
-	if test "x$enable_metadata_html" = xno; then
-		AC_MSG_NOTICE(HTML metadata generation disabled)
-	elif test "x$metadata_generator_html" != x; then
-		with_metadata_html=yes
-	fi
-
-	if test "x$enable_metadata_pdf" = xno; then
-		AC_MSG_NOTICE(PDF metadata generation disabled)
-	elif test "x$metadata_generator_pdf" != x; then
-		with_metadata_pdf=yes
-	fi
-fi
-
-reason="metadata generation skipped due missing suitable generator"
-hint="specify correct generator with --with-metadata-generator=asciidoc|asciidoctor or use --disable-metadata|--disable-metadata-html|--disable-metadata-pdf"
-
-if test -z "$ax_perl_modules_failed"; then
-	AC_MSG_NOTICE(metadata generation disabled)
-elif test "x$ax_perl_modules_failed" = x1; then
-	AC_MSG_WARN(metadata generation skipped due missing required Perl modules)
-elif test "x$with_metadata_html" = xno -a "x$with_metadata_pdf" = xno; then
-	AC_MSG_WARN([$reason, $hint])
-else
-	with_metadata=yes
-	AC_SUBST(METADATA_GENERATOR, $with_metadata_generator)
-	if test "x$with_metadata_html" = xno -a "x$enable_metadata_html" = xyes; then
-		AC_MSG_WARN([HTML $reason, $hint])
-	fi
-	if test "x$with_metadata_pdf" = xno -a "x$enable_metadata_pdf" = xyes; then
-		AC_MSG_WARN([PDF $reason, $hint])
-	fi
-fi
-
-AC_SUBST(WITH_METADATA, $with_metadata)
-AC_SUBST(WITH_METADATA_HTML, $with_metadata_html)
-AC_SUBST(WITH_METADATA_PDF, $with_metadata_pdf)
-])
diff --git a/metadata/Makefile b/metadata/Makefile
index 522af42705..b4f9f89384 100644
--- a/metadata/Makefile
+++ b/metadata/Makefile
@@ -14,15 +14,6 @@ INSTALL_DIR		= metadata
 
 ltp.json: metaparse
 	$(abs_srcdir)/parse.sh > ltp.json
-ifeq ($(WITH_METADATA),yes)
-	mkdir -p $(abs_top_builddir)/docparse
-	$(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile
-endif
-
-ifeq ($(WITH_METADATA),yes)
-install:
-	$(MAKE) -C $(abs_top_builddir)/docparse/ -f $(abs_top_srcdir)/docparse/Makefile install
-endif
 
 test:
 	$(MAKE) -C $(abs_srcdir)/tests/ test
-- 
2.47.2


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

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

[Andrea Cervesato via ltp]

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

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

[Petr Vorel]

Hi Andrea, all,

> 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

Done already.

> > 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?

No. Not a big priority, but I'd like to do it before the release so that we can
upload generated archive again.

> > 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.

FYI implemented here (let's keep the discussion there)
https://patchwork.ozlabs.org/project/ltp/patch/20250211233552.1990618-1-pvorel@suse.cz/

...
> >   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>

Thanks! FYI merged.

Kind regards,
Petr

> Andrea


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