[PATCH 1/4] core-image.bbclass: Sort the FEATURE_PACKAGES_*

[PATCH 1/4] core-image.bbclass: Sort the FEATURE_PACKAGES_*

[Peter Kjellerstedt]

This is primarily a preparation for the next commit.

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---
 meta/classes-recipe/core-image.bbclass | 41 +++++++++++++-------------
 1 file changed, 20 insertions(+), 21 deletions(-)

diff --git a/meta/classes-recipe/core-image.bbclass b/meta/classes-recipe/core-image.bbclass
index 4072e420c5..34d4c2f544 100644
--- a/meta/classes-recipe/core-image.bbclass
+++ b/meta/classes-recipe/core-image.bbclass
@@ -11,20 +11,20 @@
 #
 # Available IMAGE_FEATURES:
 #
-# - weston              - Weston Wayland compositor
-# - x11                 - X server
-# - x11-base            - X server with minimal environment
-# - x11-sato            - OpenedHand Sato environment
-# - tools-debug         - debugging tools
 # - eclipse-debug       - Eclipse remote debugging support
-# - tools-profile       - profiling tools
-# - tools-testapps      - tools usable to make some device tests
-# - tools-sdk           - SDK (C/C++ compiler, autotools, etc.)
-# - nfs-server          - NFS server
+# - hwcodecs            - Install hardware acceleration codecs
 # - nfs-client          - NFS client
+# - nfs-server          - NFS server
 # - ssh-server-dropbear - SSH server (dropbear)
 # - ssh-server-openssh  - SSH server (openssh)
-# - hwcodecs            - Install hardware acceleration codecs
+# - tools-debug         - debugging tools
+# - tools-profile       - profiling tools
+# - tools-sdk           - SDK (C/C++ compiler, autotools, etc.)
+# - tools-testapps      - tools usable to make some device tests
+# - weston              - Weston Wayland compositor
+# - x11                 - X server
+# - x11-base            - X server with minimal environment
+# - x11-sato            - OpenedHand Sato environment
 # - package-management  - installs package management tools and preserves the package manager database
 # - serial-autologin-root - with 'empty-root-password': autologin 'root' on the serial console
 # - dev-pkgs            - development packages (headers, etc.) for all installed packages in the rootfs
@@ -44,21 +44,20 @@
 # - allow-root-login     - the root user can login
 # - post-install-logging - log the output of postinstall scriptlets
 #
-FEATURE_PACKAGES_weston = "packagegroup-core-weston"
-FEATURE_PACKAGES_x11 = "packagegroup-core-x11"
-FEATURE_PACKAGES_x11-base = "packagegroup-core-x11-base"
-FEATURE_PACKAGES_x11-sato = "packagegroup-core-x11-sato"
-FEATURE_PACKAGES_tools-debug = "packagegroup-core-tools-debug"
 FEATURE_PACKAGES_eclipse-debug = "packagegroup-core-eclipse-debug"
-FEATURE_PACKAGES_tools-profile = "packagegroup-core-tools-profile"
-FEATURE_PACKAGES_tools-testapps = "packagegroup-core-tools-testapps"
-FEATURE_PACKAGES_tools-sdk = "packagegroup-core-sdk packagegroup-core-standalone-sdk-target"
-FEATURE_PACKAGES_nfs-server = "packagegroup-core-nfs-server"
+FEATURE_PACKAGES_hwcodecs = "${MACHINE_HWCODECS}"
 FEATURE_PACKAGES_nfs-client = "packagegroup-core-nfs-client"
+FEATURE_PACKAGES_nfs-server = "packagegroup-core-nfs-server"
 FEATURE_PACKAGES_ssh-server-dropbear = "packagegroup-core-ssh-dropbear"
 FEATURE_PACKAGES_ssh-server-openssh = "packagegroup-core-ssh-openssh"
