kcmlaunchfeedback
ClosedPublic
Actions

Authored by lueck on Mar 24 2018, 9:15 PM.

Details

Reviewers

davidedmundson
hein

Group Reviewers

Plasma
Localization
Documentation

Commits

R119:d6e3d6ffbf2f: Fix docbook installation for doc/kcontrol/kcmlaunchfeedback

Summary

kcms/launch/kcm_launchfeedback.desktop
X-DocPath=kcontrol/kcmlaunchfeedback/index.html

doc/kcontrol/kcmlaunch/CMakeLists.txt
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/kcmlaunch)

kcmlaunch != kcmlaunchfeedback therefore the en_US documentation is not found

Scripty generates the install path from the dir name
l10n-kf5/[lang]/docs/kde-workspace/kcontrol/kcmlaunch/CMakeLists.txt
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/${CURRENT_LANG}/ SUBDIR kcontrol/kcmlaunch )

We need X-DocPath=kcontrol/kcmlaunch/index.html in the desktop file
then khelpcenter finds the correct docbook for en_US and all language translations

Test Plan

build and works

Diff Detail

Lint

Lint Skipped

Unit

Unit Tests Skipped

lueck created this revision.Mar 24 2018, 9:15 PM

Restricted Application added a project: Plasma. · View Herald TranscriptMar 24 2018, 9:15 PM

Restricted Application added a subscriber: plasma-devel. · View Herald Transcript

lueck requested review of this revision.Mar 24 2018, 9:15 PM

davidedmundson accepted this revision.Mar 24 2018, 11:40 PM

This revision is now accepted and ready to land.Mar 24 2018, 11:40 PM

I disagree with this patch - I renamed things for consistency for a reason and emailed i18n-doc, so I expect the docs to get renamed.

This revision now requires changes to proceed.Mar 24 2018, 11:42 PM

Your email said "master branch renamed kcmlaunch.pot to kcmlaunchfeedback.pot" you did never mention docs.

Anyhow, are you asking Burkhard to change the patch to rename the folder? I guess that's also a fine solution.

In D11661#233341, @hein wrote:

I disagree with this patch - I renamed things for consistency for a reason and emailed i18n-doc, so I expect the docs to get renamed.

Right you emailed i18n-doc, changed the X-DocPath to control/kcmlaunchfeedback/index.html, but not the install target in doc/kcontrol/kcmlaunch/CMakeLists.txt,
therefore the englisch documentation is not found.

The name of the docmessages catalog, the name of the translated docs and the install target for the translated docs are autogenerated by scripty.
Rename the translated docs is therefore no real option, the dir doc/kcontrol/kcmlaunch/ has to be renamed, another level of consistency ;-)

I will upload a new patch so fix this bug for the english and the language docs.

rename dir doc/kcontrol/kcmlaunch to doc/kcontrol/kcmlaunchfeedback
scripty automatically generates the correct name for the docmessages catalog, the language docs and the install target

change install target to kcontrol/kcmlaunchfeedback in doc/kcontrol/kcmlaunchfeedback/CMakeLists.txt
now the english docbook is found by khelpcenter

Restricted Application added a subscriber: kde-doc-english. · View Herald TranscriptMar 25 2018, 12:27 PM

Thanks! :)

This revision is now accepted and ready to land.Mar 26 2018, 6:10 AM

Closed by commit R119:d6e3d6ffbf2f: Fix docbook installation for doc/kcontrol/kcmlaunchfeedback (authored by lueck). · Explain WhyMar 26 2018, 7:53 AM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			doc/kcontrol/CMakeLists.txt (2 lines)
V			doc/kcontrol/{kcmlaunch → kcmlaunchfeedback}/CMakeLists.txt
V			doc/kcontrol/{kcmlaunch → kcmlaunchfeedback}/index.docbook
V			doc/kcontrol/{kcmlaunchfeedback ← kcmlaunch}/CMakeLists.txt (2 lines)
V			doc/kcontrol/{kcmlaunchfeedback ← kcmlaunch}/index.docbook

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	30439			Mar 24 2018, 9:08 PM	★	★
Diff 2	30498			Mar 25 2018, 12:25 PM	★	★
Diff 3	30600	17e1b4b	R119:d6e3d6ffbf2f8f1b180526a2a6baeecebd34da0f	Mar 26 2018, 6:45 AM	★	★