Skip to content

Commit

Permalink
Fix typos and bump version for typos ci (#2839)
Browse files Browse the repository at this point in the history
* chore: fix typo for InvalidSocketName

Signed-off-by: Jerrypoi <[email protected]>

* chore: fix typos

Signed-off-by: Jerrypoi <[email protected]>

* chore: bump typos version to catch more typos

Signed-off-by: Jerrypoi <[email protected]>

---------

Signed-off-by: Jerrypoi <[email protected]>
  • Loading branch information
Jerrypoi authored Jul 1, 2024
1 parent 155f6e6 commit a94a16c
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/basic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
- name: Install nightly rustfmt
run: rustup toolchain install nightly --component rustfmt --profile minimal --no-self-update
- name: typos-action
uses: crate-ci/typos@v1.14.12
uses: crate-ci/typos@v1.22.9
- name: Install just
uses: taiki-e/install-action@just
- name: Install cross-rs
Expand Down
4 changes: 4 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ clos = "clos"
Setted = "Setted"
hve = "hve"

[type.md.extend-words]
# This is used as "yoh-key" in markdown files to describe the pronounciation
# for Youki
"yoh" = "yoh"
2 changes: 1 addition & 1 deletion crates/libcgroups/src/v1/network_priority.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ mod tests {
use crate::test::set_fixture;

#[test]
fn test_apply_network_priorites() {
fn test_apply_network_priorities() {
let tmp = tempfile::tempdir().unwrap();
set_fixture(tmp.path(), "net_prio.ifpriomap", "").expect("set fixture for priority map");
let priorities = vec![
Expand Down
2 changes: 1 addition & 1 deletion crates/libcgroups/src/v2/memory.rs
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ mod tests {
};


// check the resevation file is set as expected
// check the reservation file is set as expected
let reservation_content = read_to_string(tmp.path().join(CGROUP_MEMORY_LOW)).expect("read memory reservation to string");
let reservation_check = match linux_memory.reservation() {
Some(reservation) if reservation == -1 => reservation_content == "max",
Expand Down
2 changes: 1 addition & 1 deletion crates/libcontainer/src/container/tenant_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ impl TenantContainerBuilder {
// `read_end` that the init process is able to move forward. Closing one
// end of the pipe will immediately signal the other end of the pipe,
// which we use in the init thread as a form of barrier. `drop` is used
// here becuase `OwnedFd` supports it, so we don't have to use `close`
// here because `OwnedFd` supports it, so we don't have to use `close`
// here with `RawFd`.
drop(write_end);

Expand Down
2 changes: 1 addition & 1 deletion crates/libcontainer/src/tty.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ pub enum TTYError {
linked: Box<PathBuf>,
console_socket_path: Box<PathBuf>,
},
#[error("invalid socker name: {socket_name:?}")]
#[error("invalid socket name: {socket_name:?}")]
InvalidSocketName {
socket_name: String,
source: nix::Error,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/community/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Youki follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob
# Maintainership

Youki is governed by Maintainers who are elected from active contributors.
Youki will remain [vendor-nutral](https://contribute.cncf.io/maintainers/community/vendor-neutrality/).
Youki will remain [vendor-neutral](https://contribute.cncf.io/maintainers/community/vendor-neutrality/).
Maintainers are [here](./maintainer.md).

## Roles
Expand Down
2 changes: 1 addition & 1 deletion docs/src/developer/e2e/test_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ This crate contains the testing framework specifically developed for porting the

By default the test groups are run in parallel using the [crossbeam crate](https://www.crates.io/crates/crossbeam), and the default test_group implementation also runs individual tests parallelly.

Sometimes you might need to run the tests in a test group serially or in certain order, for example in case of testing container lifecycle, a container must be created and started before stopping it. In such cases, you will need to implement the respective traits on your own structs, so that you can have fine control over thr running of tests. Check the readme of the test_framework crate to see the struct and trait documentation [here](https://github.com/containers/youki/tree/main/crates/test_framework).
Sometimes you might need to run the tests in a test group serially or in certain order, for example in case of testing container lifecycle, a container must be created and started before stopping it. In such cases, you will need to implement the respective traits on your own structs, so that you can have fine control over the running of tests. Check the readme of the test_framework crate to see the struct and trait documentation [here](https://github.com/containers/youki/tree/main/crates/test_framework).
2 changes: 1 addition & 1 deletion tests/contest/runtimetest/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ pub fn validate_sysctl(spec: &Spec) {
pub fn validate_scheduler_policy(spec: &Spec) {
let proc = spec.process().as_ref().unwrap();
let sc = proc.scheduler().as_ref().unwrap();
println!("schedul is {:?}", spec);
println!("schedule is {:?}", spec);
let size = mem::size_of::<nc::sched_attr_t>().try_into().unwrap();
let mut get_sched_attr = nc::sched_attr_t {
size: 0,
Expand Down

0 comments on commit a94a16c

Please sign in to comment.