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

[Eric Noulard]

2013/7/24 Alexander Neundorf <neundorf at kde.org>:
> Hi,
>
> 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
(or macro/functions) documented in --help-variable-*

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

Nope.

-- 
Erk
L'élection n'est pas la démocratie -- http://www.le-message.org