Add comments

Signed-off-by: Mauro Morales <[email protected]>
kairos-io · Aug 31, 2023 · 8e1a437 · 8e1a437
1 parent 82616c9
commit 8e1a437
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/Earthfile b/Earthfile
@@ -300,6 +300,9 @@ base-image:
     ARG KAIROS_VERSION
     ARG BUILD_INITRD="true"
     ARG TARGETARCH
+    # HWE is used to determine if the HWE kernel should be installed on Ubuntu LTS.
+    # The default value is empty, which means the HWE kernel WILL be installed
+    # if you want to disable the HWE kernel, set HWE to "-non-hwe"
     ARG HWE
 
     IF [ "$BASE_IMAGE" = "" ]

diff --git a/images/Dockerfile.ubuntu b/images/Dockerfile.ubuntu
@@ -1,9 +1,22 @@
 ###############################################################
 ####                           ARGS                        ####
 ###############################################################
+# Currently supported flavors are:
+#   - ubuntu
+#   - ubuntu-20-lts
+#   - ubuntu-22-lts
 ARG FLAVOR
+# Currently supported models are:
+#   - generic
+#   - rpi4
+#   - rpi3
 ARG MODEL=generic
+# HWE is used to determine if the HWE kernel should be installed
+# the default value is empty, which means the HWE kernel WILL be installed
+# if you want to disable the HWE kernel, set HWE to "-non-hwe"
 ARG HWE=""
+# TARGETARCH is used to determine the architecture of the image
+# it is already set by Docker so it doesn't need to be defined here
 
 ###############################################################
 ####                     Upstream Images                   ####