kjsembed tier (Re: Build failed in Jenkins: kjsembed_master_qt5 #27)

[David Faure]

On Saturday 01 March 2014 12:49:02 Aurélien Gâteau wrote:
> On Sat, Mar 1, 2014, at 6:37, David Faure wrote:
> > On Saturday 01 March 2014 13:37:31 Kevin Krammer wrote:
> > > On Saturday, 2014-03-01, 13:19:23, David Faure wrote:
> > > > On Saturday 01 March 2014 12:12:37 KDE CI System wrote:
> > > > > CMake Error at CMakeLists.txt:30 (find_package):
> > > > >   Could not find a configuration file for package "KF5DocTools" that
> > > > >   is
> > > > >   compatible with requested version "4.97.0".
> > > > >   
> > > > >   The following configuration files were considered but not 
accepted:
> > > > >     /srv/jenkins/install/linux/x86_64/g++/kf5-qt5/frameworks/kdoctoo
> > > > >     ls/i
> > > > >     ns
> > > > >     t/
> > > > > 
> > > > > lib64/cmake/KF5DocTools/KF5DocToolsConfig.cmake, version: 4.96.0
> > > > 
> > > > Interesting, so kjsembed lies when it says "tier2", because it depends
> > > > on
> > > > kdoctools which also says "tier2".
> > > > 
> > > > Kevin, was 3064544f814813e4f528e7902f567e5ec4a30ffd in kjsembed wrong?
> > > 
> > > If it does need another tier2 framework other then the old ki18n then
> > > yes.
> > > I checked the diagrams I was pointed at during the IRC meeting and it
> > > only
> > > had ki18n and kjs as dependencies.
> > 
> > I see. The diagrams are wrong/outdated :)
> > 
> > Aurélien: you added kdoctools to kjsembed in c5dc9c1d03.
> 
> Mmm, which repository are you referring to? I can't find such a revision
> in the kjsembed repository.

You didn't set up the git-grafting then :)

It was actually when it was all in kdelibs.git, so you can find it there if 
you prefer.

> Good news: diagrams should now automatically be generated on
> api.kde.org! I was about to announce it.

Excellent !

> KJSEmbed diagram is here:
> 
> http://api.kde.org/frameworks-api/frameworks5-apidocs/kjsembed/html/kjsembed
> -dependencies.html
> 
> I had a look at the CMake code in KJSEmbed: it does not link to any
> target provided by KDocTools, so CMake Graphviz code does not list it as
> a dependency. 

Ah, but any find_package(XYZ REQUIRED) makes XYZ a dependency... I didn't know 
the graphviz stuff was based on shared libs only, this indeed misses other 
kinds of dependencies (basically deps on cmake files - like ECM, kdoctools or 
kf5umbrella).

> You can declare the dependency manually. I documented how
> to do it here:
> 
> http://techbase.kde.org/Policies/KDE_Frameworks_Documentation_Policy#.24fram
> ework.yaml
> 
> I can do it if you prefer, but I am interested in finding out whether my
> doc is understandable :)

OK I can give it a try - once we decide on the last paragraph:

> If I am not mistaken, KJSEmbed depends on KDocTools because it uses
> kdoctools_create_manpage. Would it be an option to generate the man page
> without KDocTools. It's a bit sad to bump it from tier 2 to tier 3 just
> because of this.

Hmm, especially for the contents of that man page (which could all be in the 
--help output).

I would either:
1) get rid of the man page and improve --help instead
or
2) put the generated kjscmd5.1 file into git, with a shell-script that calls 
kdoctools for updating it when modifying the docbook. 

-- 
David Faure, faure at kde.org, http://www.davidfaure.fr
Working on KDE, in particular KDE Frameworks 5