Message: previous - next
Month: March 2011

Re: [trinity-devel] kdelibs doc common build problem

From: Serghei Amelian <serghei@...>
Date: Sat, 12 Mar 2011 13:44:41 +0200
On Saturday 12 March 2011 08:13:44 Timothy Pearson wrote:
> Serghei,
> I almost have kdelibs built, but from what I can tell the common/ symbolic
> link in the documentation directories is not being created.
> As one example, a symbolic link would normally be present in
> /opt/trinity/share/doc/kde/HTML/en/kspell/common, pointing to the
> /opt/trinity/share/doc/kde/HTML/en/common directory.  This is so that the
> KHTML-based documentation renderer can find the needed graphics and style
> files.

Fixed for kspell.

> I would try to fix this myself, but I lack the requisite CMake knowledge
> to do it correctly.

I don't care very much about documentation, if someone want to pickup this 
task, please do it. I created for this purpose a macro named 
tde_create_handbook() which automated all ugly work. There is not yet any 
support for manual pages (we really need manual pages??).

tde_create_handbook() syntax:

tde_create_handbook( <target> [FILES file1 files2 ...] [SRCDIR /path/to/src] 
[DESTINATION name_of_app] [LANG language] )

- FILES are detected automatically, usually

- SRCDIR is not needed usually (equivalent with "meinproc --srcdir")

- DESTINATION is name of application, usually; if provided path is not 
absolute, ${HTML_INSTALL_DIR}/en is prepended.

- LANG - english by default

Real example:

tde_create_handbook( SRCDIR ${CMAKE_SOURCE_DIR}/kdoctools DESTINATION kspell )
add_dependencies( kspell-handbook meinproc )

add_dependencies() is needed only in kdelibs context, to ensure that meinproc 
is built before cmake generating documentation (otherwise there is a big 
chance to fail on parallel building).

> Tim


Sorry for english, if is something unclear, just ask and I will try to explain