diff mbox series

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

Message ID 20251008195219.117570-3-pkj@axis.com
State New
Headers show
Series [1/4] core-image.bbclass: Sort the FEATURE_PACKAGES_* | expand

Commit Message

Peter Kjellerstedt Oct. 8, 2025, 7:52 p.m. UTC
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 mbox series

Patch

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"