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

[Karthik B S]

Hi,

On 8/12/2023 12:16 AM, Bhanuprakash Modem wrote:
> Add documentation for all kms tests which is used by IGT testplan
> documentation.
>
> V2: - Fix test description
>
> Cc: Karthik B S <karthik.b.s at intel.com>
> Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
> ---
>   tests/kms_setmode.c | 60 +++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 60 insertions(+)
>
> diff --git a/tests/kms_setmode.c b/tests/kms_setmode.c
> index 035bbd0b0..19bda6b26 100644
> --- a/tests/kms_setmode.c
> +++ b/tests/kms_setmode.c
> @@ -31,6 +31,66 @@
>   #include <sys/time.h>
>   #include <math.h>
>   #include "xe/xe_query.h"
> +/**
> + * TEST: kms setmode
> + * Category: Display
> + * Description: Tests the mode by iterating through all valid/invalid crtc/connector
> + *              combinations
> + *
> + * SUBTEST: basic
> + * Description: Tests the vblank timing by iterating through all valid crtc/connector
> + *              combinations
> + * Driver requirement: any
> + * Functionality: kms_core, vblank
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: basic-clone-single-crtc
> + * Description: Tests the mode by cloning the single crtc by iterating through all
> + *              valid crtc/connector combinations

The descriptions seem confusing to me at least.

@Jeevan: Please provide your inputs on these as you're looking into 
these subtests.

Thanks,
Karthik.B.S
> + * 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 cloning the single exclusive crtc by iterating
> + *              through all valid 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 cloning the single exclusive crtc by iterating
> + *              through all 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 cloning the single crtc by iterating through all
> + *              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 stealing mode by cloning the single crtc by iterating
> + *              through all invalid crtc/connector combinations
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + */
>   
>   #define MAX_CONNECTORS  10
>   #define MAX_CRTCS       6