[igt-dev] [PATCH i-g-t 11/11] xe/xe_noexec_ping_pong: document subtest

[Kamil Konieczny]

On 2023-03-27 at 15:31:55 +0200, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab at kernel.org>
> 
> Use the SUBTEST tag to add the subtest's description to the
> IGT test plan documentation.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab at kernel.org>

Reviewed-by: Kamil Konieczny <kamil.konieczny at linux.intel.com>

> ---
>  tests/xe/xe_noexec_ping_pong.c | 26 ++++++++++++++------------
>  1 file changed, 14 insertions(+), 12 deletions(-)
> 
> diff --git a/tests/xe/xe_noexec_ping_pong.c b/tests/xe/xe_noexec_ping_pong.c
> index dc14f8cf3f2d..367671883a28 100644
> --- a/tests/xe/xe_noexec_ping_pong.c
> +++ b/tests/xe/xe_noexec_ping_pong.c
> @@ -20,20 +20,22 @@
>   * Category: Software building block
>   * Sub-category: compute
>   * Test category: functionality test
> - */
> -
> -/*
> - * This test creates compute vms, binds a couple of bos and an engine each,
> - * thus redying it for execution. However, VRAM memory is over-
> - * committed and while there is still nothing to execute, an eviction
> - * will trigger the VM's rebind worker to rebind the evicted bo, which
> - * will in turn trigger another eviction and so on.
>   *
> - * Since we don't have eviction stats yet we need to watch "top" for
> - * the rebind kworkers using a lot of CPU while the test idles.
> + * SUBTEST:
> + * Description:
> + *	This test creates compute vms, binds a couple of bos and an engine each,
> + *	thus redying it for execution. However, VRAM memory is over-
> + *	committed and while there is still nothing to execute, an eviction
> + *	will trigger the VM's rebind worker to rebind the evicted bo, which
> + *	will in turn trigger another eviction and so on.
> + *
> + *	Since we don't have eviction stats yet we need to watch "top" for
> + *	the rebind kworkers using a lot of CPU while the test idles.
>   *
> - * The correct driver behaviour should be not to rebind anything unless
> - * there is worked queued on one of the VM's compute engines.
> + *	The correct driver behaviour should be not to rebind anything unless
> + *	there is worked queued on one of the VM's compute engines.
> + * Run type: FULL
> + * TODO: change ``'Run type' == FULL`` to a better category
>   */
>  static void test_ping_pong(int fd, struct drm_xe_engine_class_instance *eci)
>  {
> -- 
> 2.39.2
>