[PATCH i-g-t v3 2/2] CONTRIBUTING: Add guide about igt libraries

Kamil Konieczny kamil.konieczny at linux.intel.com
Tue Apr 1 15:30:25 UTC 2025


Add some general guide about adding new library function and
a few guides for their usage outside of tests.

Cc: Andrzej Hajda <andrzej.hajda at intel.com>
Cc: Zbigniew Kempczyński <zbigniew.kempczynski at intel.com>
Signed-off-by: Kamil Konieczny <kamil.konieczny at linux.intel.com>
Acked-by: Katarzyna Piecielska <katarzyna.piecielska at intel.com>
---
 CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2927e0ca1..4ffd9a0a4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -38,6 +38,34 @@ The Code
 
 [igt-describe]: https://drm.pages.freedesktop.org/igt-gpu-tools/igt-gpu-tools-Core.html#igt-describe
 
+IGT libraries
+-------------
+- Tests and benchmarks are the main usage of IGT libraries, so they
+  could use test specific macros/functions, for example igt_assert,
+  igt_require, igt_skip, igt_info or igt_debug.
+
+- New library function could be written when it will have at least two
+  different users, for example if it could be used by two or more tests.
+  In some cases single user can be accepted, when it is very likely it
+  will be used in future.
+
+- In a new library function():
+  if it uses some of the macros igt_assert/igt_require/igt_skip then
+  consider to write also __function() with the same functionality but
+  without them.
+
+- Libraries and igt_runner
+  Runner should not use lib functions. It is crucial for CI runs so using
+  libraries puts a risk of bringing changes meant for tests which in turn
+  could break runner.
+  Note: You will find places where igt_runner uses lib functions - this will
+  be on ToDo list to be fixed.
+
+- Libraries and tools/
+  Give some thought if you are planning to use IGT lib code in tools, some
+  IGT lib functions might not be appropriate in tools. For example, any
+  abnormal condition should be simply reported by printf or fprintf to
+  stdout/stderr and then tool should exit gracefully.
 
 Sending Patches
 ---------------
-- 
2.49.0



More information about the igt-dev mailing list