[igt-dev] [PATCH i-g-t] meson: Disable testplan build by default

[Ville Syrjälä]

On Wed, Apr 12, 2023 at 09:26:29AM +0200, Mauro Carvalho Chehab wrote:
> On Tue, 11 Apr 2023 14:02:05 +0300
> Ville Syrjala <ville.syrjala at linux.intel.com> wrote:
> 
> > From: Ville Syrjälä <ville.syrjala at linux.intel.com>
> 
> > No real idea what this "testplan" is and why it lives
> > in igt. Seems to be build some xe documentation, and based
> > on the name is maybe some manager level stuff? Surely
> > this is nothing that matters for normal people (esp. those
> > outside Intel).
> 
> No. Basically, testplan contains documentation for the tests.
> Currently, it contains 100% of the documentation from Xe tests.
> We may end implementing it for i915 as well.
> 
> There is even a plan to generate testlists like xe-fast-feedback.testlist
> directly from documentation. So, it is important to have the tests properly
> documented, as otherwise they won't be executed by CI in the future.
> 
> > 
> > The main problem here being that it is hideously slow to
> > build, making life miserable for everyone. Flip the
> > default to disabled and let those that need this enable
> > it themselves.
> 
> Generating documents takes ~150ms. What makes it slow is not the doc
> generation itself, but a validation logic that checks if the test 
> documentation was updated as tests got added/renamed/removed. 
> It currently uses igt_runner, pointing to the documented tests. 
> As right now just Xe tests uses it, it will call the runner with:
> 
> 	$ igt_runner -L -t igt at xe ${builddir}/tests

That is not the slow thing. The slow thing is some python stuff.

> 
> Perhaps the best strategy would be to re-implement the logic there to
> not use igt_runner, executing
> 
> 	 ${builddir}/tests/xe_* --list
> 
> directly, and in parallel. I'll work on a patch like that.
> 
> Anyway, all developers touching documented tests should run (and so CI),
> as we don't want to have undocumented tests on IGT.
> 
> So,
> 
> NACK.
> 
> Regards,
> Mauro
> 
> > 
> > On my HSW:
> > $ touch tests/kms_color.c # any random file
> > $ time ninja -Cbuild
> > - real  0m22,202s
> > - user  0m20,640s
> > - sys   0m1,570s
> > + real  0m0,241s
> > + user  0m0,214s
> > + sys   0m0,031s
> > 
> > Cc: Kamil Konieczny <kamil.konieczny at linux.intel.com>
> > Cc: Mauro Carvalho Chehab <mchehab at kernel.org>
> > Signed-off-by: Ville Syrjälä <ville.syrjala at linux.intel.com>
> > ---
> >  meson_options.txt | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/meson_options.txt b/meson_options.txt
> > index d4e373d6cfc4..0ea1383a4fe8 100644
> > --- a/meson_options.txt
> > +++ b/meson_options.txt
> > @@ -22,6 +22,7 @@ option('man',
> >  
> >  option('testplan',
> >         type : 'feature',
> > +       value : 'disabled',
> >         description : 'Build testplan documentation pages in ReST and html')
> >  
> >  option('sphinx',

-- 
Ville Syrjälä
Intel