[gentoo-dev] [PATCH] kde5.eclass: Relocate KDE_INSTALL_DOCBUNDLEDIR to /usr/share/kde-doc

[gentoo-dev] [PATCH] kde5.eclass: Relocate KDE_INSTALL_DOCBUNDLEDIR to /usr/share/kde-doc

[Andreas Sturmlechner]

These are handbook files installed by hundreds of packages to a
central location, to be accessed by KDE Helpcenter application,
with compressed index cache files.

This leads to the following QA issues on every package w/ USE handbook:
* The ebuild is installing to one or more unexpected paths
* One or more compressed files were found in docompress-ed directories

We'll use the EAPI-7 transition to move the location from previously
/usr/share/doc/HTML to /usr/share/kde-doc, similar to gtk-doc. To minimise
interruption for users of khelpcenter, the stabilisation of EAPI-7 ebuilds
will be done in bulk for all kde-*/ packages.

As a side-effect, we will be able to drop the workaround for disabling
auto compression of files beneath /usr/share/doc together with EAPI-6.

Bug: https://bugs.gentoo.org/667138
Signed-off-by: Andreas Sturmlechner <asturm@gentoo.org>
---
 eclass/kde5.eclass | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/eclass/kde5.eclass b/eclass/kde5.eclass
index d6c790fe52..a0cedc1f35 100644
--- a/eclass/kde5.eclass
+++ b/eclass/kde5.eclass
@@ -636,6 +636,8 @@ kde5_src_configure() {
 			# install mkspecs in the same directory as qt stuff
 			-DKDE_INSTALL_USE_QT_SYS_PATHS=ON
 		)
+		# move handbook outside of doc dir for at least two QA warnings, bug 667138
+		[[ ${EAPI} != 6 ]] && cmakeargs+=( -DKDE_INSTALL_DOCBUNDLEDIR="${EPREFIX}/usr/share/kde-doc" )
 	fi
 
 	# allow the ebuild to override what we set here
@@ -705,11 +707,13 @@ kde5_src_install() {
 		docompress -x /usr/share/doc/qt-${pv}
 	fi
 
-	# We don't want /usr/share/doc/HTML to be compressed,
-	# because then khelpcenter can't find the docs
-	#todo: clean up trailing slash check when EAPI <7 is removed
-	if [[ -d ${ED%/}/usr/share/doc/HTML ]]; then
-		docompress -x /usr/share/doc/HTML
+	if [[ ${EAPI} = 6 ]]; then
+		# We don't want /usr/share/doc/HTML to be compressed,
+		# because then khelpcenter can't find the docs
+		#todo: clean up trailing slash check when EAPI <7 is removed
+		if [[ -d ${ED%/}/usr/share/doc/HTML ]]; then
+			docompress -x /usr/share/doc/HTML
+		fi
 	fi
 }
 
-- 
2.20.1

Re: [gentoo-dev] [PATCH] kde5.eclass: Relocate KDE_INSTALL_DOCBUNDLEDIR to /usr/share/kde-doc

[Andreas Sturmlechner]

On Montag, 28. Jänner 2019 20:59:32 CET Andreas Sturmlechner wrote:
> We'll use the EAPI-7 transition to move the location from previously
> /usr/share/doc/HTML to /usr/share/kde-doc, similar to gtk-doc. To minimise
> interruption for users of khelpcenter, the stabilisation of EAPI-7 ebuilds
> will be done in bulk for all kde-*/ packages.

KDE upstream suggested to use a different path: /usr/share/help
It would be a standard location already in use by some(?) GTK+ applications.
See also: https://www.freedesktop.org/wiki/Specifications/help-system/

Regards,
Andreas