[igt-dev] [PATCH i-g-t 1/1] intel/xe_media_fill.c: address a documentation warning
Kamil Konieczny
kamil.konieczny at linux.intel.com
Wed Dec 6 13:05:15 UTC 2023
Hi Mauro,
On 2023-12-06 at 11:51:30 +0100, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab at kernel.org>
>
One small nit, please add 'tests/' before test name in subject,
also remove ".c", so it will be:
[PATCH i-g-t 1/1] tests/intel/xe_media_fill: address a doc warning
Regards,
Kamil
> Currently, this warning is happening when building IGT:
> Warning: igt at xe_media_fill@media-fill Description documentation is missing
>
> The documentation is there, but not for the subtests. Address it
> by moving it to the right place while adding a description for the
> test, as other subtests could be added there in the future.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab at kernel.org>
> ---
> tests/intel/xe_media_fill.c | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/tests/intel/xe_media_fill.c b/tests/intel/xe_media_fill.c
> index 6b8494537038..ddda1b535ba0 100644
> --- a/tests/intel/xe_media_fill.c
> +++ b/tests/intel/xe_media_fill.c
> @@ -30,12 +30,13 @@
> * Category: Hardware building block
> * Sub-category: Media
> * Functionality: fill surface with media block
> - * Description: Basic test for the media_fill() function,
> - * a very simple workload for the Media pipeline.
> + * Description: Basic tests for the media_fill() function.
> * Feature: media
> * Test category: functionality test
> *
> * SUBTEST: media-fill
> + * Description: Basic test for the media_fill() function,
> + * a very simple workload for the Media pipeline.
> */
>
> IGT_TEST_DESCRIPTION("Basic test for the media_fill() function, a very simple"
> --
> 2.43.0
>
More information about the igt-dev
mailing list