Skip to content

docs: fix typos in PREFIX.md and ci-automation README #4269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
magic-peach wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos in PREFIX.md and ci-automation README #4269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions PREFIX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Path to stabilisation TODO list

Before prefix build support are considered stable, the below must be implemented:
Before prefix build support is considered stable, the below must be implemented:
1. Integrate `cb-bootstrap` with the Flatcar SDK.
Currently, `setup_prefix` uses cross-boss' `cb-bootstrap` to set up the prefix environment.
Bootstrapping must be fully integrated with the Flatcar SDK before prefix builds are considered stable.
Expand Down Expand Up @@ -51,7 +51,7 @@ Cross-boss location can be customised via the `--cross_boss_root` option to `set
## Quick-start guide

For working with a prefix, you will need to agree on:
1. A name for the prefix. Should be a single word and is used for generating protage wrappers.
1. A name for the prefix. Should be a single word and is used for generating portage wrappers.
2. A prefix directory where applications and libraries will live on the target system.
For use with systemd-sysext this should be a path below `/usr` or `/opt`.

Expand Down
6 changes: 3 additions & 3 deletions ci-automation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Please refer to the individual scripts for prerequisites, input parameters, and

The build pipeline can be used to build everything from scratch, including the SDK (starting from 1. below) or to build a new OS image (starting from 3.).
"From scratch" builds (i.e. builds which include a new SDK) are usually only done for the `main` branch (`main` can be considered `alpha-next`).
Release / maintenance branches in the majority of cases do note build a new SDK but start with the OS image build.
Release / maintenance branches in the majority of cases do not build a new SDK but start with the OS image build.
Release branches usually use the SDK introduced when the new major version was branched off `main` throughout the lifetime of the major version; i.e. release `stable-MMMM.mm.pp` would use `SDK-MMMM.0.0`.

To reproduce any given build step, follow this pattern:
Expand Down Expand Up @@ -165,5 +165,5 @@ It is recommended to stop firewalling on the host the tests are run on (for exam

* `QEMU_IMAGE_NAME` - file name of the QEmu image to fetch from bincache.
* `QEMU_PARALLEL` - Number of parallel test cases to run.
Note that test cases may involve launching mutliple QEmu VMs (network testing etc.).
Tests are memory bound, not CPU bound; e.g. `20` is a sensible value for a 6 core / 12 threads systwem w/ 32 GB RAM.
Note that test cases may involve launching multiple QEmu VMs (network testing etc.).
Tests are memory bound, not CPU bound; e.g. `20` is a sensible value for a 6 core / 12 threads system w/ 32 GB RAM.