[LTP] [PATCH 0/2] docs: cleanup and fix

[LTP] [PATCH 0/2] docs: cleanup and fix

[Andrea Cervesato]

We currently faced a modification of open12 test, that was causing a
failure in the documentation build, due to the wrong definition of .type
as `.type = NULL`. The test was fixed, but everytime we have an empty
filesystem type, such as it is now in the open12 test, we end up having
a documentation build failure. This series of patches are checking if
one of the metadata attributes is having empty values and it eventually
skips that parameter in the attributes test list.

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
Andrea Cervesato (2):
      docs: make sure docs are built if filesystems is empty
      docs: make sphinx verbose so it's easier to debug in CI

 doc/Makefile | 2 +-
 doc/conf.py  | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)
---
base-commit: 080ced081cfff577991c9b71ddb850bdbb9355a0
change-id: 20250617-doc_fix_table_generate-8deee06f937a

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


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

[LTP] [PATCH 1/2] docs: make sure docs are built if filesystems is empty

[Andrea Cervesato]

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

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 doc/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/conf.py b/doc/conf.py
index 23fe7a1b9742f604a5b97f0db62b29ed9c64c445..da768232b5451bd507d2ffacc12e20c2e0a8321c 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -422,7 +422,8 @@ def _generate_setup_table(keys):
             else:
                 values.append(value)
 
-        table.extend(_generate_table_cell(key, values))
+        if values:
+            table.extend(_generate_table_cell(key, values))
 
     return table
 

-- 
2.43.0


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

Re: [LTP] [PATCH 1/2] docs: make sure docs are built if filesystems is empty

[Cyril Hrubis]

Hi!
So the problem is that if we do not find anything interesting in the
metadata we attempt to append empty values. The fix looks good.

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

-- 
Cyril Hrubis
chrubis@suse.cz

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

[LTP] [PATCH 2/2] docs: make sphinx verbose so it's easier to debug in CI

[Andrea Cervesato]

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

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 doc/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/Makefile b/doc/Makefile
index 2062d6e935618d96c169b4a6183441715e768ef6..3123b1cd7a1568d2c7783c28a3d42cb313253e3c 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -24,7 +24,7 @@ ${abs_top_builddir}/metadata/ltp.json:
 	$(MAKE) -C ${abs_top_builddir}/metadata
 
 all: ${abs_top_builddir}/metadata/ltp.json
-	$(RUN_VENV); sphinx-build -b html . html
+	$(RUN_VENV); sphinx-build -v -b html . html
 
 spelling:
 	$(RUN_VENV); sphinx-build -b spelling -d build/doctree . build/spelling

-- 
2.43.0


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

Re: [LTP] [PATCH 2/2] docs: make sphinx verbose so it's easier to debug in CI

[Cyril Hrubis]

Hi!
The traces looks much better with this :-).

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>

-- 
Cyril Hrubis
chrubis@suse.cz

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

Re: [LTP] [PATCH 0/2] docs: cleanup and fix

[Andrea Cervesato via ltp]

Merged!

- Andrea

On 6/17/25 09:47, Andrea Cervesato wrote:
> We currently faced a modification of open12 test, that was causing a
> failure in the documentation build, due to the wrong definition of .type
> as `.type = NULL`. The test was fixed, but everytime we have an empty
> filesystem type, such as it is now in the open12 test, we end up having
> a documentation build failure. This series of patches are checking if
> one of the metadata attributes is having empty values and it eventually
> skips that parameter in the attributes test list.
>
> Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
> ---
> Andrea Cervesato (2):
>        docs: make sure docs are built if filesystems is empty
>        docs: make sphinx verbose so it's easier to debug in CI
>
>   doc/Makefile | 2 +-
>   doc/conf.py  | 3 ++-
>   2 files changed, 3 insertions(+), 2 deletions(-)
> ---
> base-commit: 080ced081cfff577991c9b71ddb850bdbb9355a0
> change-id: 20250617-doc_fix_table_generate-8deee06f937a
>
> Best regards,

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