From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.100]) by gabe.freedesktop.org (Postfix) with ESMTPS id F074610E301 for ; Tue, 29 Aug 2023 11:51:36 +0000 (UTC) Date: Tue, 29 Aug 2023 13:51:32 +0200 From: Mauro Carvalho Chehab To: "Modem, Bhanuprakash" Message-ID: <20230829135132.6355bf8f@maurocar-mobl2> In-Reply-To: References: <20230817093504.75749-1-mauro.chehab@linux.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [igt-dev] [PATCH i-g-t] docs/reference: add links to testplan-based documentation List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: igt-dev@lists.freedesktop.org Errors-To: igt-dev-bounces@lists.freedesktop.org Sender: "igt-dev" List-ID: On Thu, 17 Aug 2023 23:08:24 +0530 "Modem, Bhanuprakash" wrote: > Hi Mauro, >=20 > On Thu-17-08-2023 03:05 pm, Mauro Carvalho Chehab wrote: > > From: Mauro Carvalho Chehab > >=20 > > Instead of relying on runtime-based docs, use the documentation > > parsed via testplan for i915, Xe and KMS tests. > >=20 > > Signed-off-by: Mauro Carvalho Chehab > > --- > > .../igt-gpu-tools/igt_test_programs.xml | 63 ++++++++----------- > > docs/reference/igt-gpu-tools/meson.build | 4 -- > > 2 files changed, 27 insertions(+), 40 deletions(-) > >=20 > > 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 @@ > > > > > > =20 > > - > > - > > - Gen 3 Tests > > - Tests specific to gen 3 > > - > > - > > - > > - > > - > > - > > - > > - Gen 7 Tests > > - Tests specific to gen 7 > > - > > - > > - > > - > > - > > - > > - > > - i915 Tests > > - Tests for overall i915 driver behaviour > > - > > - > > - > > - > > - > > - > > - > > - KMS Tests > > - Tests for kernel mode setting > > - > > - > > - > > - > > - > > > > > > Meta Tests > > @@ -255,6 +219,33 @@ > > > > > > =20 > > + > > + > > + > > + Xe Te= sts =20 >=20 > As the testplan is not inside the reference dir, the URL must be:=20 > "../../../testplan/xe_tests.html" The reference URL assumes the location where the docs will be installed. So, if we have them installed under a "install_dir": $ meson --prefix `pwd`/install_dir build -Dxe_driver=3Denabled --reconfig= ure We have: $ tree -d install_dir/share/gtk-doc/ install_dir/share/gtk-doc/ =E2=94=94=E2=94=80=E2=94=80 html =E2=94=9C=E2=94=80=E2=94=80 igt-gpu-tools =E2=94=94=E2=94=80=E2=94=80 testplan So, "../testplan" is the path to go from "html/igt-gpu-tools" to the location where xe_tests.html is located. > Also, is there anyway to put these urls in index.html, instead of=20 > opening igt-xe-tests.html and from there open the actual xe_tests.html? With the current way this is generated, I'm not sure. I found it hard to find a proper documentation about gtk-doc fields. Currently, IGT relies on it to generate the index.html file. Also meson integration (or gtk-doc) removes all files from the target directory when building docs (html/igt-gpu-tools).=20 One possible alternative would be to have a master index.html file under install_dir/share/gtk-doc/html (or under some other place). I avoided doing that (or some other doc reorg) as this could break any scripts copying the documentation to some place. > > + > > + Tests for the Intel Xe driver > > + > > + > > + > > + > > + > > + > > + i915 = Tests > > + > > + Tests for the Intel i915 driver > > + > > + > > + > > + > > + > > + > > + KMS Te= sts > > + > > + Tests for kernel mode setting > > + > > + > > + > > > > Glossary > > =20 > > 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 =3D [ > > 'debugfs', > > 'drm', > > 'gem', > > - 'gen3', > > - 'gen7', > > - 'i915', > > - 'kms', =20 >=20 > Also, we must drop testdisplay, since it is already covered by kms tests. OK, I'll remove it too. Btw, there are other places generating broken links, so I suspect that several of those "test_groups" aren't needed anymore.=20 >=20 > - Bhanu >=20 > > 'meta', > > 'perf', > > 'pm', =20