Re: [igt-dev] [PATCH i-g-t 0/2] IGT XE documentation cleanup

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

On Thu, 31 Aug 2023 14:30:40 +0200
Mauro Carvalho Chehab <mauro.chehab@linux.intel.com> wrote:

> On Thu, 31 Aug 2023 11:39:34 +0000
> Katarzyna Dec <katarzyna.dec@intel.com> wrote:
> 
> > Let's add missing documentation fileds that are causing warnings.
> > Some tests documentation needed changes to have more accurate naming.
> > Let's mark Negative and Stress tests.
> > Adding missing 'Run type' and 'Test category' for remaining test.  
> 
> Kasia,
> 
> Besides the changes, could you please also change the
> sub-category field and/or Functionalities for xe_mmap.c?
> 
> Right now, both are using "mmap" bucket. This is valid for
> the documentation itself, but it causes confusion when analyzing
> the results later on, as there will be two buckets with the same
> name but different meanings.
> 
> Perhaps we could use Sub-category == "VMA".
> 
> What do you think?
> 
> Another issue I noticed in this series is that we have "Blitter"
> with the first letter in uppercase. Perhaps there are more cases like
> that. Please let's use lowercase on such buckets, as this is less
> prone to errors (IMO).

Another thing: I would add this patch at the end of the series:

	https://patchwork.freedesktop.org/series/123111/

This will enforce CI to check for incomplete documentation at
build time, aborting the build (and producing CI errors) if the
documentation is not there.

Regards,
Mauro