From 38aa271b9cf0106bd4adcfc0895df36c18359f13 Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Wed, 1 May 2019 15:40:42 +0100 Subject: [PATCH 1/4] kernel: Note prereqs in document Note that to use the build script you need to have some prereqs, including a new enough golang. Fixes: #478 Reported-by: Rory Savage Signed-off-by: Graham Whaley --- kernel/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/kernel/README.md b/kernel/README.md index cdcd2b76cb..d7b1c51abb 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -4,6 +4,11 @@ This document explains the steps to build a kernel recommended for use with Kata Containers. To do this use `build-kernel.sh`, this script automates the process to build a kernel for Kata Containers. +## Requirements + +The `build-kernel.sh` script requires an installed Golang version matching the +[component build requirements](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#requirements-to-build-individual-components). + ## Setup kernel source code ```bash From 8ec9507387d1ae5df0e34675c028ee1eeaafd63a Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Wed, 1 May 2019 17:12:26 +0100 Subject: [PATCH 2/4] kernel: README: remove trailing '.' from a title We don't append fullstops to section titles, and they mess the ToC up (looks wise). Nuke the one we had in this file. Signed-off-by: Graham Whaley --- kernel/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kernel/README.md b/kernel/README.md index d7b1c51abb..38b5709b68 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -49,7 +49,7 @@ Kata Containers packaging repository holds the kernel configs and patches. The config and patches can work for many versions, but we only test the kernel version defined in the [runtime versions file][runtime-versions-file]. -## How is it tested. +## How is it tested The Kata Containers CI scripts install the kernel from [CI cache job][cache-job] or build from sources. From 7ccc3b7fdda19023484de3eddb7e0ecf2d994caa Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Wed, 1 May 2019 16:46:13 +0100 Subject: [PATCH 3/4] kernel: README: add a toc Add Table Of Contents to the kernel README.md file. Signed-off-by: Graham Whaley --- kernel/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/kernel/README.md b/kernel/README.md index 38b5709b68..5196a2c588 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -1,3 +1,14 @@ +* [Build Kata Containers Kernel](#build-kata-containers-kernel) + * [Requirements](#requirements) + * [Setup kernel source code](#setup-kernel-source-code) +* [Build the kernel](#build-the-kernel) + * [Install the Kernel in the default path for Kata](#install-the-kernel-in-the-default-path-for-kata) + * [Submit Kernel Changes](#submit-kernel-changes) + * [How is it tested](#how-is-it-tested) +* [Contribute](#contribute) + +--- + # Build Kata Containers Kernel This document explains the steps to build a kernel recommended for use with From 3ca8aeb22f18559876bb035abbacc8632c7e8ace Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Fri, 10 May 2019 10:25:16 +0100 Subject: [PATCH 4/4] kernel: version bump We modified the kernel subdir, even thought it was only a doc change, so we need to bump the config ver to reflect that. Signed-off-by: Graham Whaley --- kernel/kata_config_version | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kernel/kata_config_version b/kernel/kata_config_version index e522732c77..a2720097dc 100644 --- a/kernel/kata_config_version +++ b/kernel/kata_config_version @@ -1 +1 @@ -38 +39