Skip to content

Commit 89fc547

Browse files
kalyazinclaude
andcommitted
style: wrap README lines to 80 columns
Reflow prose paragraphs and bullet items to ≤80 columns. No content changes; code blocks and URLs are left intact (the markdown link to model.go remains on a single line). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Nikita Kalyazin <nikita.kalyazin@e2b.dev>
1 parent 91a9be5 commit 89fc547

1 file changed

Lines changed: 26 additions & 10 deletions

File tree

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Overview
44

5-
This project automates the building of custom Linux kernels for Firecracker microVMs, using the same kernel sources as official Firecracker repo and custom configuration files. It supports building specific kernel versions and uploading the resulting binaries to a Google Cloud Storage (GCS) bucket.
5+
This project automates the building of custom Linux kernels for Firecracker
6+
microVMs, using the same kernel sources as official Firecracker repo and
7+
custom configuration files. It supports building specific kernel versions
8+
and uploading the resulting binaries to a Google Cloud Storage (GCS) bucket.
69

710
## Prerequisites
811

@@ -11,31 +14,44 @@ This project automates the building of custom Linux kernels for Firecracker micr
1114
## Building Kernels
1215

1316
1. **Configure kernel versions:**
14-
- Edit `kernel_versions.txt` to specify which kernel versions to build (one per line, e.g., `6.1.102`).
15-
- Place the corresponding config file in `configs/` (e.g., `configs/6.1.102.config`).
17+
- Edit `kernel_versions.txt` to specify which kernel versions to build
18+
(one per line, e.g., `6.1.102`).
19+
- Place the corresponding config file in `configs/` (e.g.,
20+
`configs/6.1.102.config`).
1621

1722
2. **Build:**
1823
```sh
1924
make build
2025
# or directly
2126
./build.sh
2227
```
23-
The built kernels will be placed in `builds/vmlinux-<version>/<arch>/vmlinux.bin` where `<arch>` is `amd64` or `arm64` (Go/OCI convention). For x86_64 backward compatibility, a legacy copy is also placed at `builds/vmlinux-<version>/vmlinux.bin`.
28+
The built kernels will be placed in
29+
`builds/vmlinux-<version>/<arch>/vmlinux.bin` where `<arch>` is `amd64`
30+
or `arm64` (Go/OCI convention). For x86_64 backward compatibility, a
31+
legacy copy is also placed at `builds/vmlinux-<version>/vmlinux.bin`.
2432

2533
## Development Workflow
26-
- On every push, GitHub Actions will automatically build the kernels and save it as an artifact.
34+
- On every push, GitHub Actions will automatically build the kernels and
35+
save it as an artifact.
2736

2837
## Architecture naming
2938

30-
Output directories use Go's `runtime.GOARCH` convention (`amd64`, `arm64`) so they match the infra orchestrator's `TargetArch()` path resolution. The build-time variable `TARGET_ARCH` (`x86_64`, `arm64`) is only used internally for config paths and cross-compilation flags.
39+
Output directories use Go's `runtime.GOARCH` convention (`amd64`, `arm64`)
40+
so they match the infra orchestrator's `TargetArch()` path resolution. The
41+
build-time variable `TARGET_ARCH` (`x86_64`, `arm64`) is only used
42+
internally for config paths and cross-compilation flags.
3143

3244
## New Kernel in E2B's infra
33-
_Note: these steps should give you new kernel on your self-hosted E2B using https://github.com/e2b-dev/infra_
45+
_Note: these steps should give you new kernel on your self-hosted E2B using
46+
https://github.com/e2b-dev/infra_
3447

35-
- Copy the kernel build in your project's object storage under `e2b-*-fc-kernels`
36-
- In [packages/api/internal/cfg/model.go](https://github.com/e2b-dev/infra/blob/main/packages/api/internal/cfg/model.go) update `DefaultKernelVersion`
48+
- Copy the kernel build in your project's object storage under
49+
`e2b-*-fc-kernels`
50+
- In [packages/api/internal/cfg/model.go](https://github.com/e2b-dev/infra/blob/main/packages/api/internal/cfg/model.go)
51+
update `DefaultKernelVersion`
3752
- Build and deploy `api`
3853

3954
## License
4055

41-
This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
56+
This project is licensed under the Apache License 2.0.
57+
See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)