Skip to content

Commit

Permalink
chore(ci): update check-doc Make task strategy for Rust components
Browse files Browse the repository at this point in the history
This change updates a few strategies all of which reduce check time and
false positive failures:

- Remove `--all` flag which is deprecated for `--workspace` and is not
  the intended default behavior at a component/crate level (i.e. only
  check documentation for _this_ crate)
- Add `--all-features` to ensure that all feature-gated code
  documentation is also checked
- Add `--no-deps` flag which does not check documentation for
  dependencies

Signed-off-by: Fletcher Nichol <fletcher@systeminit.com>
  • Loading branch information
fnichol committed Sep 20, 2022
1 parent 4aa5dff commit efc9832
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion mk/rust.mk
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ default--check-lint:
## check-doc: Checks all documentation for the Rust crate
default--check-doc:
$(call header,$@)
env RUSTDOCFLAGS="-Dwarnings" cargo doc --all
env RUSTDOCFLAGS="-Dwarnings" cargo doc --all-features --no-deps
.PHONY: default--check-doc

## check-format: Checks all code formatting for the Rust crate
Expand Down

0 comments on commit efc9832

Please sign in to comment.