Bug 429799

Summary: kdoctools build if using zsh, antigen and zsh-autosuggestions
Product: [Frameworks and Libraries] frameworks-kdoctools Reporter: Srevin Saju <srevinsaju>
Component: generalAssignee: Documentation Editorial Team <kde-doc-english>
Status: REPORTED ---    
Severity: minor CC: kdelibs-bugs, luigi.toscano
Priority: NOR    
Version: 5.76.0   
Target Milestone: ---   
Platform: Compiled Sources   
OS: Linux   
Latest Commit: Version Fixed In:
Sentry Crash Report:

Description Srevin Saju 2020-11-29 10:26:53 UTC
SUMMARY
kdoctools fails to build on systems who use 
(i) zsh, 
(ii) antigen and 
(iii) zsh-autosuggestions
due to a regression in the DocBookXSL finding algorithm used by cmake

Possibly related to #373896

STEPS TO REPRODUCE
1. Install antigen, make sure you have zsh-autosuggestions on PATH
2. run `kdesrc-build kdoctools`
3. Look at cmake.log and build.log

OBSERVED RESULT
The build fails, as it tries to search for the folder manpages in ~/.antigen
which is where its not supposed to look for DocBookXSL. Possibility is that
there is a VERSION file in ~/.antigen/bundles/zsh-users/zsh-autosuggestions/ which makes cmake think that it _is_ the DocBookXSL directory; The build subsequently fails

EXPECTED RESULT
The build should complete successfully


SOFTWARE/OS VERSIONS
Windows: 
macOS: 
Linux/KDE Plasma: Arch Linux / 5.20.3
(available in About System)
KDE Plasma Version: 5.20.3
KDE Frameworks Version: 5.76.0
Qt Version: 5.15.2
kdoctools @ 8609659ba44e49af8b53f6d4bd6de06c002ee477

ADDITIONAL INFORMATION
Comment 1 Luigi Toscano 2020-11-29 18:08:53 UTC
The FindDocBookXSL.cmake code tries first to look into several paths for lib/lib.xsl, and then it tries to find it VERSION is another set of paths which are build by items of CMAKE_SYSTEM_PREFIX_PATH and  share/xml/docbook/xsl-stylesheets-* , so it looks to me unlikely that a random VERSION file may affect the process.

This is a very specific issue on a very specific platform, and it may require people with the proper environment knowledge to debug it.

As a starter, please attach the compilation logs and the exact error messages.
Comment 2 Srevin Saju 2020-11-30 08:53:47 UTC


I have attached the build.log and cmake.log for your reference.
It seems like CMAKE searches my $PATH for DocBookXSL; my $PATH includes 
~/.antigen/.../zsh-autosuggestions which might be a pointer.

I am not sure why it selects ~/.antigen/.../zsh-autosuggestions. I can clean 
build it, if I pop ~/.antigen/.../zsh-autosuggestions from $PATH, but it might imply that some checks or the path to DocBookXSL is to be refined perhaps

https://people.sugarlabs.org/~srevinsaju/dl/cmake-2020-11-30.log
https://people.sugarlabs.org/~srevinsaju/dl/build-2020-11-30.log
Comment 3 Bug Janitor Service 2020-12-15 04:34:07 UTC
Dear Bug Submitter,

This bug has been in NEEDSINFO status with no change for at least
15 days. Please provide the requested information as soon as
possible and set the bug status as REPORTED. Due to regular bug
tracker maintenance, if the bug is still in NEEDSINFO status with
no change in 30 days the bug will be closed as RESOLVED > WORKSFORME
due to lack of needed information.

For more information about our bug triaging procedures please read the
wiki located here:
https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging

If you have already provided the requested information, please
mark the bug as REPORTED so that the KDE team knows that the bug is
ready to be confirmed.

Thank you for helping us make KDE software even better for everyone!
Comment 4 Srevin Saju 2020-12-15 04:52:10 UTC
Reported