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

Update Docs and CI to note MSRV #355

Merged
merged 3 commits into from
Mar 26, 2022
Merged

Update Docs and CI to note MSRV #355

merged 3 commits into from
Mar 26, 2022

Conversation

josephlr
Copy link
Contributor

@josephlr josephlr commented Mar 26, 2022

This change updates our README to note what our Minimum Supported Rust Version (MSRV) is for each feature configuration. It also uses the rust-version cargo feature to make this information consumable by cargo.

Our MSRVs are:

  • not(instructions) and not(nightly) - Rust 1.57
  • instructions and not(nightly) - Rust 1.59
  • nightly - Rust Nightly (sufficiently recent)

I also updated some of our tests so that things would build/test on stable without errors or warnings. Finally, I updated the CI to actually test our MSRV (by moving some of our tests to a different "stable" job).

Signed-off-by: Joe Richey joerichey@google.com

@josephlr josephlr force-pushed the stable branch 6 times, most recently from 61316a8 to 072de2e Compare March 26, 2022 03:30
@josephlr josephlr requested review from Freax13 and phil-opp March 26, 2022 03:30
@josephlr josephlr marked this pull request as ready for review March 26, 2022 03:30
@josephlr josephlr changed the title ci: Check MSRV Update Docs and CI to note MSRV Mar 26, 2022
Copy link
Member

@Freax13 Freax13 left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@@ -1336,6 +1336,7 @@ macro_rules! set_general_handler_entry {
mod test {
use super::*;

#[allow(dead_code)]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#[allow(dead_code)]
#[cfg(not(windows))]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems like the downside here is that this change causes cargo test to emit warning on some of our runs, see https://github.com/rust-osdev/x86_64/runs/5705768152

I think it's easier to just have #[allow(dead_code)] then trying to keep the helper method's cfgs in sync with the test below.

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.

Looks good to me!

.github/workflows/build.yml Outdated Show resolved Hide resolved
Signed-off-by: Joe Richey <joerichey@google.com>
This uses the `rust-version` feature added in Rust 1.56

Signed-off-by: Joe Richey <joerichey@google.com>
Signed-off-by: Joe Richey <joerichey@google.com>
@josephlr josephlr force-pushed the stable branch 2 times, most recently from 27e726d to 43965df Compare March 26, 2022 21:30
@josephlr josephlr merged commit 3a16af0 into master Mar 26, 2022
@josephlr josephlr deleted the stable branch March 26, 2022 21:45
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.

3 participants