Philipp Schuster пре 2 година
родитељ
комит
8f83bf344b
5 измењених фајлова са 29 додато и 4 уклоњено
  1. 12 0
      .github/workflows/qa.yml
  2. 13 0
      .typos.toml
  3. 2 2
      multiboot2/src/lib.rs
  4. 1 1
      multiboot2/src/rsdp.rs
  5. 1 1
      multiboot2/src/vbe_info.rs

+ 12 - 0
.github/workflows/qa.yml

@@ -0,0 +1,12 @@
+name: QA
+
+on: [ push, pull_request ]
+
+jobs:
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      # Executes "typos ."
+      - uses: crate-ci/typos@v1.13.20

+ 13 - 0
.typos.toml

@@ -0,0 +1,13 @@
+# Configuration for the typos spell checker utility (<https://github.com/crate-ci/typos>).
+
+[files]
+extend-exclude = [
+    # "uefi/src/table/boot.rs"
+]
+
+[default.extend-words]
+Rela = "Rela"
+
+[default.extend-identifiers]
+# FOOBAR = "FOOBAR"
+

+ 2 - 2
multiboot2/src/lib.rs

@@ -108,7 +108,7 @@ pub const MULTIBOOT2_BOOTLOADER_MAGIC: u32 = 0x36d76289;
 ///   environment (segfault) but also in UEFI-applications, where the referenced
 ///   memory is not (identity) mapped (UEFI does only identity mapping).
 /// * The memory at `address` must not be modified after calling `load` or the
-///   program may observe unsychronized mutation.
+///   program may observe unsynchronized mutation.
 pub unsafe fn load(address: usize) -> Result<BootInformation, MbiLoadError> {
     load_with_offset(address, 0)
 }
@@ -131,7 +131,7 @@ pub unsafe fn load(address: usize) -> Result<BootInformation, MbiLoadError> {
 ///   environment (segfault) but also in UEFI-applications, where the referenced
 ///   memory is not (identity) mapped (UEFI does only identity mapping).
 /// * The memory at `address` must not be modified after calling `load` or the
-///   program may observe unsychronized mutation.
+///   program may observe unsynchronized mutation.
 pub unsafe fn load_with_offset(
     address: usize,
     offset: usize,

+ 1 - 1
multiboot2/src/rsdp.rs

@@ -29,7 +29,7 @@ pub struct RsdpV1Tag {
 }
 
 impl RsdpV1Tag {
-    /// The "RSD PTR " marker singature.
+    /// The "RSD PTR " marker signature.
     ///
     /// This is originally a 8-byte C string (not null terminated!) that must contain "RSD PTR "
     pub fn signature(&self) -> Result<&str, Utf8Error> {

+ 1 - 1
multiboot2/src/vbe_info.rs

@@ -233,7 +233,7 @@ impl fmt::Debug for VBEModeInfo {
 
 /// A VBE colour field.
 ///
-/// Descirbes the size and position of some colour capability.
+/// Describes the size and position of some colour capability.
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[repr(C, packed)]
 pub struct VBEField {