Skip to content

Commit 25634a5

Browse files
fixup! fixup! fixup! fixup! fixup! fixup! Blah
1 parent 748bed0 commit 25634a5

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ A huge shout out to the people behind these projects.
5151

5252
To generate the overall component dependency graph for a project, use it like so -
5353

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`
5555

5656
Below is the overall `dot` and `d3` component dependency visualisations for [leveldb](https://github.com/google/leveldb)
5757

@@ -67,7 +67,7 @@ Below is the overall `dot` and `d3` component dependency visualisations for [lev
6767

6868
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.
6969

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`
7171

7272
Here's a component dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)
7373

@@ -79,25 +79,23 @@ Here's a component dependency visualisation generated for the `queue` component
7979

8080
This will highlight dependencies of includes within a specific component
8181

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`
8383

8484
Here's a component include dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)
8585

8686
![Queue include graph dot](docs/examples/rethinkdb_queue_include.svg)
8787

8888
![Queue include graph d3](docs/examples/rethinkdb_queue_include_d3.svg)
8989

90-
### File include dependency graph
90+
### Header file include dependency graph
9191

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
9393

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`
9595

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)
9997

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)
10199

102100
### Cyclic dependencies only graph
103101

@@ -113,15 +111,15 @@ Here's the cyclic dependencies only visualisation generated for [rethinkdb](http
113111

114112
## Development
115113

116-
`bundle exec cpp_dependency_graph visualise -r <dir>`
114+
`bundle exec cpp_dependency_graph <cmd> -r <dir> ...`
117115

118116
### Running all unit tests
119117

120118
`rake spec`
121119

122120
### Running a single test
123121

124-
`rake spec SPEC=spec/test/include_file_dependency_graph_spec.rb`
122+
`rake spec SPEC=<path_to_spec_file>`
125123

126124
## License
127125

docs/examples/rethinkdb_errors_header_include.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)