Skip to content

Add small doc-comment to entry_point! macro - #220

Merged
phil-opp merged 1 commit into
rust-osdev:mainfrom
georglauterbach:fix/comment-for-entry-macro
Feb 3, 2022
Merged

Add small doc-comment to entry_point! macro#220
phil-opp merged 1 commit into
rust-osdev:mainfrom
georglauterbach:fix/comment-for-entry-macro

Conversation

@georglauterbach

Copy link
Copy Markdown
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.

@phil-opp phil-opp left a comment

Copy link
Copy Markdown
Member

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 enabled auto-merge February 3, 2022 11:40
@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