[igt-dev] [V5 i-g-t 73/81] tests/kms_setmode: Document each subtest for testplan

[Karthik B S]

Hi,

On 6/29/2023 8:19 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/kms_setmode.c | 58 +++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 58 insertions(+)
>
> diff --git a/tests/kms_setmode.c b/tests/kms_setmode.c
> index 035bbd0b0..bce41fc3b 100644
> --- a/tests/kms_setmode.c
> +++ b/tests/kms_setmode.c
> @@ -31,6 +31,64 @@
>   #include <sys/time.h>
>   #include <math.h>
>   #include "xe/xe_query.h"
> +/**
> + * TEST: kms setmode
> + * Category: Display

Description missing?

> + *
> + * SUBTEST: basic
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: basic-clone-single-crtc
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: clone-exclusive-crtc
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: invalid-clone-exclusive-crtc
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: invalid-clone-single-crtc
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: invalid-clone-single-crtc-stealing
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + */

All the subtests are having the same description. Could you please add 
subtest specific details. May be the current description of subtests 
could be the overall test description.

Thanks,
Karthik.B.S
>   
>   #define MAX_CONNECTORS  10
>   #define MAX_CRTCS       6