Skip to content

Commit a52f47f

Browse files
Remove draft status from kernel build documentation and improve clarity in usage instructions
1 parent 70da33f commit a52f47f

3 files changed

Lines changed: 33 additions & 12 deletions

File tree

content/learning-paths/servers-and-cloud-computing/kernel-build/_index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
title: Build Linux kernels for Arm cloud instances
33

4-
draft: true
5-
cascade:
6-
draft: true
7-
84
minutes_to_complete: 60
95

106
who_is_this_for: This is an advanced topic for software developers building custom Linux kernels on Arm servers and cloud instances.

content/learning-paths/servers-and-cloud-computing/kernel-build/how-to-1.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ The repository you just cloned contains helper scripts for building and managing
4444

4545
The `kernel_build_and_install.sh` script supports two main workflows:
4646

47-
1. **General usage** - Build kernels for direct installation or downstream packaging
48-
2. **Fastpath usage** - Build kernels with additional headers and perf configuration needed by the Fastpath validation tool
47+
- **General usage** - Build kernels for direct installation or downstream packaging
48+
- **Fastpath usage** - Build kernels with additional headers and perf configuration needed by the Fastpath validation tool
4949

5050
### About Fastpath
5151

@@ -90,6 +90,29 @@ Check that the script is executable and displays help information:
9090
./scripts/kernel_build_and_install.sh --help
9191
```
9292

93-
The expected output shows all available flags and usage examples.
93+
The expected output is similar to:
94+
95+
```output
96+
Usage: kernel_build_and_install.sh [OPTIONS]
97+
98+
Options:
99+
--demo-default-build Build v6.18.1 with default configuration
100+
--demo-fastpath-build Build v6.18.1 and v6.19-rc1 with Fastpath configs
101+
--tag <tag> Specify a kernel version to build
102+
--tags <tag1,tag2,...> Build multiple kernel versions in parallel
103+
--kernel-install [true|false|tag] Install kernel after building
104+
--fastpath [true|false] Enable Fastpath configuration overlay
105+
--change-to-64k [true|false] Build kernel with 64 KB page size
106+
--help Display this help message
107+
...
108+
```
109+
110+
## What you've accomplished and what's next
111+
112+
In this section, you've:
113+
- Configured an Arm cloud instance with the required build dependencies
114+
- Cloned the kernel build helper repository
115+
- Learned about the available build script flags for general and Fastpath workflows
116+
- Verified your build environment is ready
94117

95-
You're now ready to build Linux kernels on your Arm instance. The next section covers standard kernel build workflows.
118+
The next section covers standard kernel build workflows for direct installation or downstream packaging.

content/learning-paths/servers-and-cloud-computing/kernel-build/how-to-2.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ This section covers standard kernel build workflows for direct installation or d
1313
## Kernel Build only
1414

1515
{{% notice Note %}}
16-
The kernel versions given in the \--tags flag, such as `v6.18.1` in the first example below, are arbitrary (but valid) Linux kernel versions; If you prefer to use kernel versions different from the examples, its ok to replace it with your alternative.
16+
The kernel versions given in the \--tags flag, such as `v6.18.1` in the first example below, are arbitrary (but valid) Linux kernel versions. If you prefer to use kernel versions different from the examples, you can replace them with your preferred versions.
1717

18-
Kernel.org hosts all official Linux kernel releases: https://www.kernel.org/. Feel free to browse and select any stable or mainline release version depicted.
18+
Kernel.org hosts all official Linux kernel releases: https://www.kernel.org/. Browse and select any stable or mainline release version.
1919
{{% /notice %}}
2020

2121

@@ -65,12 +65,14 @@ This command writes a self-contained plan such as `/tmp/kernel_plan_v6.18.1_<has
6565
--dry-run
6666
```
6767

68-
Run the plan file later—on the same host or another system with the required dependencies—to replay the exact workflow:
68+
Run the plan file later—on the same host or another system with the required dependencies—to replay the exact workflow. Replace `<hash>` with the actual hash value from your generated plan file:
6969

7070
```bash
7171
bash /tmp/kernel_plan_v6.18.1_<hash>.sh
7272
```
7373

74+
You can use tab completion or `ls /tmp/kernel_plan_*.sh` to find the exact filename.
75+
7476
## Kernel Install
7577

7678
{{% notice Note %}}
@@ -156,7 +158,7 @@ The expected output is `65536` for 64 KB builds, compared to `4096` for standard
156158

157159
### Install previously built kernels
158160

159-
As there are two input formats for building kernel artifacts which match the build output formats: flat files and Debian packages. Choose the appropriate installation method based on your prior build format.
161+
There are two input formats for kernel artifacts that match the build output formats: flat files and Debian packages. Choose the appropriate installation method based on your prior build format.
160162

161163
#### Flat-file installation
162164

0 commit comments

Comments
 (0)