Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated doc parts #157

Merged
merged 1 commit into from
Nov 2, 2023
Merged

Remove deprecated doc parts #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,17 +254,12 @@ Even if analysing the code works initially, it might break at any time if the or
## Layering check

To make sure no headers from transitive dependencies or private headers from dependencies are used you can use [Layering check with Clang](https://maskray.me/blog/2022-09-25-layering-check-with-clang) which is natively supported by Bazel.
This approach has some benefits over DWYU:

- Directly integrated into Bazel without need for further tooling.
- Is able to overcome [the known DWYU limitations](#known-limitations).
The main benefit of this approach is it being directly integrated into Bazel without need of further tooling like DWYU.

Still, there are reasons to use DWYU instead of or in addition to layering_check:

- DWYU does not require a compiler, it works purely by text parsing.
This is the reason for some of it's [known DWYU limitations](#known-limitations).
However, this also makes the tool more flexible and independent of your platform.
For example when using a recent clang version is not possible for you.
The only requirement towards your platform is the availability of a Python interpreter.
- DWYU is able to analyze header only libraries.
- DWYU detects unused dependencies.
- DWYU allows optimizing [implementation_deps](#implementation_deps).
Expand Down