[igt-dev] [V5 i-g-t 23/81] tests/i915/kms_legacy_colorkey: Document each subtest for testplan

[Sharma, Swati2]

On 10-Aug-23 11:35 PM, Modem, Bhanuprakash wrote:
> Hi Swati,
> 
> On Wed-09-08-2023 05:22 pm, Sharma, Swati2 wrote:
>> On 29-Jun-23 8:18 PM, Bhanuprakash Modem wrote:
>>> Add documentation for all kms tests which is used by IGT testplan
>>> documentation.
>>>
>>> Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
>>> ---
>>>   tests/i915/kms_legacy_colorkey.c | 21 +++++++++++++++++++++
>>>   1 file changed, 21 insertions(+)
>>>
>>> diff --git a/tests/i915/kms_legacy_colorkey.c 
>>> b/tests/i915/kms_legacy_colorkey.c
>>> index 450cb2e3f..fb1952113 100644
>>> --- a/tests/i915/kms_legacy_colorkey.c
>>> +++ b/tests/i915/kms_legacy_colorkey.c
>>> @@ -24,6 +24,27 @@
>>>   #include "igt.h"
>>>   #include <errno.h>
>>> +/**
>>> + * TEST: kms legacy colorkey
>>> + * Category: Display
>>> + * Description: Check that the legacy set colorkey ioctl only works 
>>> on sprite planes.
>>> + *
>>> + * SUBTEST: basic
>>> + * Description: Test to check the legacy set colorkey ioctl only 
>>> works for sprite planes.
>>
>> Test description and subtest description is same.
> 
> This is simply adopted from igt_describe(), please feel free to fix that.
> 
> - Bhanu

Hi Bhanu,
I don't agree. If efforts are done to improve documentation. It should 
be done here. In the end, once this activity is done, igt_describe() and
IGT_DESC() will be removed.

> 
>>
>>> + * Driver requirement: i915
>>> + * Functionality: xorg_xv
>>> + * Mega feature: General Display Features
>>> + * Run type: FULL
>>> + * Test category: functionality test
>>> + *
>>> + * SUBTEST: invalid-plane
>>> + * Description: Check invalid plane id's, zero and outrange
>>> + * Driver requirement: i915
>>> + * Functionality: xorg_xv
>>> + * Mega feature: General Display Features
>>> + * Run type: FULL
>>> + * Test category: functionality test
>>> + */
>>>   IGT_TEST_DESCRIPTION("Check that the legacy set colorkey ioctl only 
>>> works on sprite planes.");