yelp-tool yelp-build script don't work

[lillolollo]

Description / Steps to reproduce the issue

I'm trying to generate docs for gimp with building it -Dg-ir-doc=true but it don't work

I'm trying to debug it and use these command to generate an html page on a clang environment (not tested on other environments)

yelp-build cache *.page
yelp-build html -o html .

the first problem is the python shebang on bin/yelp-build must be #!/usr/bin/env python or the file it is not found

the second problem seem to be the path

XSL_MAL2HTML = '/clang64/share/yelp-xsl/xslt/mallard/html/mal2html.xsl'

the third the file to be converted is not found but it is on the same folder

I don't know if @JPeterMugaas is still around to take a look

Expected behavior

the file is converted

Actual behavior

the file it is not converted

Verification

• I have verified that my MSYS2 is up-to-date before submitting the report (see https://www.msys2.org/docs/updating/)

Windows Version

MINGW64_NT-10.0-22631

MINGW environments affected

• MINGW64
• MINGW32
• UCRT64
• CLANG64
• CLANGARM64

Are you willing to submit a PR?

No response

[Biswa96]

Thank you for reporting the issue. I can reproduce it in my system with current gimp 3 rc version. I have tried to replace the /ucrt64/share strings in yelp-build using .replace('/ucrt64/share', sysconfig.get_config_var('datarootdir')) but it causes the following error.

xsl:import : invalid URI reference file://C:/msys64/ucrt64/share/yelp-xsl/xslt/mallard/html/mal2html.xsl

[lillolollo]

@Biswa96 yes seem the path passed to xsl it's not well formatted the same with the .page file path

[lillolollo]

@Biswa96 I have made progress replacing this on yelp-buid file line 402

page += ' cache:href="file://' + urllib.parse.quote(os.path.realpath(infile.absfile)) + '"'

with

page += ' cache:href="file:///' + urllib.parse.quote(os.path.realpath(infile.absfile)) + '"'

Now I have this error

file:///C%3A/msys64/home/lillolollo/gimp_master/share/docs/Gimp.Procedure.add_menu_path.page:61: parser error : Opening and ending tag mismatch: p line 39 and page

^
compilation error: file C:/msys64/tmp/tmpw7ynrk7c/mal2html.xsl line 11 element import
xsl:import : invalid URI reference file://C:/msys64/clang64/share/yelp-xsl/xslt/mallard/html/mal2html.xsl

[revelator]

looks a bit like the same error that plagued docbook for some time in mingw the xslt processor cannot handle the format on windows. passing an absolute path without file:: seems to do the trick for docbook but if it can be used here i dont know.

the mingw docbook format looks like this for rewriteprefix -> rewritePrefix="../../share/xml/docbook/xml-dtd-4.4"
and this for msys2 -> rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.4"

maybe able to spur some ideas on what is needed ?.

[lillolollo]

So i made it work changing yelp-build file

changing the shebang like this

#!/usr/bin/env python3

changing the path here from

XSL_DB2HTML = '/clang64/share/yelp-xsl/xslt/docbook/html/db2html.xsl' XSL_DB2XHTML = '/clang64/share/yelp-xsl/xslt/docbook/html/db2xhtml.xsl' XSL_MALCACHE = '/clang64/share/yelp-xsl/xslt/mallard/cache/mal-cache.xsl' XSL_MAL2HTML = '/clang64/share/yelp-xsl/xslt/mallard/html/mal2html.xsl' XSL_MAL2XHTML = '/clang64/share/yelp-xsl/xslt/mallard/html/mal2xhtml.xsl' XSL_MAL_OPF='/clang64/share/yelp-tools/xslt/mal-opf.xsl' XSL_MAL_NCX='/clang64/share/yelp-tools/xslt/mal-ncx.xsl' YELP_JS_DIR = '/clang64/share/yelp-xsl/js'

to

XSL_DB2HTML = 'C:/msys64/clang64/share/yelp-xsl/xslt/docbook/html/db2html.xsl' XSL_DB2XHTML = 'C:/msys64/clang64/share/yelp-xsl/xslt/docbook/html/db2xhtml.xsl' XSL_MALCACHE = 'C:/msys64/clang64/share/yelp-xsl/xslt/mallard/cache/mal-cache.xsl' XSL_MAL2HTML = 'C:/msys64/clang64/share/yelp-xsl/xslt/mallard/html/mal2html.xsl' XSL_MAL2XHTML = 'C:/msys64/clang64/share/yelp-xsl/xslt/mallard/html/mal2xhtml.xsl' XSL_MAL_OPF='C:/msys64/clang64/share/yelp-tools/xslt/mal-opf.xsl' XSL_MAL_NCX='C:/msys64/clang64/share/yelp-tools/xslt/mal-ncx.xsl' YELP_JS_DIR = 'C:/msys64/clang64/share/yelp-xsl/js'

replacing all the href="file:// with href="file:///

[Biswa96]

Do the created documentation files contain full path of msys2 installation directory? If true that would cause issue when msys2 install directory changes.

[revelator]

yeah that would suck... maybe change it to this format would help ?

XSL_DB2HTML = '../share/yelp-xsl/xslt/docbook/html/db2html.xsl'

[revelator]

just tested changing all the /mingw*/ paths to ../ so that it points to the local data and it works here.
what im not sure about is changing it in the yelp tools source code ?.'

[lillolollo]

So gimp removed the g-ir-doc build so yelp-tool is no needed anymore , but the issue on yelp-tool is still here