-FEATURE_PACKAGES_hwcodecs = "${MACHINE_HWCODECS}"
-
+FEATURE_PACKAGES_tools-debug = "packagegroup-core-tools-debug"
+FEATURE_PACKAGES_tools-profile = "packagegroup-core-tools-profile"
+FEATURE_PACKAGES_tools-sdk = "packagegroup-core-sdk packagegroup-core-standalone-sdk-target"
+FEATURE_PACKAGES_tools-testapps = "packagegroup-core-tools-testapps"
+FEATURE_PACKAGES_weston = "packagegroup-core-weston"
+FEATURE_PACKAGES_x11 = "packagegroup-core-x11"
+FEATURE_PACKAGES_x11-base = "packagegroup-core-x11-base"
+FEATURE_PACKAGES_x11-sato = "packagegroup-core-x11-sato"
 
 # IMAGE_FEATURES_REPLACES_foo = 'bar1 bar2'
 # Including image feature foo would replace the image features bar1 and bar2

[PATCH 2/4] core-image.bbclass: Improve the documentation of available image features

[Peter Kjellerstedt]

Group the features based on what they are used for, and also sort the
features within each group.

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---
 meta/classes-recipe/core-image.bbclass | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/meta/classes-recipe/core-image.bbclass b/meta/classes-recipe/core-image.bbclass
index 34d4c2f544..67802f738d 100644
--- a/meta/classes-recipe/core-image.bbclass
+++ b/meta/classes-recipe/core-image.bbclass
@@ -11,10 +11,13 @@
 #
 # Available IMAGE_FEATURES:
 #
+# These features install additional packages into the rootfs:
 # - eclipse-debug       - Eclipse remote debugging support
 # - hwcodecs            - Install hardware acceleration codecs
 # - nfs-client          - NFS client
 # - nfs-server          - NFS server
+# - package-management  - installs package management tools and preserves the package manager database
+# - splash              - bootup splash screen
 # - ssh-server-dropbear - SSH server (dropbear)
 # - ssh-server-openssh  - SSH server (openssh)
 # - tools-debug         - debugging tools
@@ -25,24 +28,28 @@
 # - x11                 - X server
 # - x11-base            - X server with minimal environment
 # - x11-sato            - OpenedHand Sato environment
-# - package-management  - installs package management tools and preserves the package manager database
-# - serial-autologin-root - with 'empty-root-password': autologin 'root' on the serial console
-# - dev-pkgs            - development packages (headers, etc.) for all installed packages in the rootfs
+#
+# These features install complementary packages for all installed packages in the rootfs:
 # - dbg-pkgs            - debug symbol packages for all installed packages in the rootfs
+# - dev-pkgs            - development packages (headers, etc.) for all installed packages in the rootfs
+# - doc-pkgs            - documentation packages for all installed packages in the rootfs
 # - lic-pkgs            - license packages for all installed pacakges in the rootfs, requires
 #                         LICENSE_CREATE_PACKAGE="1" to be set when building packages too
-# - doc-pkgs            - documentation packages for all installed packages in the rootfs
-# - bash-completion-pkgs - bash-completion packages for recipes using bash-completion bbclass
 # - ptest-pkgs          - ptest packages for all ptest-enabled recipes
+#
+# These features install complementary development packages:
+# - bash-completion-pkgs - bash-completion packages for recipes using bash-completion bbclass
+#
+# These features tweak the behavior of the rootfs:
 # - read-only-rootfs    - tweaks an image to support read-only rootfs
 # - stateless-rootfs    - systemctl-native not run, image populated by systemd at runtime
-# - splash              - bootup splash screen
 #
-# Features for development purposes (previously part of debug-tweaks):
-# - empty-root-password  - the root user has no password set
+# These features are for development purposes (some were previously part of the debug-tweaks feature):
 # - allow-empty-password - users can have an empty password
 # - allow-root-login     - the root user can login
+# - empty-root-password  - the root user has no password set
 # - post-install-logging - log the output of postinstall scriptlets
+# - serial-autologin-root - with 'empty-root-password': autologin 'root' on the serial console
 #
 FEATURE_PACKAGES_eclipse-debug = "packagegroup-core-eclipse-debug"
 FEATURE_PACKAGES_hwcodecs = "${MACHINE_HWCODECS}"

[PATCH 3/4] core-image.bbclass: Tweak the descriptions of the image features

[Peter Kjellerstedt]

Some minor grammatical changes, and removal of some duplicate
information. Also note which features were previously part of the
debug-tweaks feature.

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---
 meta/classes-recipe/core-image.bbclass | 29 +++++++++++++-------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/meta/classes-recipe/core-image.bbclass b/meta/classes-recipe/core-image.bbclass
