[cmake-developers] Re: Where to document the graphviz options ?

[David Cole]

>> using cmake --graphviz=filename .
>> you can generate graphs showing the dependencies between the targets.
>> If present, cmake will read a CMakeGraphVizOptions.cmake file, and use options
>> from it, e.g. GRAPHVIZ_GRAPH_TYPE and GRAPHVIZ_EXTERNAL_LIBS.
>> AFAIK this is not documented anywhere, and I would like to change this.
>>
>> But where should I put this information ?

>I would suggest to document it inside "CMakeGraphVizOptions.cmake"
>using basic markup used for documenting CPack generators.
>Then simply make cmake parse the file the way cpack does and you'll
>get the variables


+1 for TheErk’s suggestion...



>> Simply list the variables in the variables section, and mention that they need
>> to be set in a CMakeGraphVizOptions.cmake file ?
>> Better ideas ?

That file does not appear to be mentioned (nor any of the variables) in the main command line “--help” where the --graphviz option is mentioned. Perhaps mention it briefly there, too.



D
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/cmake-developers/attachments/20130725/2564b2cf/attachment.html>