[igt-dev] [PATCH i-g-t] docs/reference: add links to testplan-based documentation

[Modem, Bhanuprakash]

Hi Mauro,

On Thu-17-08-2023 03:05 pm, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab at kernel.org>
> 
> Instead of relying on runtime-based docs, use the documentation
> parsed via testplan for i915, Xe and KMS tests.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab at kernel.org>
> ---
>   .../igt-gpu-tools/igt_test_programs.xml       | 63 ++++++++-----------
>   docs/reference/igt-gpu-tools/meson.build      |  4 --
>   2 files changed, 27 insertions(+), 40 deletions(-)
> 
> diff --git a/docs/reference/igt-gpu-tools/igt_test_programs.xml b/docs/reference/igt-gpu-tools/igt_test_programs.xml
> index 92bc33ba83f6..51f8cac05f98 100644
> --- a/docs/reference/igt-gpu-tools/igt_test_programs.xml
> +++ b/docs/reference/igt-gpu-tools/igt_test_programs.xml
> @@ -147,42 +147,6 @@
>       <xi:include href="igt_test_programs_gem_description.xml"/>
>     </refentry>
>   
> -  <refentry id="igt-gen3-tests">
> -    <refnamediv>
> -      <refname>Gen 3 Tests</refname>
> -      <refpurpose>Tests specific to gen 3</refpurpose>
> -    </refnamediv>
> -    <xi:include href="igt_test_programs_gen3_programs.xml"/>
> -    <xi:include href="igt_test_programs_gen3_description.xml"/>
> -  </refentry>
> -
> -  <refentry id="igt-gen7-tests">
> -    <refnamediv>
> -      <refname>Gen 7 Tests</refname>
> -      <refpurpose>Tests specific to gen 7</refpurpose>
> -    </refnamediv>
> -    <xi:include href="igt_test_programs_gen7_programs.xml"/>
> -    <xi:include href="igt_test_programs_gen7_description.xml"/>
> -  </refentry>
> -
> -  <refentry id="igt-i915-tests">
> -    <refnamediv>
> -      <refname>i915 Tests</refname>
> -      <refpurpose>Tests for overall i915 driver behaviour</refpurpose>
> -    </refnamediv>
> -    <xi:include href="igt_test_programs_i915_programs.xml"/>
> -    <xi:include href="igt_test_programs_i915_description.xml"/>
> -  </refentry>
> -
> -  <refentry id="igt-kms-tests">
> -    <refnamediv>
> -      <refname>KMS Tests</refname>
> -      <refpurpose>Tests for kernel mode setting</refpurpose>
> -    </refnamediv>
> -    <xi:include href="igt_test_programs_kms_programs.xml"/>
> -    <xi:include href="igt_test_programs_kms_description.xml"/>
> -  </refentry>
> -
>     <refentry id="igt-meta-tests">
>       <refnamediv>
>         <refname>Meta Tests</refname>
> @@ -255,6 +219,33 @@
>       <xi:include href="igt_test_programs_vgem_description.xml"/>
>     </refentry>
>   
> +  <refentry id="igt-xe-tests">
> +    <refnamediv>
> +      <refname>
> +          <ulink url="../testplan/xe_tests.html" type="http">Xe Tests</ulink>

As the testplan is not inside the reference dir, the URL must be: 
"../../../testplan/xe_tests.html"

Also, is there anyway to put these urls in index.html, instead of 
opening igt-xe-tests.html and from there open the actual xe_tests.html?

> +      </refname>
> +      <refpurpose>Tests for the Intel Xe driver</refpurpose>
> +    </refnamediv>
> +  </refentry>
> +
> +  <refentry id="igt-i915-tests">
> +    <refnamediv>
> +      <refname>
> +        <ulink url="../testplan/i915_tests.html" type="http">i915 Tests</ulink>
> +      </refname>
> +      <refpurpose>Tests for the Intel i915 driver</refpurpose>
> +    </refnamediv>
> +  </refentry>
> +
> +  <refentry id="igt-kms-tests">
> +    <refnamediv>
> +      <refname>
> +        <ulink url="../testplan/kms_tests.html" type="http">KMS Tests</ulink>
> +      </refname>
> +      <refpurpose>Tests for kernel mode setting</refpurpose>
> +    </refnamediv>
> +  </refentry>
> +
>     <glossary>
>       <title>Glossary</title>
>   
> diff --git a/docs/reference/igt-gpu-tools/meson.build b/docs/reference/igt-gpu-tools/meson.build
> index 6b832ad279cf..9bb5ca7e0798 100644
> --- a/docs/reference/igt-gpu-tools/meson.build
> +++ b/docs/reference/igt-gpu-tools/meson.build
> @@ -29,10 +29,6 @@ test_groups = [
>   	'debugfs',
>   	'drm',
>   	'gem',
> -	'gen3',
> -	'gen7',
> -	'i915',
> -	'kms',

Also, we must drop testdisplay, since it is already covered by kms tests.

- Bhanu

>   	'meta',
>   	'perf',
>   	'pm',