Skip to content

Commit

Permalink
Document scaladoc usage in Bazel (#11278)
Browse files Browse the repository at this point in the history
changelog_begin
changelog_end
  • Loading branch information
cocreature authored Oct 18, 2021
1 parent 6255837 commit edb2b04
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions BAZEL.md
Original file line number Diff line number Diff line change
Expand Up @@ -920,6 +920,29 @@ the target `foo_deploy.jar` next to the regular `foo.jar` target. Building the
`foo_deploy.jar` target will generate a self-contained fat JAR suitable to be
passed to `java -jar`.
### Scaladoc
We generate scaladoc targets for each `da_scala_library` with a
`_scaladoc` name suffix. All scaladoc targets have a `scaladoc` tag
which allows you to filter them out to speed up your builds. You can
either do that on the command line by running e.g.
```
bazel build --build_tag_filters=-scaladoc //...
```
or if you want to never build them locally you can set this in your `.bazelrc.local`:
```
build --build_tag_filters=-scaladoc
```
You can still build an individual target by selecting it explicitly, e.g.
```
bazel build //daml-lf/validation:validation_scaladoc
```
### Daml Packages
Daml package targets are defined using the `daml` rule loaded from
Expand Down

0 comments on commit edb2b04

Please sign in to comment.