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

Ensure lib.rs code example in uefi crate is tested #1337

Closed
nicholasbishop opened this issue Aug 20, 2024 · 1 comment
Closed

Ensure lib.rs code example in uefi crate is tested #1337

nicholasbishop opened this issue Aug 20, 2024 · 1 comment

Comments

@nicholasbishop
Copy link
Member

We tried to use #![doc = include_str!("../../template/src/main.rs")], but that is causing the release job to fail: #1330 (comment)

As a quick workaround we will inline the example code, but that means it won't be tested and could break easily. Filing this issue to track fixing it.
nicholasbishop added a commit to nicholasbishop/uefi-rs that referenced this issue Aug 20, 2024
@nicholasbishop
uefi: Inline the template example into lib.rs doc
a7332fb 
This include is blocking the release job:
rust-osdev#1330 (comment)

For now, just inline the example so that we can release. Filed
rust-osdev#1337 to track a better fix.
@nicholasbishop nicholasbishop mentioned this issue Aug 20, 2024
Merged
2 tasks
@nicholasbishop
Copy link
Member Author

Fixed in #1353

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nicholasbishop