From: Bhanuprakash Modem <bhanuprakash.modem@intel.com>
To: igt-dev@lists.freedesktop.org
Subject: [igt-dev] [i-g-t] scripts/test_list: Add test_documentation ref to the logs
Date: Wed, 6 Sep 2023 14:21:35 +0530 [thread overview]
Message-ID: <20230906085135.1724832-1-bhanuprakash.modem@intel.com> (raw)
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@kms_color@degamma
Warning: Missing documentation for igt@kms_flip@basic-plain-flip
Please refer: docs/test_documentation.md for more details
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem@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
next reply other threads:[~2023-09-06 8:59 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-06 8:51 Bhanuprakash Modem [this message]
2023-09-06 9:15 ` [igt-dev] [i-g-t] scripts/test_list: Add test_documentation ref to the logs Mauro Carvalho Chehab
2023-09-06 10:14 ` [igt-dev] ✓ Fi.CI.BAT: success for " Patchwork
2023-09-06 13:31 ` [igt-dev] ✗ Fi.CI.IGT: failure " Patchwork
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=20230906085135.1724832-1-bhanuprakash.modem@intel.com \
--to=bhanuprakash.modem@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