[igt-dev] [i-g-t] scripts/test_list: Add test_documentation ref to the logs

Bhanuprakash Modem bhanuprakash.modem at intel.com
Wed Sep 6 08:51:35 UTC 2023


For new IGT users, it's helpful to have the ref (in case of
missing documentation) in IGT logs to refer igt documentation
page.

Example log:
 Warning: Missing documentation for igt at kms_color@degamma
 Warning: Missing documentation for igt at kms_flip@basic-plain-flip
 Please refer: docs/test_documentation.md for more details

Cc: Mauro Carvalho Chehab <mchehab at kernel.org>
Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
---
 scripts/test_list.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/scripts/test_list.py b/scripts/test_list.py
index 4cd976c8d..2171f8b50 100644
--- a/scripts/test_list.py
+++ b/scripts/test_list.py
@@ -1027,6 +1027,8 @@ class TestList:
         if run_missing:
             for test_name in run_missing:
                 print(f'Warning: Missing documentation for {test_name}')
+            print(f'Please refer: docs/test_documentation.md for more details')
+
         if doc_uneeded or run_missing:
             sys.exit(1)
 
-- 
2.40.0



More information about the igt-dev mailing list