[cmake-developers] cmake --help-concept

[Stephen Kelly]

Alexander Neundorf wrote:

> On Saturday 14 September 2013, Stephen Kelly wrote:
>> Brad King wrote:
>> > On 08/28/2013 03:28 PM, Stephen Kelly wrote:
>> >> We should add these concept sections to the docs and we can add 'See
>> >> the documentation of the generator_expression concept' where it makes
>> >> sense. We should not change or extend the markup or make adding these
>> >> concept sections dependent on choosing and implementing a new markup
>> >> for docs.
>> > 
>> > The --help-concept proposal is for a specific new section rather than
>> > general infrastructure for adding sections.  It can be one man page
>> > that has an item for each concept, just like the command help has an
>> > item for each command.  This can be done independent of other changes
>> > discussed in the thread Alex linked.
>> 
>> I've pushed the concept-help branch to next for review, along with one
>> documentation item on policies. Once the details are worked out and
>> merged, I can write some more, and Alex may want to too.
> 
> Would e.g. the list of supported languages or toolchains be a candidate
> for that "concepts" section ?
> Or should the languages be documented in the enable_language()
> documentation ?

I'd say that if there's a language concept section, it would say that the 
project command can be used to enable languages, and that it enables C and 
CXX by default. It would also say that enable_language can be used to enable 
languages. It would also list the language specfic variables that can be set 
by the user. If 3rd party language support is a supported use-case of cmake 
(I'm not sure), it would describe how to add support for a language. 

It could also list the languages built-in to CMake, but it would be more 
than just a list. It should be a starting point to other commands and 
variables relevant to language support in CMake.

Thanks,

Steve.