From 6e20bf37b88767dc04489a35c1a1ef1041059382 Mon Sep 17 00:00:00 2001 From: Emanuele Aina Date: Thu, 30 Dec 2021 23:46:12 +0100 Subject: [PATCH] style(spelling): Spellcheck the docs Signed-off-by: Emanuele Aina --- docs/src/developer/libcgroups.md | 2 +- docs/src/developer/libcontainer.md | 2 +- docs/src/developer/youki.md | 2 +- docs/src/user/basic_setup.md | 2 +- docs/src/youki.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/developer/libcgroups.md b/docs/src/developer/libcgroups.md index dc26c42592..5c3c508370 100644 --- a/docs/src/developer/libcgroups.md +++ b/docs/src/developer/libcgroups.md @@ -9,7 +9,7 @@ This crates exposes several functions and modules that can be used to work with - common traits and functions which are used by both v1 and v2 such as - Trait CgroupManager, this abstracts over the underlying implementation of interacting with specific version of cgroups, and gives functions to add certain process to a certain cgroup, apply resource restrictions, get statistics of a cgroups, freeze a cgroup, remove a cgroup or get list of all processes belonging to a cgroup. v1 and v2 modules both contain a version specific cgroup manager which implements this trait, and thus either can be given to functions or structs which expects a cgroup manager, depending on which cgroups the host system uses. - - Apart from the trait, this also contians functions which help with reading cgroups files, and write data to a cgroup file, which are used throughout this crate. + - Apart from the trait, this also contains functions which help with reading cgroups files, and write data to a cgroup file, which are used throughout this crate. - A function to detect which cgroup setup (v1, v2 or hybrid) is on the host system, as well as a function to get the corresponding cgroups manager. - Functions and structs to get and store the statistics of a cgroups such as diff --git a/docs/src/developer/libcontainer.md b/docs/src/developer/libcontainer.md index 610ce07dd1..8e89b50969 100644 --- a/docs/src/developer/libcontainer.md +++ b/docs/src/developer/libcontainer.md @@ -16,7 +16,7 @@ This crate also provides an interface for Apparmor which is another Linux Kernel - rootfs, which is a ramfs like simple filesystem used by kernel during initialization - hooks, which allow running of specified program at certain points in the container lifecycle, such as before and after creation, start etc. -- singals, which provide a wrapper to convert to and from signal numbers and text representation of signal names +- signals, which provide a wrapper to convert to and from signal numbers and text representation of signal names - capabilities, which has functions related to set and reset specific capabilities, as well as to drop extra privileges - [Simple explanation of capabilities](https://blog.container-solutions.com/linux-capabilities-in-practice) - [man page for capabilities](https://man7.org/linux/man-pages/man7/capabilities.7.html) diff --git a/docs/src/developer/youki.md b/docs/src/developer/youki.md index e3432b38a4..ac386547b4 100644 --- a/docs/src/developer/youki.md +++ b/docs/src/developer/youki.md @@ -1,6 +1,6 @@ # youki -This is the core crate that contains the youki binary itself. This provides the user interface, as well as binds the ther crates together to actually perform the work of creation and management of containers. THus this provides implementation of all the commands supported by youki. +This is the core crate that contains the youki binary itself. This provides the user interface, as well as binds the other crates together to actually perform the work of creation and management of containers. THus this provides implementation of all the commands supported by youki. The simple control flow of youki can be explained as : diff --git a/docs/src/user/basic_setup.md b/docs/src/user/basic_setup.md index 2bc748b174..93bd381765 100644 --- a/docs/src/user/basic_setup.md +++ b/docs/src/user/basic_setup.md @@ -2,7 +2,7 @@ This explains the requirements for compiling Youki as a binary, to use it as a low-level container runtime, or to depend once of its crates as dependency for your own project. -Youki currently only supports Linux Platfrom, and to use it on other platform you will need to use some kind of virtualization. The repo itself provides Vagrantfile that provides basic setup to use Youki on non-Linux system using Vagrant. The last sub-section explains using this vagrantfile. +Youki currently only supports Linux Platform, and to use it on other platform you will need to use some kind of virtualization. The repo itself provides Vagrantfile that provides basic setup to use Youki on non-Linux system using Vagrant. The last sub-section explains using this vagrantfile. Also note that Youki currently only supports and expects systemd as init system, and would not work on other systems. There is currently work on-going to put systemd dependent features behind a feature flag, but till then you will need a systemd enabled system to work with Youki. diff --git a/docs/src/youki.md b/docs/src/youki.md index 6fd7749b83..60d0a3edc3 100644 --- a/docs/src/youki.md +++ b/docs/src/youki.md @@ -31,7 +31,7 @@ Here is why we are writing a new container runtime in Rust. ```console $ hyperfine --prepare 'sudo sync; echo 3 | sudo tee /proc/sys/vm/drop_caches' --warmup 10 --min-runs 100 'sudo ./youki create -b tutorial a && sudo ./youki start a && sudo ./youki delete -f a' ``` - - Enviroment + - Environment `console $ ./youki info Version 0.0.1 Kernel-Release 5.11.0-41-generic Kernel-Version #45-Ubuntu SMP Fri Nov 5 11:37:01 UTC 2021 Architecture x86_64 Operating System Ubuntu 21.04 Cores 12 Total Memory 32025 Cgroup setup hybrid Cgroup mounts blkio /sys/fs/cgroup/blkio cpu /sys/fs/cgroup/cpu,cpuacct cpuacct /sys/fs/cgroup/cpu,cpuacct cpuset /sys/fs/cgroup/cpuset devices /sys/fs/cgroup/devices freezer /sys/fs/cgroup/freezer hugetlb /sys/fs/cgroup/hugetlb memory /sys/fs/cgroup/memory net_cls /sys/fs/cgroup/net_cls,net_prio net_prio /sys/fs/cgroup/net_cls,net_prio perf_event /sys/fs/cgroup/perf_event pids /sys/fs/cgroup/pids unified /sys/fs/cgroup/unified CGroup v2 controllers cpu detached cpuset detached hugetlb detached io detached memory detached pids detached device attached Namespaces enabled mount enabled uts enabled ipc enabled user enabled pid enabled network enabled cgroup enabled $ ./youki --version youki version 0.0.1 commit: 0.0.1-0-0be33bf $ runc -v runc version 1.0.0-rc93 commit: 12644e614e25b05da6fd08a38ffa0cfe1903fdec spec: 1.0.2-dev go: go1.13.15 libseccomp: 2.5.1 $ crun --version crun version 0.19.1.45-4cc7 commit: 4cc7fa1124cce75dc26e12186d9cbeabded2b710 spec: 1.0.0 +SYSTEMD +SELINUX +APPARMOR +CAP +SECCOMP +EBPF +CRIU +YAJL `