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

[Sharma, Swati2]

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/kms_invalid_mode.c | 32 ++++++++++++++++++++++++++++++++
>   1 file changed, 32 insertions(+)
> 
> diff --git a/tests/kms_invalid_mode.c b/tests/kms_invalid_mode.c
> index c26f8befe..f9d953014 100644
> --- a/tests/kms_invalid_mode.c
> +++ b/tests/kms_invalid_mode.c
> @@ -22,10 +22,42 @@
>    *
>    */
>   
> +/**
> + * TEST: kms invalid mode
> + * Category: Display
> + * Description: Make sure all modesets are rejected when the requested mode is
> + *              invalid
> + */
>   #include "igt.h"
>   #include <limits.h>
>   #include <stdbool.h>
>   
> +/**
> + * SUBTEST: %s
> + * Description: Make sure all modesets are rejected when the requested mode is
> + *              invalid
> + * Driver requirement: any
> + * Functionality: kms_core
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * arg[1]:
> + *
> + * @bad-hsync-end:
> + * @bad-hsync-start:
> + * @bad-htotal:
> + * @bad-vsync-end:
> + * @bad-vsync-start:
> + * @bad-vtotal:
> + * @clock-too-high:
> + * @int-max-clock:
> + * @uint-max-clock:
> + * @zero-clock:
> + * @zero-hdisplay:
> + * @zero-vdisplay:
> + */
> +

Do we need to write description of all these subtests?

>   IGT_TEST_DESCRIPTION("Make sure all modesets are rejected when the requested mode is invalid");
>   
>   typedef struct _data data_t;