Skip to content

Commit 8f83bf3

Browse files
committed
ci: add "typos"
1 parent fd8e694 commit 8f83bf3

File tree

5 files changed

+29
-4
lines changed

5 files changed

+29
-4
lines changed

.github/workflows/qa.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: QA
2+
3+
on: [ push, pull_request ]
4+
5+
jobs:
6+
spellcheck:
7+
name: Spellcheck
8+
runs-on: ubuntu-22.04
9+
steps:
10+
- uses: actions/checkout@v3
11+
# Executes "typos ."
12+
- uses: crate-ci/[email protected]

.typos.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Configuration for the typos spell checker utility (<https://github.com/crate-ci/typos>).
2+
3+
[files]
4+
extend-exclude = [
5+
# "uefi/src/table/boot.rs"
6+
]
7+
8+
[default.extend-words]
9+
Rela = "Rela"
10+
11+
[default.extend-identifiers]
12+
# FOOBAR = "FOOBAR"
13+

multiboot2/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ pub const MULTIBOOT2_BOOTLOADER_MAGIC: u32 = 0x36d76289;
108108
/// environment (segfault) but also in UEFI-applications, where the referenced
109109
/// memory is not (identity) mapped (UEFI does only identity mapping).
110110
/// * The memory at `address` must not be modified after calling `load` or the
111-
/// program may observe unsychronized mutation.
111+
/// program may observe unsynchronized mutation.
112112
pub unsafe fn load(address: usize) -> Result<BootInformation, MbiLoadError> {
113113
load_with_offset(address, 0)
114114
}
@@ -131,7 +131,7 @@ pub unsafe fn load(address: usize) -> Result<BootInformation, MbiLoadError> {
131131
/// environment (segfault) but also in UEFI-applications, where the referenced
132132
/// memory is not (identity) mapped (UEFI does only identity mapping).
133133
/// * The memory at `address` must not be modified after calling `load` or the
134-
/// program may observe unsychronized mutation.
134+
/// program may observe unsynchronized mutation.
135135
pub unsafe fn load_with_offset(
136136
address: usize,
137137
offset: usize,

multiboot2/src/rsdp.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ pub struct RsdpV1Tag {
2929
}
3030

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

multiboot2/src/vbe_info.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ impl fmt::Debug for VBEModeInfo {
233233

234234
/// A VBE colour field.
235235
///
236-
/// Descirbes the size and position of some colour capability.
236+
/// Describes the size and position of some colour capability.
237237
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
238238
#[repr(C, packed)]
239239
pub struct VBEField {

0 commit comments

Comments
 (0)