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

[Modem, Bhanuprakash]

Hi Karthik,

On Wed-09-08-2023 02:50 pm, Karthik B S wrote:
> Hi,
> 
> On 6/29/2023 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_fence_pin_leak.c | 13 +++++++++++++
>>   1 file changed, 13 insertions(+)
>>
>> diff --git a/tests/i915/kms_fence_pin_leak.c 
>> b/tests/i915/kms_fence_pin_leak.c
>> index 3d63acfef..0321aa3cb 100644
>> --- a/tests/i915/kms_fence_pin_leak.c
>> +++ b/tests/i915/kms_fence_pin_leak.c
>> @@ -30,6 +30,19 @@
>>   #include "i915/gem.h"
>>   #include "igt.h"
>> +/**
>> + * TEST: kms fence pin leak
>> + * Category: Display
>> + * Description: Exercises full ppgtt fence pin_count leak in the kernel.
> 
> This test actually has no subtest defined. Do we need duplicate 
> definitions in this case?

Purpose of these two descriptions are different (One is for overall test 
& another is for each subtest).

Please try to check using these two methods, you can understand:

./scripts/igt_doc.py --config=tests/kms_test_config.json 
--filter-field=Functionality=~'kms_core, synchronization'

./scripts/igt_doc.py --config=tests/kms_test_config.json 
--filter-field=Functionality=~'kms_core, synchronization' --per-test

- Bhanu

> 
> Thanks,
> Karthik.B.S
> 
>> + *
>> + * SUBTEST:
>> + * Description: Exercises full ppgtt fence pin_count leak in the kernel.
>> + * Driver requirement: i915
>> + * Functionality: kms_core, synchronization
>> + * Mega feature: General Display Features
>> + * Run type: FULL
>> + * Test category: functionality test
>> + */
>>   IGT_TEST_DESCRIPTION("Exercises full ppgtt fence pin_count leak in 
>> the "
>>                "kernel.");