From 9200ae33c7d9897b031031c9f4cee8d86bc6774a Mon Sep 17 00:00:00 2001 From: "Thomas Irgang (thir820)" Date: Tue, 8 Oct 2024 08:32:32 +0000 Subject: [PATCH 1/4] update initrd-gen docs for packages --- docs/images/params.md | 3 ++- docs/tools/initrd.md | 15 ++++++++++----- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/images/params.md b/docs/images/params.md index 592f6248..989c5b25 100644 --- a/docs/images/params.md +++ b/docs/images/params.md @@ -86,10 +86,11 @@ a meta-package for the kernel binary and modules. - **packages** _(boot/initrd/root/config)_ \[default: None \]: A list of packages. For the _root generator_, these packages are installed in the base _deboostrap_ environment. -For the _initrd generator_, these packages will be downloaded and extracted to get the kernel modules. +For the _initrd generator_, these packages will be downloaded and extracted to the resuling _initrd.img_. For the _boot generator_, these packages will be downloaded and extracted to get the kernel binary. - **kernel** _(boot/initrd/root)_ \[default: None \]: Name of the kernel package. +For the _initrd generator_, these packages will be downloaded and extracted to a temporary folder to get the required kernel modules. - **tar** _(boot)_ \[default: True \]: Flag for packing the boot artifacts as a tarball. If _embdgen_ is used to write the artifacts to an image, this will preserve the owner and mode of the artifacts. diff --git a/docs/tools/initrd.md b/docs/tools/initrd.md index 782f10d0..d38a760d 100644 --- a/docs/tools/initrd.md +++ b/docs/tools/initrd.md @@ -15,11 +15,12 @@ The internal steps are: 1. Read in YAML configuration file 2. Add BusyBox binary - 3. Add kernel modules, extracts the specified modules - 4. Creates device nodes for initrd image based on the configuration. - 5. Copy all specified files and directories into the initrd image - 6. Generates init script - 7. Generate initrd based on all the files with `cpio` + 3. Download and extract additional packages + 4. Add kernel modules, extracts the specified modules + 5. Creates device nodes for initrd image based on the configuration. + 6. Copy all specified files and directories into the initrd image + 7. Generates init script + 8. Generate initrd based on all the files with `cpio` ## Configuration options @@ -53,4 +54,8 @@ devices: major: minor: - ... +# Packages to add, e.g. e2fstools +packages: + - + - ... ``` From cbf50bcaac35e34b4cf3dcf6099a1a6478a2a0df Mon Sep 17 00:00:00 2001 From: Thomas Irgang <148551277+thir820@users.noreply.github.com> Date: Tue, 8 Oct 2024 11:08:34 +0200 Subject: [PATCH 2/4] Update docs/tools/initrd.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jörg Vehlow Signed-off-by: Thomas Irgang <148551277+thir820@users.noreply.github.com> --- docs/tools/initrd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/initrd.md b/docs/tools/initrd.md index d38a760d..fed1ab43 100644 --- a/docs/tools/initrd.md +++ b/docs/tools/initrd.md @@ -19,7 +19,7 @@ The internal steps are: 4. Add kernel modules, extracts the specified modules 5. Creates device nodes for initrd image based on the configuration. 6. Copy all specified files and directories into the initrd image - 7. Generates init script + 7. Generate the init script 8. Generate initrd based on all the files with `cpio` ## Configuration options From 07a48282de906d82a30459af353d8c3548e17e32 Mon Sep 17 00:00:00 2001 From: Thomas Irgang <148551277+thir820@users.noreply.github.com> Date: Tue, 8 Oct 2024 11:09:06 +0200 Subject: [PATCH 3/4] Update docs/images/params.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jörg Vehlow Signed-off-by: Thomas Irgang <148551277+thir820@users.noreply.github.com> --- docs/images/params.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/images/params.md b/docs/images/params.md index 989c5b25..48adaed4 100644 --- a/docs/images/params.md +++ b/docs/images/params.md @@ -86,7 +86,7 @@ a meta-package for the kernel binary and modules. - **packages** _(boot/initrd/root/config)_ \[default: None \]: A list of packages. For the _root generator_, these packages are installed in the base _deboostrap_ environment. -For the _initrd generator_, these packages will be downloaded and extracted to the resuling _initrd.img_. +For the _initrd generator_, these packages will be downloaded, extracted and integrated into the resutling _initrd.img_. For the _boot generator_, these packages will be downloaded and extracted to get the kernel binary. - **kernel** _(boot/initrd/root)_ \[default: None \]: Name of the kernel package. From a5227d96d3647de4029e008a5cb7d42e0434474e Mon Sep 17 00:00:00 2001 From: Thomas Irgang <148551277+thir820@users.noreply.github.com> Date: Tue, 8 Oct 2024 11:09:18 +0200 Subject: [PATCH 4/4] Update docs/tools/initrd.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jörg Vehlow Signed-off-by: Thomas Irgang <148551277+thir820@users.noreply.github.com> --- docs/tools/initrd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/initrd.md b/docs/tools/initrd.md index fed1ab43..d0089299 100644 --- a/docs/tools/initrd.md +++ b/docs/tools/initrd.md @@ -20,7 +20,7 @@ The internal steps are: 5. Creates device nodes for initrd image based on the configuration. 6. Copy all specified files and directories into the initrd image 7. Generate the init script - 8. Generate initrd based on all the files with `cpio` + 8. Generate initrd based on all the files using `cpio` ## Configuration options