[igt-dev] [PATCH i-g-t 5/5] docs: Embed subtest descriptions in the documentation

Arkadiusz Hiler arkadiusz.hiler at intel.com
Thu Jun 20 11:16:35 UTC 2019


On Thu, Jun 20, 2019 at 02:05:34PM +0300, Ser, Simon wrote:
> On Thu, 2019-06-20 at 13:52 +0300, Arkadiusz Hiler wrote:
> > On Thu, Jun 20, 2019 at 11:20:18AM +0300, Petri Latvala wrote:
> > > On Mon, Jun 17, 2019 at 01:54:43PM +0300, Arkadiusz Hiler wrote:
> > > > This rewrites generate_description_xml in Python, so that we generate
> > > > properly escaped XML. The switch also makes the code more manageable.
> > > > 
> > > > Changes in the generated docbook:
> > > > 
> > > > 1. subtests are not simply listed anymore, they are now another (sub)section
> > > > 
> > > > 2. subtests are now linkable,
> > > >    e.g. docs/igt-kms-tests.html#kms_hdmi_inject at inject-4k
> > > > 
> > > > 3. subtest's section now includes output of --describe
> > > > 
> > > > Python is required already by gtk-doc and we are not using anything
> > > > other than the standard library.
> > > 
> > > Python yes, but what about python3? My Debian installation is ancient
> > > even on Debian standards and gtk-doc-tools depends on python2. I'm too
> > > lazy to check if the version used by gitlab-CI depends on python3, so
> > > asking instead: Do you have a fork in gitlab for this? :P
> > 
> > It works on Fedora:
> > 
> > % head -n 1 $(which gtkdoc-mkhtml)
> > #!/usr/bin/python3
> 
> I believe `#!/usr/bin/env python3` is more correct.

Tell that to the gtkdoc (or package) maintainers :-)

-- 
Cheers,
Arek


More information about the igt-dev mailing list