From 0f2e94b4c051dabd331a49d4a69261732318d8e7 Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Wed, 7 Sep 2022 11:11:43 +0200 Subject: [PATCH 1/2] rustdoc cleanup: use rustdoc attribute --- .github/workflows/rust.yml | 2 +- src/lib.rs | 4 ++++ uefi-macros/src/lib.rs | 6 ++++++ uefi-services/src/lib.rs | 4 ++++ xtask/src/cargo.rs | 7 ++----- 5 files changed, 17 insertions(+), 6 deletions(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 253e34377..bc326f7a8 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -117,7 +117,7 @@ jobs: cargo xtask clippy --warnings-as-errors - name: Run cargo doc - run: cargo xtask doc --warnings-as-errors + run: cargo xtask doc miri: name: Run unit tests and doctests under Miri diff --git a/src/lib.rs b/src/lib.rs index 510e63756..b4f7f0f98 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -33,6 +33,10 @@ // Enable some additional warnings and lints. #![warn(clippy::ptr_as_ptr, missing_docs, unused)] #![deny(clippy::all)] +#![deny(rustdoc::all)] +// todo remove once https://github.com/rust-lang/rust/issues/101730 is stable +#![feature(rustdoc_missing_doc_code_examples)] +#![allow(rustdoc::missing_doc_code_examples)] // `uefi-exts` requires access to memory allocation APIs. #[cfg(feature = "exts")] diff --git a/uefi-macros/src/lib.rs b/uefi-macros/src/lib.rs index 38717dfdb..19ac34318 100644 --- a/uefi-macros/src/lib.rs +++ b/uefi-macros/src/lib.rs @@ -1,4 +1,10 @@ #![recursion_limit = "128"] +#![deny(rustdoc::all)] +// todo remove once https://github.com/rust-lang/rust/issues/101730 is stable +#![feature(rustdoc_missing_doc_code_examples)] +#![allow(rustdoc::missing_doc_code_examples)] + +//! Code generation macros for the `uefi` crate. extern crate proc_macro; diff --git a/uefi-services/src/lib.rs b/uefi-services/src/lib.rs index a352834ba..b9f9cc17d 100644 --- a/uefi-services/src/lib.rs +++ b/uefi-services/src/lib.rs @@ -19,6 +19,10 @@ #![no_std] #![feature(alloc_error_handler)] #![feature(abi_efiapi)] +#![deny(rustdoc::all)] +// todo remove once https://github.com/rust-lang/rust/issues/101730 is stable +#![feature(rustdoc_missing_doc_code_examples)] +#![allow(rustdoc::missing_doc_code_examples)] #[macro_use] extern crate log; diff --git a/xtask/src/cargo.rs b/xtask/src/cargo.rs index 38bf38f5f..ed7c0f715 100644 --- a/xtask/src/cargo.rs +++ b/xtask/src/cargo.rs @@ -146,9 +146,6 @@ impl Cargo { } CargoAction::Doc { open } => { action = "doc"; - if self.warnings_as_errors { - cmd.env("RUSTDOCFLAGS", "-Dwarnings"); - } if open { extra_args.push("--open"); } @@ -237,11 +234,11 @@ mod tests { packages: vec![Package::Uefi, Package::Xtask], release: false, target: None, - warnings_as_errors: true, + warnings_as_errors: false, }; assert_eq!( command_to_string(&cargo.command().unwrap()), - "RUSTDOCFLAGS=-Dwarnings cargo doc --package uefi --package xtask --features alloc --open" + "cargo doc --package uefi --package xtask --features alloc --open" ); } } From 75d74ac2a1f74ce88a39cc5c8e9fe6b46ed77dbb Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Mon, 26 Sep 2022 13:02:00 +0200 Subject: [PATCH 2/2] bump msrv --- .github/workflows/msrv_toolchain.toml | 2 +- CHANGELOG.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/msrv_toolchain.toml b/.github/workflows/msrv_toolchain.toml index 640fc4616..555563a42 100644 --- a/.github/workflows/msrv_toolchain.toml +++ b/.github/workflows/msrv_toolchain.toml @@ -1,4 +1,4 @@ [toolchain] # Oldest nightly that currently works with `cargo xtask build`. -channel = "nightly-2022-04-18" +channel = "nightly-2022-09-14" components = ["rust-src"] diff --git a/CHANGELOG.md b/CHANGELOG.md index 03bea327d..3642f0d0b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ - Fixed the definition of `AllocateType` so that `MaxAddress` and `Address` always take a 64-bit value, regardless of target platform. +- The MSRV is `nightly-2022-09-14` (`1.65.0`) ## uefi-macros - [Unreleased]