Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mauro.chehab@linux.intel.com>
To: igt-dev@lists.freedesktop.org
Subject: [igt-dev] [PATCH i-g-t 07/11] scripts/test_list.py: better handle documentation validation issues
Date: Mon, 27 Mar 2023 15:31:51 +0200	[thread overview]
Message-ID: <20230327133155.2428454-8-mauro.chehab@linux.intel.com> (raw)
In-Reply-To: <20230327133155.2428454-1-mauro.chehab@linux.intel.com>

From: Mauro Carvalho Chehab <mchehab@kernel.org>

Produce warnings and exit with an error when test plan is out of sync.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
 scripts/test_list.py | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/scripts/test_list.py b/scripts/test_list.py
index 73c1794caec5..7d35deda3329 100755
--- a/scripts/test_list.py
+++ b/scripts/test_list.py
@@ -803,16 +803,14 @@ class TestList:
                 run_missing.append(run_test)
 
         if doc_uneeded:
-            print("Unused documentation")
             for test_name in doc_uneeded:
-                print(test_name)
+                print(f"Warning: Documented {test_name} doesn't exist on source files")
 
         if run_missing:
-            if doc_uneeded:
-                print()
-            print("Missing documentation")
             for test_name in run_missing:
-                print(test_name)
+                print(f'Warning: Missing documentation for {test_name}')
+        if doc_uneeded or run_missing:
+            sys.exit(1)
 
     #
     # File handling methods
-- 
2.39.2

  parent reply	other threads:[~2023-03-27 13:32 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-27 13:31 [igt-dev] [PATCH i-g-t 00/11] Improve igt_doc.py Mauro Carvalho Chehab
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 01/11] xe_test_config.json: do some adjustments at the output hierarchy Mauro Carvalho Chehab
2023-03-29 17:47   ` Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 02/11] scripts/igt_doc.py: move show_subtests logic to the class Mauro Carvalho Chehab
2023-03-29 17:49   ` Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 03/11] scripts/igt_doc.py: add support to generate testlists Mauro Carvalho Chehab
2023-03-29 17:51   ` Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 04/11] scripts/igt_doc.py: prepare to place TestList class on a separate file Mauro Carvalho Chehab
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 05/11] scripts/test_list.py: prepare to place " Mauro Carvalho Chehab
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 06/11] scripts/igt_doc.py: re-introduce it by calling test_list.py Mauro Carvalho Chehab
2023-03-27 13:31 ` Mauro Carvalho Chehab [this message]
2023-03-29 17:53   ` [igt-dev] [PATCH i-g-t 07/11] scripts/test_list.py: better handle documentation validation issues Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 08/11] scripts/test_list.py: add support for igt_simple_main Mauro Carvalho Chehab
2023-03-29 17:54   ` Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 09/11] testplan/meson.build: Validate documentation at build time Mauro Carvalho Chehab
2023-03-29 17:55   ` Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 10/11] xe/xe_vm: add documentation for igt@xe_vm@userptr-invalid Mauro Carvalho Chehab
2023-03-29 17:56   ` Kamil Konieczny
2023-03-27 13:31 ` [igt-dev] [PATCH i-g-t 11/11] xe/xe_noexec_ping_pong: document subtest Mauro Carvalho Chehab
2023-03-29 17:56   ` Kamil Konieczny
2023-03-27 15:58 ` [igt-dev] ✗ GitLab.Pipeline: warning for Improve igt_doc.py Patchwork
2023-03-27 16:15 ` [igt-dev] ✓ Fi.CI.BAT: success " Patchwork
2023-03-27 22:18 ` [igt-dev] ✓ Fi.CI.IGT: " Patchwork
2023-03-29 17:59 ` [igt-dev] [PATCH i-g-t 00/11] " Kamil Konieczny
2023-03-30  5:25   ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230327133155.2428454-8-mauro.chehab@linux.intel.com \
    --to=mauro.chehab@linux.intel.com \
    --cc=igt-dev@lists.freedesktop.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox