@@ -51,7 +51,7 @@ A huge shout out to the people behind these projects.
51
51
52
52
To generate the overall component dependency graph for a project, use it like so -
53
53
54
- ` cpp_dependency_graph visualise -r spec\test\example_project\ -o deps.dot -f dot `
54
+ ` cpp_dependency_graph visualise_project -r spec\test\example_project\ -o deps.dot -f dot `
55
55
56
56
Below is the overall ` dot ` and ` d3 ` component dependency visualisations for [ leveldb] ( https://github.com/google/leveldb )
57
57
@@ -67,7 +67,7 @@ Below is the overall `dot` and `d3` component dependency visualisations for [lev
67
67
68
68
This will highlight the dependencies coming in and going out of a specific component. This allows you to filter out extraneous detail and study individual components in more detail.
69
69
70
- ` cpp_dependency_graph visualise -r spec\test\example_project\ -c Engine -o deps.dot -f dot `
70
+ ` cpp_dependency_graph visualise_component -r spec\test\example_project\ --component Engine -o deps.dot -f dot `
71
71
72
72
Here's a component dependency visualisation generated for the ` queue ` component in [ rethinkdb] ( https://github.com/rethinkdb/rethinkdb )
73
73
@@ -79,25 +79,23 @@ Here's a component dependency visualisation generated for the `queue` component
79
79
80
80
This will highlight dependencies of includes within a specific component
81
81
82
- ` cpp_dependency_graph visualise_includes -r spec\test\example_project\ -c Engine `
82
+ ` cpp_dependency_graph visualise_component_includes -r spec\test\example_project\ --component Engine `
83
83
84
84
Here's a component include dependency visualisation generated for the ` queue ` component in [ rethinkdb] ( https://github.com/rethinkdb/rethinkdb )
85
85
86
86
![ Queue include graph dot] ( docs/examples/rethinkdb_queue_include.svg )
87
87
88
88
![ Queue include graph d3] ( docs/examples/rethinkdb_queue_include_d3.svg )
89
89
90
- ### File include dependency graph
90
+ ### Header file include dependency graph
91
91
92
- This will highlight include dependencies of files globally within the project
92
+ This will highlight include dependencies of header files globally within the project
93
93
94
- ` cpp_dependency_graph visualise_includes -r spec\test\example_project\ -c Engine `
94
+ ` cpp_dependency_graph visualise_header_includes -r spec\test\example_project\ --header Engine.h `
95
95
96
- Here's a component include dependency visualisation generated for the ` queue ` component in [ rethinkdb] ( https://github.com/rethinkdb/rethinkdb )
97
-
98
- ![ Queue include graph dot] ( docs/examples/rethinkdb_queue_include.svg )
96
+ Here's a component include dependency visualisation generated for the ` errors.hpp ` header file in [ rethinkdb] ( https://github.com/rethinkdb/rethinkdb )
99
97
100
- ![ Queue include graph d3 ] ( docs/examples/rethinkdb_queue_include_d3 .svg )
98
+ ![ Errors.hpp include graph dot ] ( docs/examples/rethinkdb_errors_header_include .svg )
101
99
102
100
### Cyclic dependencies only graph
103
101
@@ -113,15 +111,15 @@ Here's the cyclic dependencies only visualisation generated for [rethinkdb](http
113
111
114
112
## Development
115
113
116
- ` bundle exec cpp_dependency_graph visualise -r <dir> `
114
+ ` bundle exec cpp_dependency_graph <cmd> -r <dir> ... `
117
115
118
116
### Running all unit tests
119
117
120
118
` rake spec `
121
119
122
120
### Running a single test
123
121
124
- ` rake spec SPEC=spec/test/include_file_dependency_graph_spec.rb `
122
+ ` rake spec SPEC=<path_to_spec_file> `
125
123
126
124
## License
127
125
0 commit comments