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.

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

Add small doc-comment to entry_point! macro #220

Merged
merged 1 commit into from
Feb 3, 2022
Merged

Add small doc-comment to entry_point! macro #220

merged 1 commit into from
Feb 3, 2022

Conversation

georglauterbach
Copy link
Contributor

Without this change, clippy will complain

error: missing documentation for a function
  --> src/main.rs:60:1
   |
60 | bootloader::entry_point!(kernel_start);
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
note: the lint level is defined here
  --> src/main.rs:27:9
   |
27 | #![deny(missing_docs)]
   |         ^^^^^^^^^^^^
   = note: this error originates in the macro `bootloader::entry_point` (in Nightly builds, run with -Z macro-backtrace for more info)

error: could not compile `kernel` due to previous error

when using #![deny(clippy::cargo)] and I cannot compile my kernel.

Copy link
Member

@phil-opp phil-opp left a comment

Choose a reason for hiding this comment

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

Thanks!

@phil-opp phil-opp merged commit 06381af into rust-osdev:main Feb 3, 2022
@georglauterbach georglauterbach deleted the fix/comment-for-entry-macro branch February 3, 2022 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants