[PATCH i-g-t v6 12/17] scripts/igt_doc: Add '--exclude-files' parameter

[Kamil Konieczny]

Hi Manszewski,,
On 2024-09-13 at 15:24:13 +0200, Manszewski, Christoph wrote:
> Hi all,
> 
> On 9.09.2024 15:57, Zbigniew Kempczyński wrote:
> > On Mon, Sep 09, 2024 at 01:31:25PM +0200, Kamil Konieczny wrote:
> > > Hi Christoph,
> > > On 2024-09-05 at 11:28:07 +0200, Christoph Manszewski wrote:
> > > > Currently the doc scripts relies on a static list of files passed
> > > > through the respective '<config>.json' file for generating
> > > > documentation. This results in a compilation error when we exclude some
> > > > tests from building since the doc script notices documentation generated
> > > > for missing binaries.
> > > > 
> > > > Make it possible to dynamically exclude files from doc generation using
> > > > '--exclude-files' parameter. Merge excluded files passed with that parameter
> > > > with files excluded from the test config '.json' files. Align the behavior
> > > > of the '--files' parameter to also merge with files included from the config.
> > > 
> > > Could we get rid of this option and instead check if there was
> > > a binary file generated for a given C source file?
> > > As I understand it, we could skip C source checks if there are
> > > no binary generated.

Now I see I did something opposite, as Christoph wrote below.

> > 
> > I like this idea, I'll ask Christoph for drop exclude-files option and
> > check corresponding .c files only if binary exists.
> 
> I already replied to Kamil's patch and will include it in this series
> instead of this one. Note however that this results in generating
> documentation for tests that weren't included in the build. I was
> specifically trying to avoid that but since Kamil suggests a change like
> this I guess it's fine.
> 
> Thanks,
> Christoph

We could ask Jari or Katarzyna if that is ok, imho it is - we started to develop
those tests so it should be ok to have them in documentation.

Regards,
Kamil

> > 
> > --
> > Zbigniew
> > 
> > > 
> > > Or are there any other constrains like tests planned?
> > > 
> > > Adding Jari and Katarczyna on Cc.
> > > 
> > > Cc: Jari Tahvanainen <jari.tahvanainen at intel.com>
> > > Cc: Katarzyna Piecielska <katarzyna.piecielska at intel.com>
> > > 
> > > Regards,
> > > Kamil
> > > 
> > > > 
> > > > Signed-off-by: Christoph Manszewski <christoph.manszewski at intel.com>
> > > > Reviewed-by: Zbigniew Kempczyński <zbigniew.kempczynski at intel.com>
> > > > ---
> > > >   scripts/igt_doc.py   |  3 +++
> > > >   scripts/test_list.py | 47 +++++++++++++++++++++++++-------------------
> > > >   2 files changed, 30 insertions(+), 20 deletions(-)
> > > > 
[...cut...]