[cmake-developers] Introduction and volunteering for the Matlab package
Raffi Enficiaud
raffi.enficiaud at free.fr
Wed Mar 5 17:46:49 EST 2014
Hi,
So, I began writing the doc of the module and changed the license according to the instructions.
I am attaching the module to the email.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: FindMatlab.cmake
Type: application/octet-stream
Size: 22951 bytes
Desc: not available
URL: <http://public.kitware.com/pipermail/cmake-developers/attachments/20140305/84011bc0/attachment-0002.obj>
-------------- next part --------------
From what I see in the instructions, there are some issues with the proposed module:
- the error messages are more or less message(STATUS... and sometimes message(FATAL_ERROR, rather than using Xxx_NOT_FOUND_MESSAGE. So basically if I set this variable to the error message and just call ?return()? from the module scope, it will do the job?
- it looks like I am making too much use of the CACHE. However, I do not know if the variables like Xxx_INCLUDE_DIRS should go to the CACHE or to the PARENT_SCOPE. What are the good practices for these variables ?
- some of the variables should be renamed
- the version matching should be performed in the module, right ?
Best,
Raffi Enficiaud
On 05 Mar 2014, at 18:50, Brad King <brad.king at kitware.com> wrote:
> On 03/05/2014 08:49 AM, Raffi Enficiaud wrote:
>> I am volunteering myself for maintaining the Matlab package.
>
> Great, thanks!
>
>> I already gave some of the functionalities in the following mantis ticket:
>> http://www.cmake.org/Bug/view.php?id=14641
>
> In answer to your questions from there:
>
>> - What should I do now?
>> - What is the release process?
>
> Posting here was a good first step. See full instructions here:
>
> http://www.cmake.org/Wiki/CMake:Module_Maintainers#New_Maintainer
>
> Please post the proposed module as an attachment here for discussion
> and review. Once things are in good shape then we will ask you to
> sign up for Git access.
>
>> - If I release this script with the BSD-3 license, it is ok right?
>> What about the Boost v1 license that I am currently using?
>
> We require the BSD 3-Clause license, please. The developer manual:
>
> http://www.cmake.org/cmake/help/v3.0/manual/cmake-developer.7.html#find-modules
>
> specifies the exact format in which the legal notice must appear.
> The test suite verifies it.
>
>> - How to update the documentation then? Should the package be
>> released with a text file documenting the functionalities?
>
> The documentation goes in the module as described here:
>
> http://www.cmake.org/cmake/help/v3.0/manual/cmake-developer.7.html#module-documentation
>
> Thanks,
> -Brad
>
More information about the cmake-developers
mailing list