Skip to content

Commit

Permalink
Update README, make markdown less confused.
Browse files Browse the repository at this point in the history
  • Loading branch information
hzeller committed Jun 4, 2024
1 parent c11a053 commit e515e35
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,25 +99,26 @@ The following auto-fixes all dependencies of the project:
. <(bant dwyu ...) # source the buildozer calls in shell
```

Features
##### Features

If there is a dependency that `bant` would like to remove, but it is needed
for some reason that can't be derived from the include files it provides
(and you can't correctly mark it as `alwayslink` because it is coming
from some external project for instance), you can add a comment that
contains the word 'keep' in the line in question.

* If there is a dependency that `bant` would like to remove, but it is needed
for some reason that can't be derived from the include files it provides
(and you can't correctly mark it as `alwayslink` because it is coming
from some external project for instance), you can add a comment that
contains the word 'keep' in the line in question.
```
cc_library(
deps = [
":foo" # build_cleaner keep
]
)
```
Note, a well-defined project should not need this. This features provides
an escape hatch if needed. With `-k`, `bant` will be
strict and ignore `# keep` comments and emit the removal edit anyway.
Note, a well-defined project should not need this. This features provides
an escape hatch if needed. With `-k`, `bant` will be
strict and ignore `# keep` comments and emit the removal edit anyway.

Caveats
##### Caveats

* Does not understand package groups in visibility yet; these will be
considered `//visibility:public` and might result in adding
Expand Down

0 comments on commit e515e35

Please sign in to comment.