[cmake-developers] RFC: LLVM community CMake documentation

Chuck Atkins chuck.atkins at kitware.com
Thu Apr 28 11:33:45 EDT 2016


Hi Chris,

This is great!  I do have a suggestion that perhaps Brad could weigh in on
(may disagree).  Since your already looking at a reasonably recent minimum
requirement in your examples (3.2) and discussing bumping the minimum up to
3.4.3 even, I think it would be worthwhile to let even some of the simple
examples show some of the newer language features and syntax.  For example,
in your lists of lists example, you currently have:

foreach(list_name ${list_of_lists})
  foreach(value ${${list_name}})
    message(${value})
  endforeach()
endforeach()

which has been valid CMake syntax since the days of yore, but you could
show the newer syntax instead that uses the list variables directly instead
of de-referencing them:

foreach(list_name IN LISTS list_of_lists)
  foreach(value IN LISTS ${list_name})
    message(${value})
  endforeach()
endforeach()

It's of course a preference for how you want to document and use CMake in
llvm but it might be good to get users started right off the bat with "new"
cmake.


- Chuck

On Wed, Apr 27, 2016 at 4:39 PM, Chris Bieneman <chris.bieneman at me.com>
wrote:

> Hello cmake-developers,
>
> Earlier this year the LLVM community finished migrating to CMake as our
> one and only build system. One of the lingering things on my to-do list to
> help this transition is to write some basic documentation for the CMake
> language to help LLVM developers get a feel for the language.
>
> I’ve attached the working draft of my documentation, and would greatly
> appreciate any feedback from members of the CMake community. While it is
> not my goal to be a definitive source, I would like to be as accurate as I
> can be.
>
> Thank you,
> -Chris
>
>
> --
>
> Powered by www.kitware.com
>
> Please keep messages on-topic and check the CMake FAQ at:
> http://www.cmake.org/Wiki/CMake_FAQ
>
> Kitware offers various services to support the CMake community. For more
> information on each offering, please visit:
>
> CMake Support: http://cmake.org/cmake/help/support.html
> CMake Consulting: http://cmake.org/cmake/help/consulting.html
> CMake Training Courses: http://cmake.org/cmake/help/training.html
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://public.kitware.com/mailman/listinfo/cmake-developers
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/cmake-developers/attachments/20160428/126afb6d/attachment.html>


More information about the cmake-developers mailing list