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

Jump to bottom

Enforce doc warnings. #1862

Merged
merged 3 commits into from May 19, 2020
Merged

Enforce doc warnings. #1862

merged 3 commits into from May 19, 2020

Conversation

gendx
Copy link
Contributor

@gendx gendx commented May 19, 2020

Pull Request Overview

This pull request fixes #1334.

To work around rust-lang/rust#62184, a cfg_attr attribute is added to disable no_main when cfg(doc) is active.

Testing Strategy

This pull request was tested by running make ci-netlify locally, and observing that warnings are indeed denied, for example when putting back the original #![no_main] in one of the boards.

TODO or Help Wanted

N/A

Documentation Updated

  • Updated the relevant files in /docs, or no updates are required.

Formatting

  • Ran make format.
  • Fixed errors surfaced by make clippy.

@gendx gendx mentioned this pull request May 19, 2020
Closed
3 tasks
ppannuto
ppannuto approved these changes May 19, 2020
View reviewed changes
Copy link
Member

@ppannuto ppannuto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors r+

This has been on my wishlist for a long time. It's sad to add a cfg, but it's contained, clearly documented, and working around a rust bug that will eventually go away.

@bors
Copy link
Contributor

bors bot commented May 19, 2020

Build succeeded:

@bors bors bot merged commit 2466eae into tock:master May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ppannuto ppannuto ppannuto approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Tracking: Deny warnings for documentation builds
2 participants
@gendx @ppannuto