From 7e046061bdde1292736c0cf237275510ef842480 Mon Sep 17 00:00:00 2001 From: kadiwa Date: Thu, 28 Sep 2023 11:09:21 +0200 Subject: [PATCH] add description remove old version of actions/checkout --- .github/workflows/check.yml | 6 +++--- Cargo.toml | 1 + license.txt => LICENSE-MIT | 4 ---- readme.md | 3 +-- src/lib.rs | 4 ++-- tests/test.rs | 2 +- 6 files changed, 8 insertions(+), 12 deletions(-) rename license.txt => LICENSE-MIT (95%) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 4487279..c1226e8 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -15,7 +15,7 @@ jobs: - uses: actions/checkout@v4 with: show-progress: false - - name: Install MIRI + - name: Install Miri run: | rustup toolchain install nightly --profile minimal -c miri,rust-src cargo +nightly miri setup @@ -25,7 +25,7 @@ jobs: run: cargo clippy --all-features - name: Run tests run: cargo test --all-features - - name: Run tests with MIRI + - name: Run tests with Miri run: cargo +nightly miri test --all-features check-specific-features: @@ -34,7 +34,7 @@ jobs: matrix: features: ["", "alloc derive"] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Run Clippy run: cargo clippy -F "${{ matrix.features }}" - name: Run tests diff --git a/Cargo.toml b/Cargo.toml index 287f23e..3d4dad1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,7 @@ name = "devicetree" version = "0.0.1" edition = "2021" rust-version = "1.65" +description = "efficient `#![no_std]` parser for devicetree blobs" license = "MIT" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/license.txt b/LICENSE-MIT similarity index 95% rename from license.txt rename to LICENSE-MIT index 8b0127b..969d061 100644 --- a/license.txt +++ b/LICENSE-MIT @@ -1,7 +1,3 @@ -MIT License - -Copyright 2023 Kalle Wachsmuth - Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights diff --git a/readme.md b/readme.md index 95ca5b3..d857056 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,6 @@ # Rust crate `devicetree` -Parser for devicetree blobs compliant (hopefully) with version 0.4 of -[the specification][spec]. +Efficient `#![no_std]` parser for devicetree blobs compliant (hopefully) with version 0.4 of [the specification][spec]. This is in an early stage of development. Use [`fdt-rs`](https://lib.rs/crates/fdt-rs) instead. diff --git a/src/lib.rs b/src/lib.rs index 17eed74..cb37f12 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,5 @@ -//! Parser for devicetree blobs compliant (hopefully) with version 0.4 of -//! [the specification][spec]. +//! Efficient `#![no_std]` parser for devicetree blobs compliant (hopefully) +//! with version 0.4 of [the specification][spec]. //! //! [spec]: https://www.devicetree.org/specifications diff --git a/tests/test.rs b/tests/test.rs index 5a52220..82c2cda 100644 --- a/tests/test.rs +++ b/tests/test.rs @@ -132,7 +132,7 @@ fn build() { } #[test] -#[cfg_attr(miri, ignore)] // MIRI warns on pointer provenance violations +#[cfg_attr(miri, ignore)] // miri warns on pointer provenance violations fn from_ptr() { let original = dt(); let from_ptr = unsafe {