Review Request 117805: Introduce kdoctools_install()

[Aurélien Gâteau]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/117805/
-----------------------------------------------------------

(Updated April 30, 2014, 2:33 p.m.)


Review request for Documentation, KDE Frameworks and Luigi Toscano.


Changes
-------

Fixed typo in documentation. Extract SUBDIR argument from source path so that documentation is installed in the right place.


Repository: kdoctools


Description
-------

This function makes it easy to install all .docbook of a framework. It is similar to ki18n_install() (see https://git.reviewboard.kde.org/r/117804/ ).

The primary user of this function is the build system of the framework tarballs. The tarballs will ship with a po/ directory which follows the structure expected by kdoctools_install(). The only necessary change is to add the following lines to the root CMakeLists.txt file:

    if (IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/po")
        kdoctools_install(po)
    endif()

Since the code checks for the presence of a po/ directory, it can be committed in the framework repository (no need for the tarball release scripts to alter the CMake files), making it easier for developers to reproduce the situation of a released tarball by creating/copying a po/ directory in their working copy.


Diffs (updated)
-----

  KF5DocToolsMacros.cmake c4e33bd 

Diff: https://git.reviewboard.kde.org/r/117805/diff/


Testing
-------

Tested with fake content on kiconthemes, with and without the po dir.


Thanks,

Aurélien Gâteau

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140430/66c9b7a5/attachment.html>