Difference between revisions of "Dependency Graphs"
From GnuCash
(Wiki page documenting how to generate dependency graphs.) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
Luckily cmake (our build system generation tool) has built-in support for the graphviz dependency visualization tool. | Luckily cmake (our build system generation tool) has built-in support for the graphviz dependency visualization tool. | ||
| − | + | ;Requirement: The [https://en.wikipedia.org/wiki/Graphviz graphviz] package, which also includes <tt>dot</tt>. | |
To use it you can use these commands: | To use it you can use these commands: | ||
| Line 10: | Line 10: | ||
dot graph -Tsvg -o graph.svg | dot graph -Tsvg -o graph.svg | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | ;dot options: -Grankdir=LR for horizontal layout, | |
| + | : -Tpng to get a png (change output file extension to png as well) | ||
This will result in lots of files in the graphviz directory. The one we're interested in is '''graph.svg'''. | This will result in lots of files in the graphviz directory. The one we're interested in is '''graph.svg'''. | ||
Below you'll find two examples. | Below you'll find two examples. | ||
| + | |||
| + | [http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20191208/ec29cbcd/attachment-0002.svg Graph for maint] | ||
| + | [http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20191208/ec29cbcd/attachment-0003.svg Graph for master] | ||
Latest revision as of 20:03, 25 May 2020
GnuCash is a complex project. To keep some structure in the code, the source files are grouped into targets. Higher level targets can depend on lower level targets. That means, the lower level targets must be built before the higher level target can be built. Given the complexity, it may be challenging to get a view of these dependencies.
Luckily cmake (our build system generation tool) has built-in support for the graphviz dependency visualization tool.
- Requirement
- The graphviz package, which also includes dot.
To use it you can use these commands:
mkdir graphviz && cd graphviz
cmake --graphviz=graph ..
dot graph -Tsvg -o graph.svg
- dot options
- -Grankdir=LR for horizontal layout,
- -Tpng to get a png (change output file extension to png as well)
This will result in lots of files in the graphviz directory. The one we're interested in is graph.svg.
Below you'll find two examples.