index 67802f738d..2fb857d2ff 100644
--- a/meta/classes-recipe/core-image.bbclass
+++ b/meta/classes-recipe/core-image.bbclass
@@ -4,16 +4,16 @@
 #
 # SPDX-License-Identifier: MIT
 
-# IMAGE_FEATURES control content of the core reference images
+# IMAGE_FEATURES control the content of the core reference images
 # 
 # By default we install packagegroup-core-boot and packagegroup-base-extended packages;
-# this gives us working (console only) rootfs.
+# this gives us a working (console only) rootfs.
 #
 # Available IMAGE_FEATURES:
 #
 # These features install additional packages into the rootfs:
 # - eclipse-debug       - Eclipse remote debugging support
-# - hwcodecs            - Install hardware acceleration codecs
+# - hwcodecs            - hardware acceleration codecs (specified in MACHINE_HWCODECS)
 # - nfs-client          - NFS client
 # - nfs-server          - NFS server
 # - package-management  - installs package management tools and preserves the package manager database
@@ -30,25 +30,24 @@
 # - x11-sato            - OpenedHand Sato environment
 #
 # These features install complementary packages for all installed packages in the rootfs:
-# - dbg-pkgs            - debug symbol packages for all installed packages in the rootfs
-# - dev-pkgs            - development packages (headers, etc.) for all installed packages in the rootfs
-# - doc-pkgs            - documentation packages for all installed packages in the rootfs
-# - lic-pkgs            - license packages for all installed pacakges in the rootfs, requires
-#                         LICENSE_CREATE_PACKAGE="1" to be set when building packages too
+# - dbg-pkgs            - debug symbol packages
+# - dev-pkgs            - development packages (headers, etc.)
+# - doc-pkgs            - documentation packages
+# - lic-pkgs            - license packages, requires LICENSE_CREATE_PACKAGE="1" to be set when building packages too
 # - ptest-pkgs          - ptest packages for all ptest-enabled recipes
 #
 # These features install complementary development packages:
-# - bash-completion-pkgs - bash-completion packages for recipes using bash-completion bbclass
+# - bash-completion-pkgs - bash-completion packages
 #
 # These features tweak the behavior of the rootfs:
-# - read-only-rootfs    - tweaks an image to support read-only rootfs
-# - stateless-rootfs    - systemctl-native not run, image populated by systemd at runtime
+# - read-only-rootfs    - tweaks an image to support a read-only rootfs
+# - stateless-rootfs    - systemctl-native is not run, image is populated by systemd at runtime
 #
 # These features are for development purposes (some were previously part of the debug-tweaks feature):
-# - allow-empty-password - users can have an empty password
-# - allow-root-login     - the root user can login
-# - empty-root-password  - the root user has no password set
-# - post-install-logging - log the output of postinstall scriptlets
+# - allow-empty-password  - users can have an empty password (debug-tweaks)
+# - allow-root-login      - the root user can login (debug-tweaks)
+# - empty-root-password   - the root user has no password set (debug-tweaks)
+# - post-install-logging  - log the output of postinstall scriptlets (debug-tweaks)
 # - serial-autologin-root - with 'empty-root-password': autologin 'root' on the serial console
 #
 FEATURE_PACKAGES_eclipse-debug = "packagegroup-core-eclipse-debug"

[PATCH 4/4] core-image.bbclass: Document two image features that were missing

[Peter Kjellerstedt]

This adds documentation of overlayfs-etc and
read-only-rootfs-delayed-postinsts.

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---
 meta/classes-recipe/core-image.bbclass | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/meta/classes-recipe/core-image.bbclass b/meta/classes-recipe/core-image.bbclass
index 2fb857d2ff..959df1cf37 100644
--- a/meta/classes-recipe/core-image.bbclass
+++ b/meta/classes-recipe/core-image.bbclass
@@ -40,7 +40,9 @@
 # - bash-completion-pkgs - bash-completion packages
 #
 # These features tweak the behavior of the rootfs:
+# - overlayfs-etc       - sets up /etc in overlayfs
 # - read-only-rootfs    - tweaks an image to support a read-only rootfs
+# - read-only-rootfs-delayed-postinsts - supports post-install scripts with read-only-rootfs
 # - stateless-rootfs    - systemctl-native is not run, image is populated by systemd at runtime
 #
 # These features are for development purposes (some were previously part of the debug-tweaks feature):