From 07eda731f6f26aaad285333f81fb29d6f97a6563 Mon Sep 17 00:00:00 2001 From: Emma Anholt Date: Sun, 22 Sep 2024 19:54:37 -0700 Subject: [PATCH] docs: Fix minor spelling and grammar issues --- Documentation/architecture.md | 2 +- Documentation/environments/digitalocean.md | 6 +++--- Documentation/kernel-parameters.md | 2 +- Documentation/logging.md | 2 +- Documentation/quickstart.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/architecture.md b/Documentation/architecture.md index d7ba92ae..08ff1e4f 100644 --- a/Documentation/architecture.md +++ b/Documentation/architecture.md @@ -6,7 +6,7 @@ The following figure shows some important kernel objects and their relationships ![Architecture](architecture.svg) ## Process -A `Process` object represents both of kernel/user threads and user processes. +A `Process` object represents both kernel/user threads and user processes. In addition to the execution context (`arch::Thread`) which holds such as the CPU registers, `Process` holds some references to shared resources like opened files, memory address space, signal-related information, etc. diff --git a/Documentation/environments/digitalocean.md b/Documentation/environments/digitalocean.md index f23dc4d5..82c6a22b 100644 --- a/Documentation/environments/digitalocean.md +++ b/Documentation/environments/digitalocean.md @@ -1,11 +1,11 @@ # DigitalOcean -## Obvervations +## Observations - Two virtio-net (legacy) devices are attached. For public IP address and private network respectively. - The disk will be attached as a virtio-blk (legacy) device. -- DHCP is available if a custom image for `Unknown OS` is uased. - - It's disabled for Droplets using major operating system like Ubuntu and FreeBSD. +- DHCP is available if a custom image for `Unknown OS` is used. + - It's disabled for Droplets using major operating systems like Ubuntu and FreeBSD. - No serial port support. - You can see the kernel messages from *Recovery Console*. diff --git a/Documentation/kernel-parameters.md b/Documentation/kernel-parameters.md index 2beab440..e7d9ed86 100644 --- a/Documentation/kernel-parameters.md +++ b/Documentation/kernel-parameters.md @@ -27,7 +27,7 @@ make run CMDLINE="dhcp=off" ### GRUB2 -In GRUB2, use append kernel parameters after the kernel image path: +In GRUB2, append kernel parameters after the kernel image path: ``` menuentry "Kerla" { diff --git a/Documentation/logging.md b/Documentation/logging.md index c24ea45b..c362f690 100644 --- a/Documentation/logging.md +++ b/Documentation/logging.md @@ -1,6 +1,6 @@ # Logging -By default, the kernel don't print `trace!` and `debug!` log messages. +By default, the kernel doesn't print `trace!` or `debug!` log messages. Similar to `$RUST_LOG`, Kerla supports controlling logging through `LOG=` argument in a `make` command: diff --git a/Documentation/quickstart.md b/Documentation/quickstart.md index 2f428ce7..8c762e5f 100644 --- a/Documentation/quickstart.md +++ b/Documentation/quickstart.md @@ -1,7 +1,7 @@ # Quickstart ### Prerequisites -Make sure you the following softwares are installed: +Make sure the following software is installed: - Rust toolchain (nightly) - Use [rustup](https://rustup.rs/) to install - [cargo-binutils](https://crates.io/crates/cargo-binutils) and [rustfilt](https://crates.io/crates/rustfilt) crates @@ -43,7 +43,7 @@ $ make run GDB=1 # Run on QEMU with GDB connection enabled (listens on loca ``` ### Running OS on QEMU -Once you boot the OS by `make run`, a Busybox shell shows up in your terminal. +Once you boot the OS with `make run`, a Busybox shell shows up in your terminal. The terminal running QEMU emulates a serial port connected to Kerla. What you type on the terminal will be sent to the Kerla and the foreground process.