Review Request 116025: Add documentation about writing find modules

[Stephen Kelly]

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


There's nothing ecm specific here. The reason I created no such document was because it belongs in (and versioned with) CMake, not in ECM. http://thread.gmane.org/gmane.comp.programming.tools.cmake.devel/8144/focus=8147

As that is now possible in cmake master, and as there are other similar manuals in cmake now, consider contributing there instead.


docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35685>

    You can link to
    
     http://www.cmake.org/cmake/help/git-master/manual/cmake-packages.7.html
    
    for upstream info on this.



docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35686>

    The imported targets should be the primary way of using the module. I don't think the _INCLUDES and _LIBRARIES etc variables should even be set if imported targets are provided.



docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35687>

    I don't think AUTHOR_WARNING is appropriate here. Why not WARNING?



docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35688>

    Actually it's mostly important so that users can set it in the cache if they have the library in a non-predicted location.



docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35689>

    Don't set Foo_VERSION_STRING, set Foo_VERSION. That is canonical because of config-file packages.



docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35690>

    Not only convention. CMake also provides a diagnostic if you use '::'.



docs/writing-find-modules.md
<https://git.reviewboard.kde.org/r/116025/#comment35691>

    Note that only build-properties of the target itself should be here. Not those of dependencies (if the dependency provides imported targets, which it should/must for this stuff to work). CMake will resolve that itself.


- Stephen Kelly


On Feb. 25, 2014, 10:59 a.m., Alex Merry wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/116025/
> -----------------------------------------------------------
> 
> (Updated Feb. 25, 2014, 10:59 a.m.)
> 
> 
> Review request for Build System, Extra Cmake Modules and KDE Frameworks.
> 
> 
> Repository: extra-cmake-modules
> 
> 
> Description
> -------
> 
> Add documentation about writing find modules
> 
> 
> Diffs
> -----
> 
>   README.md 85b97b7fa003282e1eeb1113c4668a9b73e3f731 
>   docs/writing-find-modules.md PRE-CREATION 
> 
> Diff: https://git.reviewboard.kde.org/r/116025/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Alex Merry
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140225/466b066d/attachment-0001.html>