[PATCH i-g-t] tests/kms: Drop 'Functionality' and 'Test category' from documentation

Piecielska, Katarzyna katarzyna.piecielska at intel.com
Mon Feb 17 08:43:50 UTC 2025



-----Original Message-----
From: Tahvanainen, Jari <jari.tahvanainen at intel.com> 
Sent: Monday, February 17, 2025 9:32 AM
To: Piecielska, Katarzyna <katarzyna.piecielska at intel.com>; Sharma, Swati2 <swati2.sharma at intel.com>; Kamil Konieczny <kamil.konieczny at linux.intel.com>; igt-dev at lists.freedesktop.org
Subject: RE: [PATCH i-g-t] tests/kms: Drop 'Functionality' and 'Test category' from documentation

> -----Original Message-----
> From: Piecielska, Katarzyna <katarzyna.piecielska at intel.com>
> Sent: Friday, February 14, 2025 12:26 PM
> To: Sharma, Swati2 <swati2.sharma at intel.com>; Kamil Konieczny 
> <kamil.konieczny at linux.intel.com>; igt-dev at lists.freedesktop.org; 
> Tahvanainen, Jari <jari.tahvanainen at intel.com>
> Subject: RE: [PATCH i-g-t] tests/kms: Drop 'Functionality' and 'Test category'
> from documentation
> 
> 
> 
> -----Original Message-----
> From: Sharma, Swati2 <swati2.sharma at intel.com>
> Sent: Friday, February 14, 2025 8:37 AM
> To: Kamil Konieczny <kamil.konieczny at linux.intel.com>; igt- 
> dev at lists.freedesktop.org; Tahvanainen, Jari 
> <jari.tahvanainen at intel.com>; Piecielska, Katarzyna 
> <katarzyna.piecielska at intel.com>
> Subject: Re: [PATCH i-g-t] tests/kms: Drop 'Functionality' and 'Test category'
> from documentation
> 
> Hi Kamil
> 
> On 11-02-2025 02:41 pm, Kamil Konieczny wrote:
> > Hi Swati,
> > On 2025-02-10 at 16:26:46 +0530, Swati Sharma wrote:
> >> 'Functionality' solely depends upon developer's interpretation and 
> >> 'Test category' is not used. Let's remove them from the kms tests 
> >> documentation so that documentation can be made precise which is 
> >> easy to maintain.
> >>
> > +cc Jari and Katarzyna
> > Cc: Jari Tahvanainen <jari.tahvanainen at intel.com>
> > Cc: Katarzyna Piecielska <katarzyna.piecielska at intel.com>
> >
> > One more thing is that such change should also update *json for
> > example:
> >
> > grep Functionality tests/intel/*json
> >
> > tests/intel/i915_test_config.json: "Functionality": {
> Change has been done only for KMS documentation.
> > tests/intel/kms_test_config.json:  "Functionality": {
> For KMS, this field is not "mandatory". So, no change required there.
> If needed, I can remove.
> 
> (Kasia) I remember that 'Functionality' field is not needed. Maybe it 
> would be good to remove it from kms json file.
> However, I am not sure if this will not affect building all 
> documentation. Jari - could You look at this proposal?

Ack for the change, still having an opinion that we are losing some granularity that we might would like to have at some point. But I can live with this, and per my understanding documentation and other areas using these documentation tags will not be broken by this change. 
Personally, I would keep Functionality as part of the json for now being optional. If so decided one can clean kms json, and I can live with this too.

Br, Jari

Having Jari's response, let's keep Functionality in json file.

Reviewed-by: Katarzyna Piecielska <katarzyna.piecielska at intel.com>

Kasia

> 
> Kasia
> 
> > tests/intel/xe_test_config.json:   "Functionality": {
> >
> > Regards,
> > Kamil
> >
> >> Signed-off-by: Swati Sharma <swati2.sharma at intel.com>
> >> ---
> >>   tests/chamelium/kms_chamelium_audio.c   |   5 -
> >>   tests/chamelium/kms_chamelium_color.c   |   2 -
> >>   tests/chamelium/kms_chamelium_edid.c    |  11 --
> >>   tests/chamelium/kms_chamelium_frames.c  |  11 --
> >>   tests/chamelium/kms_chamelium_hpd.c     |  26 -----
> >>   tests/fbdev.c                           |   2 -
> >>   tests/intel/i915_pipe_stress.c          |   3 -
> >>   tests/intel/kms_big_fb.c                |  11 --
> >>   tests/intel/kms_busy.c                  |   3 -
> >>   tests/intel/kms_ccs.c                   |   4 -
> >>   tests/intel/kms_cdclk.c                 |   2 -
> >>   tests/intel/kms_dirtyfb.c               |   3 -
> >>   tests/intel/kms_dp_linktrain_fallback.c |   2 -
> >>   tests/intel/kms_draw_crc.c              |   2 -
> >>   tests/intel/kms_dsc.c                   |   2 -
> >>   tests/intel/kms_fb_coherency.c          |   2 -
> >>   tests/intel/kms_fbcon_fbt.c             |   5 -
> >>   tests/intel/kms_fence_pin_leak.c        |   2 -
> >>   tests/intel/kms_flip_scaled_crc.c       |  12 --
> >>   tests/intel/kms_flip_tiling.c           |   2 -
> >>   tests/intel/kms_frontbuffer_tracking.c  | 147 ------------------------
> >>   tests/intel/kms_joiner.c                |   2 -
> >>   tests/intel/kms_legacy_colorkey.c       |   2 -
> >>   tests/intel/kms_mmap_write_crc.c        |   2 -
> >>   tests/intel/kms_pipe_b_c_ivb.c          |   2 -
> >>   tests/intel/kms_pm_backlight.c          |   5 -
> >>   tests/intel/kms_pm_dc.c                 |   8 --
> >>   tests/intel/kms_pm_lpsp.c               |   2 -
> >>   tests/intel/kms_pm_rpm.c                |  15 ---
> >>   tests/intel/kms_psr.c                   |  33 ------
> >>   tests/intel/kms_psr2_sf.c               |  25 ----
> >>   tests/intel/kms_psr_stress_test.c       |   2 -
> >>   tests/intel/kms_pwrite_crc.c            |   2 -
> >>   tests/kms_3d.c                          |   2 -
> >>   tests/kms_addfb_basic.c                 |  17 ---
> >>   tests/kms_async_flips.c                 |   4 -
> >>   tests/kms_atomic.c                      |   4 -
> >>   tests/kms_atomic_interruptible.c        |   6 -
> >>   tests/kms_atomic_transition.c           |   4 -
> >>   tests/kms_bw.c                          |   2 -
> >>   tests/kms_color.c                       |   2 -
> >>   tests/kms_concurrent.c                  |   2 -
> >>   tests/kms_content_protection.c          |   7 --
> >>   tests/kms_cursor_crc.c                  |   5 -
> >>   tests/kms_cursor_edge_walk.c            |   2 -
> >>   tests/kms_cursor_legacy.c               |   2 -
> >>   tests/kms_display_modes.c               |   3 -
> >>   tests/kms_dither.c                      |   2 -
> >>   tests/kms_dp_aux_dev.c                  |   2 -
> >>   tests/kms_feature_discovery.c           |   7 --
> >>   tests/kms_flip.c                        |  14 ---
> >>   tests/kms_flip_event_leak.c             |   2 -
> >>   tests/kms_force_connector_basic.c       |   3 -
> >>   tests/kms_getfb.c                       |   4 -
> >>   tests/kms_hdmi_inject.c                 |   3 -
> >>   tests/kms_hdr.c                         |  10 --
> >>   tests/kms_invalid_mode.c                |   2 -
> >>   tests/kms_lease.c                       |   2 -
> >>   tests/kms_multipipe_modeset.c           |   2 -
> >>   tests/kms_panel_fitting.c               |   2 -
> >>   tests/kms_pipe_crc_basic.c              |   5 -
> >>   tests/kms_plane.c                       |   7 --
> >>   tests/kms_plane_alpha_blend.c           |   2 -
> >>   tests/kms_plane_cursor.c                |   2 -
> >>   tests/kms_plane_lowres.c                |   3 -
> >>   tests/kms_plane_multiple.c              |   3 -
> >>   tests/kms_plane_scaling.c               |   6 -
> >>   tests/kms_prop_blob.c                   |   2 -
> >>   tests/kms_properties.c                  |   2 -
> >>   tests/kms_rotation_crc.c                |   5 -
> >>   tests/kms_scaling_modes.c               |   2 -
> >>   tests/kms_selftest.c                    |   2 -
> >>   tests/kms_sequence.c                    |   2 -
> >>   tests/kms_setmode.c                     |   3 -
> >>   tests/kms_sysfs_edid_timing.c           |   2 -
> >>   tests/kms_tiled_display.c               |   3 -
> >>   tests/kms_tv_load_detect.c              |   2 -
> >>   tests/kms_vblank.c                      |  10 --
> >>   tests/kms_vrr.c                         |   9 --
> >>   tests/kms_writeback.c                   |   2 -
> >>   tests/testdisplay.c                     |   2 -
> >>   81 files changed, 552 deletions(-)
> >>
> > ...cut...
> >



More information about the igt-dev mailing list