[igt-dev] [PATCH i-g-t 00/11] Improve igt_doc.py

Mauro Carvalho Chehab mauro.chehab at linux.intel.com
Mon Mar 27 13:31:44 UTC 2023


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

This series do some improvements at the igt_doc.py tool:

- It does some tweaks at the Xe documentation hierarchy;
- It adds support to generate test lists from documentation;
- It splits the script on two parts: one with the TestList
  class definition and another one with the toll itself;
- While here, add missing documentation for two new tests;
- Check if the documentation matches the actual tests at
  build time, in order to prevent it to become outdated.

Mauro Carvalho Chehab (11):
  xe_test_config.json: do some adjustments at the output hierarchy
  scripts/igt_doc.py: move show_subtests logic to the class
  scripts/igt_doc.py: add support to generate testlists
  scripts/igt_doc.py: prepare to place TestList class on a separate file
  scripts/test_list.py: prepare to place class on a separate file
  scripts/igt_doc.py: re-introduce it by calling test_list.py
  scripts/test_list.py: better handle documentation validation issues
  scripts/test_list.py: add support for igt_simple_main
  testplan/meson.build: Validate documentation at build time
  xe/xe_vm: add documentation for igt at xe_vm@userptr-invalid
  xe/xe_noexec_ping_pong: document subtest

 docs/testplan/meson.build      |    8 +-
 meson.build                    |    1 +
 scripts/igt_doc.py             | 1038 +-----------------------------
 scripts/test_list.py           | 1084 ++++++++++++++++++++++++++++++++
 tests/xe/xe_noexec_ping_pong.c |   26 +-
 tests/xe/xe_test_config.json   |   30 +-
 tests/xe/xe_vm.c               |   10 +-
 7 files changed, 1143 insertions(+), 1054 deletions(-)
 create mode 100755 scripts/test_list.py

-- 
2.39.2



More information about the igt-dev mailing list