docbook issues in workspace repos

[Burkhard Lück]

Am Donnerstag, 17. April 2014, 17:42:25 schrieb Aleix Pol:
> On Mon, Apr 14, 2014 at 12:57 PM, Burkhard Lück <lueck at hube-lueck.de> wrote:
> > Hi,
> > 
> > I found a lot of docbook issues in many workspace repos, i. e. code but no
> > corresponding docbook in a repo and vice versa:
> > 
Just to clarify my pov and this list:
Code + corresponding docbook should to be in the same repo, so that both are 
installed together.
Using a script I have searched a repo for all X-DocPath entries in *.desktop 
files = Code and checked if the corresponding docbook is in the repo as well 
and the other way round - search all docbooks and check if the repo has a 
desktop file with the X-DocPath for this docbok.

> > kde-cli-tools:
> > mv plasma-desktop/doc/kcontrol/filetypes/
> > kde-cli-tools/doc/kcontrol/filetypes/
> 
> Are we sure about that? I skimmed through the file and it's describing the
> KCM module...
> 
Yes, that is true. 
And keditfiletype/filetypes.desktop indicates that this is the KCM-Code with the 
X-DocPath in filetypes.desktop for this docbook.

> > khelpcenter:
> > mv doc/* doc/khelpcenter
> > mv kde-runtime/doc/[onlinehelp|fundamentals|glossary] /doc
> 
> Done
> 
Thanks.

> > /plugins/plasma.desktop X-DocPath=help:/plasma-desktop/index.html???
> > mv plasma-desktop/doc/plasma-desktop/ /doc/
> 
> I'm unsure what this means, sorry.
> 
plasma-desktop is a docbook with general infos about plasma, not tied to any 
specific code and via plugins/plasma.desktop it is a top level item in the 
navigation tree of khelpcenter, therefore the docbook has to be installed 
together with khelcenter.

> > khotkeys:
> > mv kde-workspace/doc/kcontrol/khotkeys doc/kcontrol/khotkeys
> 
> It's in plasma-desktop/doc/kcontrol/khotkeys
> 
Sorry my fault, docbook is in plasma-desktop, and code is in khotkeys repo 
(kcm_hotkeys dir with X-DocPath=kcontrol/khotkeys/index.html.
There for the khotkeys docbook has to be moved here.

> > kio-extras:
> > missing docbooks kcontrol/kcmcgi/ + kcontrol/trash/ (from superfluous
> > docbook /doc/kioslave/network/ where is the code?
> 
> They are both in Plasma-Desktop, with the rest of KControl modules.
> 
cgi kcm code is in cgi/kcmcgi with X-DocPath=kcontrol/kcmcgi/index.html in 
kcmcgi.desktop, therefore the cgi docbook should be in this repo as well

trash kcm code is in trash dir with  X-DocPath=kcontrol/trash/index.html in 
kcmtrash.desktop, therefore the trash docbook should be in this repo as well

> > kwindowsaddons:
> > missing docbooks kcontrol/platform/+ kwinshutdown/ ? did we ever had
> > these docbooks?
> 
> I don't think so.
> 
> > plasma-desktop:
> > Docbooks, but no corresponding X-DocPath entries
> > 
> >   /doc/kcontrol/bookmarks/index.docbook
code in konqueror/settings/kio/
> >   /doc/kcontrol/cache/index.docbook
code in konqueror/settings/kio/
> >   /doc/kcontrol/clock/index.docbook
code in plasma-desktop/kcms/dateandtime/ -> OK
> >   /doc/kcontrol/cookies/index.docbook
code in konqueror/settings/kio/
> >   /doc/kcontrol/cursortheme/index.docbook
> >   /doc/kcontrol/ebrowsing/index.docbook
code in konqueror/settings/ebrowsing/
> >   /doc/kcontrol/filemanager/index.docbook
code in konqueror/settings/konq/
> >   /doc/kcontrol/filetypes/index.docbook
code in workspace/kde-cli-tools/keditfiletype/
> >   /doc/kcontrol/history/index.docbook
code in konqueror/sidebar/history_module/
> >   /doc/kcontrol/kcm_ssl/index.docbook
code in kdelibs4support/src/kssl/kcm/
> >   /doc/kcontrol/kcmcgi/index.docbook
code in kio-extras/cgi/kcmcgi/
> >   /doc/kcontrol/kcmcss/index.docbook
code in konqueror/settings/konqhtml/css/
> >   /doc/kcontrol/kcmsmserver/index.docbook
code in plasma-workspace/ksmserver/kcm/
> >   /doc/kcontrol/khotkeys/index.docbook
code in workspace/khotkeys/kcm_hotkeys/
> >   /doc/kcontrol/khtml-adblock/index.docbook
code in konqueror/settings/konqhtml/
> >   /doc/kcontrol/khtml-behavior/index.docbook
code in konqueror/settings/konqhtml/
> >   /doc/kcontrol/khtml-general/index.docbook
code in konqueror/settings/konqhtml/
> >   /doc/kcontrol/khtml-java-js/index.docbook
code in konqueror/settings/konqhtml/
> >   /doc/kcontrol/khtml-plugins/index.docbook
code in nsplugins/
> >   /doc/kcontrol/netpref/index.docbook
code in konqueror/settings/kio/
> >   /doc/kcontrol/paths/index.docbook
code in plasma-desktop/kcms/desktoppaths/ -> OK
> >   /doc/kcontrol/performance/index.docbook
code in konqueror/settings/performance/
> >   /doc/kcontrol/powerdevil/index.docbook
code in extragear/base/powerdevil
> >   /doc/kcontrol/proxy/index.docbook
code in konqueror/settings/kio/
> >   /doc/kcontrol/smb/index.docbook
code in konqueror/settings/kio/
> >   /doc/kcontrol/solid-device-automounter/index.docbook
code in kde-runtime/solid-device-automounter/kcm/
> >   /doc/kcontrol/splashscreen/index.docbook
code in plasma-workspace/ksplash/kcm/
> >   /doc/kcontrol/trash/index.docbook
code in kio-extras/trash/
> >   /doc/kcontrol/useragent/index.docbook
code in konqueror/settings/kio/
> 
As this list shows a lot of kcm docbooks here have the corresponding code in 
other repos, is that intended?
 
> So we want the kcm desktop files to link to those?
> For example, there's the clock kcm, which desktop file is in
> plasma-desktop/kcms/dateandtime/clock.desktop. It doesn't have such
> X-DocPath but then it doesn't seem to need any move.
> 
> Should we add it now? Is it already broken in KDE4?
> 
clock.desktop has X-DocPath=kcontrol/clock/index.html here (and in kde4 as 
well) so no need to add it.

> > plasma-workspace:
> > missing docbooks: kcontrol/kcmsmserver/ + kcontrol/splashscreen/
> > mv plasma-desktop/doc/[kcontrol/kcmsmserver|kcontrol/splashscreen]
> > plasma/workspace/doc/
> 
> Actually in these cases, kcmsmserver and the ksplashscreen kcm should go to
> plasma-desktop instead.
> 
kcmsmserver code is in plasma-workspace (ksmserver/kcm/kcmsmserver.desktop) 
and ksplashscreen code is in plasma-workspace 
(ksplash/kcm/ksplashthememgr.desktop), there for these docbooks should go to 
plasma-workspace repo, where the code lives.

> > superfluous docbooks /doc/PolicyKit-kde/ where is the code?
> 
> I think here:
> https://projects.kde.org/projects/extragear/base/polkit-kde-agent-1
> 
> I don't know if this has been ported yet, but it should probably go to
> either frameworksintegration or plasma-workspace.
> 
I'd prefer to have the docbook together with the code, so it should go to 
extragear/base/polkit-kde-agent-1

-- 
Burkhard Lück