Skip to content

Commit

Permalink
docs: Fix minor spelling and grammar issues (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
anholt authored Oct 2, 2024
1 parent 9816b67 commit b4e332f
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Documentation/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions Documentation/environments/digitalocean.md
Original file line number Diff line number Diff line change
@@ -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*.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/kernel-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand Down
2 changes: 1 addition & 1 deletion Documentation/logging.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
4 changes: 2 additions & 2 deletions Documentation/quickstart.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit b4e332f

Please sign in to comment.