Re: [PATCH i-g-t 1/1] tests/intel: Put "Run type" highest in documentation hierarchy

[Mauro Carvalho Chehab <mauro.chehab@linux.intel.com>]

On Wed, 17 Apr 2024 11:13:24 +0000
Katarzyna Piecielska <katarzyna.piecielska@intel.com> wrote:

> Let's put "Run type" at highest place in documentation hierarchy. It
> will be reflected in html generated documentation.

If this works best for validation leaders, it works for me.

You should likely do the same also for KMS and i915, having all
using the same basic hierarchy.

Once you add KMS and i915 patches, feel free to add:
	Acked-by: Mauro Carvalho Chehab <mauro.chehab@linux.intel.com>

To the patch(es).

Regards,
Mauro

> 
> Signed-off-by: Katarzyna Piecielska <katarzyna.piecielska@intel.com>
> Cc: Kamil Konieczny <kamil.konieczny@intel.com>
> Cc: Jari Tahvanainen <jari.tahvanainen@intel.com>
> Cc: Mauro Carvalho Chehab <mauro.chehab@linux.intel.com>
> ---
>  tests/intel/xe_test_config.json | 66 ++++++++++++++++-----------------
>  1 file changed, 33 insertions(+), 33 deletions(-)
> 
> diff --git a/tests/intel/xe_test_config.json b/tests/intel/xe_test_config.json
> index 22b43ffac..f88883414 100644
> --- a/tests/intel/xe_test_config.json
> +++ b/tests/intel/xe_test_config.json
> @@ -4,51 +4,51 @@
>      "drivers": [ "xe" ],
>      "files": [ "xe_*.c", "../core_hotunplug.c", "../sriov_basic.c", "intel_hwmon.c" ],
>      "fields": {
> -        "Category": {
> +        "Run type": {
>              "_properties_": {
>                  "mandatory": true,
> -                "description": "Contains the major group for the tested functionality, being hardware, software or firmware"
> +                "description": "Defines what category of testlist it belongs",
> +                "default-testlist": "FULL",
> +                "update-from-file": {
> +                    "exclude-type": "regex-ignorecase",
> +                    "append-value-if-not-excluded": "Xe FULL",
> +                    "include": [
> +                        { "Xe BAT": "../intel-ci/xe-fast-feedback.testlist" }
> +                    ],
> +                    "exclude": [
> +                        { "Xe BAT, Xe FULL": "../intel-ci/xe.blocklist.txt" }
> +                    ]
> +                },
> +                "order": [
> +                    "boot",
> +                    "__all__",
> +                    "kunit"
> +                ]
>              },
> -            "Mega feature": {
> +            "Category": {
>                  "_properties_": {
> -                    "description": "Contains the mega feature for end to end use case, e. g. the 'sellable' feature."
> +                    "mandatory": true,
> +                    "description": "Contains the major group for the tested functionality, being hardware, software or firmware"
>                  },
> -                "Sub-category": {
> +                "Mega feature": {
>                      "_properties_": {
> -                        "mandatory": true,
> -                        "description": "Contains the the technical feature/functionality"
> +                        "description": "Contains the mega feature for end to end use case, e. g. the 'sellable' feature."
>                      },
> -                    "Functionality": {
> +                    "Sub-category": {
>                          "_properties_": {
>                              "mandatory": true,
> -                            "description": "Groups page table tests on buckets containg more detailed functionality"
> +                            "description": "Contains the technical feature/functionality"
>                          },
> -                        "Feature": {
> +                        "Functionality": {
>                              "_properties_": {
> -                                "description": "Describes the lowest level feature bucket"
> -                            }
> -                        }
> -                    },
> -                    "Run type": {
> -                        "_properties_": {
> -                            "mandatory": true,
> -                            "description": "Defines what category of testlist it belongs",
> -                            "default-testlist": "FULL",
> -                            "update-from-file": {
> -                                "exclude-type": "regex-ignorecase",
> -                                "append-value-if-not-excluded": "Xe FULL",
> -                                "include": [
> -                                    { "Xe BAT": "../intel-ci/xe-fast-feedback.testlist" }
> -                                ],
> -                                "exclude": [
> -                                    { "Xe BAT, Xe FULL": "../intel-ci/xe.blocklist.txt" }
> -                                ]
> +                                "mandatory": true,
> +                                "description": "Groups page table tests on buckets containg more detailed functionality"
>                              },
> -                            "order": [
> -                                "boot",
> -                                "__all__",
> -                                "kunit"
> -                            ]
> +                            "Feature": {
> +                                "_properties_": {
> +                                    "description": "Describes the lowest level feature bucket"
> +                                }
> +                            }
>                          }
>                      }
>                  }