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 v2 00/12] Improve igt_doc.py
Date: Thu, 30 Mar 2023 07:42:09 +0200	[thread overview]
Message-ID: <20230330054221.2640814-1-mauro.chehab@linux.intel.com> (raw)

From: Mauro Carvalho Chehab <mchehab@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.

---
v2:
  - add a patch at the end to avoid a gitlab pipeline breakage.

Mauro Carvalho Chehab (12):
  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@xe_vm@userptr-invalid
  xe/xe_noexec_ping_pong: document subtest
  runner/meson.build: fix minimal build

 docs/testplan/meson.build      |    8 +-
 meson.build                    |    1 +
 runner/meson.build             |    6 +-
 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 +-
 8 files changed, 1144 insertions(+), 1059 deletions(-)
 create mode 100755 scripts/test_list.py

-- 
2.39.2

             reply	other threads:[~2023-03-30  5:42 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-30  5:42 Mauro Carvalho Chehab [this message]
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 01/12] xe_test_config.json: do some adjustments at the output hierarchy Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 02/12] scripts/igt_doc.py: move show_subtests logic to the class Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 03/12] scripts/igt_doc.py: add support to generate testlists Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 04/12] scripts/igt_doc.py: prepare to place TestList class on a separate file Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 05/12] scripts/test_list.py: prepare to place " Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 06/12] scripts/igt_doc.py: re-introduce it by calling test_list.py Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 07/12] scripts/test_list.py: better handle documentation validation issues Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 08/12] scripts/test_list.py: add support for igt_simple_main Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 09/12] testplan/meson.build: Validate documentation at build time Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 10/12] xe/xe_vm: add documentation for igt@xe_vm@userptr-invalid Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 11/12] xe/xe_noexec_ping_pong: document subtest Mauro Carvalho Chehab
2023-03-30  5:42 ` [igt-dev] [PATCH i-g-t v2 12/12] runner/meson.build: fix minimal build Mauro Carvalho Chehab
2023-03-31  9:13   ` Kamil Konieczny
2023-03-31 10:39     ` Mauro Carvalho Chehab
2023-03-31 10:46       ` Mauro Carvalho Chehab
2023-03-31 11:10       ` Kamil Konieczny
2023-03-30  6:25 ` [igt-dev] ✗ GitLab.Pipeline: warning for Improve igt_doc.py (rev2) Patchwork
2023-03-30  6:42 ` [igt-dev] ✓ Fi.CI.BAT: success " Patchwork
2023-03-31  1:46 ` [igt-dev] ✓ Fi.CI.IGT: " 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=20230330054221.2640814-1-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