Skip to contentSkip to conversation

core-image-foo: add summary to each image bb file

PATCH Superseded Shane Wang 2 participants 5 messages Jan 19, 2012

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Shane Wang

author
#0 lore raw

cover core-image-foo: add summary to each image bb file

This path is to add summary variable to each image bb file for Hob 2 use later, according to the poky reference manual. Please review.

The following changes since commit 522c6b376d067243bff20c64a1f6f8700be8e586:

gnutls: Fix configure issue wrt to rm (2012-01-19 11:34:13 +0000)

are available in the git repository at:
git://git.pokylinux.org/poky-contrib shane/summary
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=shane/summary

Shane Wang (1):
core-image-foo: add summary to each image bb file

 meta/recipes-core/images/core-image-base.bb        |    2 ++
 meta/recipes-core/images/core-image-core.bb        |    2 ++
 meta/recipes-core/images/core-image-minimal-dev.bb |    2 ++
 .../images/core-image-minimal-initramfs.bb         |    3 +++
 .../images/core-image-minimal-mtdutils.bb          |    4 ++++
 meta/recipes-core/images/core-image-minimal.bb     |    2 ++
 meta/recipes-extended/images/core-image-basic.bb   |    3 +++
 meta/recipes-extended/images/core-image-lsb-dev.bb |    4 ++++
 meta/recipes-extended/images/core-image-lsb-sdk.bb |    4 ++++
 meta/recipes-extended/images/core-image-lsb.bb     |    3 +++
 meta/recipes-graphics/images/core-image-clutter.bb |    3 +++
 meta/recipes-sato/images/core-image-sato-dev.bb    |    3 +++
 meta/recipes-sato/images/core-image-sato-sdk.bb    |    4 +++-
 meta/recipes-sato/images/core-image-sato.bb        |    2 ++
 14 files changed, 40 insertions(+), 1 deletions(-)
Signature · 1 line
1.7.6
author
#1 lore raw

PATCH 1/1 core-image-foo: add summary to each image bb file

Add SUMMARY to each image bb file according to poky reference manual for Hob2 use later.

---
 meta/recipes-core/images/core-image-base.bb        |    2 ++
 meta/recipes-core/images/core-image-core.bb        |    2 ++
 meta/recipes-core/images/core-image-minimal-dev.bb |    2 ++
 .../images/core-image-minimal-initramfs.bb         |    3 +++
 .../images/core-image-minimal-mtdutils.bb          |    4 ++++
 meta/recipes-core/images/core-image-minimal.bb     |    2 ++
 meta/recipes-extended/images/core-image-basic.bb   |    3 +++
 meta/recipes-extended/images/core-image-lsb-dev.bb |    4 ++++
 meta/recipes-extended/images/core-image-lsb-sdk.bb |    4 ++++
 meta/recipes-extended/images/core-image-lsb.bb     |    3 +++
 meta/recipes-graphics/images/core-image-clutter.bb |    3 +++
 meta/recipes-sato/images/core-image-sato-dev.bb    |    3 +++
 meta/recipes-sato/images/core-image-sato-sdk.bb    |    4 +++-
 meta/recipes-sato/images/core-image-sato.bb        |    2 ++
 14 files changed, 40 insertions(+), 1 deletions(-)
meta/recipes-core/images/core-image-base.bb +2 -0
index 13a7650..1d3e793 100644
@@ -1,6 +1,8 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
+SUMMARY = "A console-only image that fully supports the target device \
+hardware."
 
 IMAGE_FEATURES += "apps-console-core"
 
meta/recipes-core/images/core-image-core.bb +2 -0
index 57ff085..a36d513 100644
@@ -1,6 +1,8 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
+SUMMARY = "An X11 image with simple applications such as terminal, editor \
+and file manager."
 
 IMAGE_FEATURES += "apps-console-core ${X11_IMAGE_FEATURES}"
 
meta/recipes-core/images/core-image-minimal-dev.bb +2 -0
index 89ec9f8..76395f1 100644
@@ -1,6 +1,8 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
+SUMMARY = "A core-image-minimal image suitable for development work."
+
 IMAGE_INSTALL = "task-core-boot ${ROOTFS_PKGMANAGE}"
 
 IMAGE_FEATURES += "dev-pkgs"
meta/recipes-core/images/core-image-minimal-initramfs.bb +3 -0
index 5149f31..95b5a50 100644
@@ -1,4 +1,7 @@
 # Simple initramfs image. Mostly used for live images.
+SUMMARY = "A core-image-minimal image that has the Minimal RAM-based \
+Initial Root Filesystem (initramfs) as part of the kernel, which allows the \
+system to find the first 'init' program more efficiently."
 
 IMAGE_INSTALL = "initramfs-live-boot initramfs-live-install busybox udev base-passwd"
 
meta/recipes-core/images/core-image-minimal-mtdutils.bb +4 -0
index adabaa4..2f8a3f5 100644
@@ -3,4 +3,8 @@
 #
 require core-image-minimal.bb
 
+SUMMARY = "A core-image-minimal image that has support the Minimal MTD \
+Utilities, which let the user interact with the MTD subsystem in the kernel \
+to perform operations on flash devices."
+
 IMAGE_INSTALL += "mtd-utils"
meta/recipes-core/images/core-image-minimal.bb +2 -0
index 56fc20c..843030d 100644
@@ -1,6 +1,8 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
+SUMMARY = "A small image just capable of allowing a device to boot."
+
 IMAGE_INSTALL = "task-core-boot ${ROOTFS_PKGMANAGE_BOOTSTRAP} ${POKY_EXTRA_INSTALL}"
 
 IMAGE_LINGUAS = " "
meta/recipes-extended/images/core-image-basic.bb +3 -0
index ba71cd0..261b993 100644
@@ -1,3 +1,6 @@
+SUMMARY = "A foundational basic image without support for X that can be \
+reasonably used for customization."
+
 IMAGE_FEATURES += "apps-console-core ssh-server-openssh"
 
 IMAGE_INSTALL = "\
meta/recipes-extended/images/core-image-lsb-dev.bb +4 -0
index 9ef85ff..8397da1 100644
@@ -1,3 +1,7 @@
+SUMMARY = "A core-image-lsb that includes everything in meta-toolchain \
+but also includes development headers and libraries to form a complete \
+standalone SDK."
+
 IMAGE_FEATURES += "apps-console-core dev-pkgs ssh-server-openssh"
 
 IMAGE_INSTALL = "\
meta/recipes-extended/images/core-image-lsb-sdk.bb +4 -0
index 5e0e7ae..34e11b7 100644
@@ -1,3 +1,7 @@
+SUMMARY = "A core-image-lsb that includes everything in meta-toolchain \
+but also includes development headers and libraries to form a complete \
+standalone SDK."
+
 IMAGE_FEATURES += "apps-console-core tools-sdk dev-pkgs ssh-server-openssh"
 EXTRA_IMAGE_FEATURES = "tools-debug tools-profile tools-testapps debug-tweaks"
 
meta/recipes-extended/images/core-image-lsb.bb +3 -0
index 22eb7f4..306fde6 100644
@@ -1,3 +1,6 @@
+SUMMARY = "A core-image-basic image suitable for implementations that \
+conform to Linux Standard Base (LSB)."
+
 IMAGE_FEATURES += "apps-console-core ssh-server-openssh"
 
 IMAGE_INSTALL = "\
meta/recipes-graphics/images/core-image-clutter.bb +3 -0
index 7d50405..7d8b8e6 100644
@@ -1,3 +1,6 @@
+SUMMARY = "An image with support for the Open GL-based toolkit Clutter, \
+which enables development of rich and animated graphical user interfaces."
+
 IMAGE_FEATURES += "apps-console-core ${SATO_IMAGE_FEATURES}"
 
 LICENSE = "MIT"
meta/recipes-sato/images/core-image-sato-dev.bb +3 -0
index 7322b4a..2fb366a 100644
@@ -1,6 +1,9 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
+SUMMARY = "A core-image-sato image suitable for development that also \
+includes a native toolchain and libraries needed to build applications on the \
+device itself."
 
 IMAGE_FEATURES += "apps-console-core ${SATO_IMAGE_FEATURES} dev-pkgs"
 
meta/recipes-sato/images/core-image-sato-sdk.bb +3 -1
index 6c2dc60..9bcd1d7 100644
@@ -1,7 +1,9 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
-
+SUMMARY = "A core-image-sato image that includes everything in \
+meta-toolchain. The image also includes development headers and libraries \
+to form a complete standalone SDK."
 
 IMAGE_FEATURES += "apps-console-core ${SATO_IMAGE_FEATURES} dev-pkgs tools-sdk qt4-pkgs"
 EXTRA_IMAGE_FEATURES += "tools-debug tools-profile tools-testapps debug-tweaks"
meta/recipes-sato/images/core-image-sato.bb +2 -0
index 3465174..3748fd3 100644
@@ -1,6 +1,8 @@
 #
 # Copyright (C) 2007 OpenedHand Ltd.
 #
+SUMMARY = "An image with Sato support, a mobile environment and visual \
+style that works well with mobile devices."
 
 IMAGE_FEATURES += "apps-console-core ${SATO_IMAGE_FEATURES}"
 
Signature · 1 line
1.7.6
#2 lore raw

Hi Shane,

Quoted 1 line · Shane Wang

Add SUMMARY to each image bb file according to poky reference manual for Hob2 use later.

I think this is good but shouldn't some of these be DESCRIPTIONs? The difference is that summary should be a one line summary (~max 72 chars) whilst DESCRIPTION can be multiple lines of text...

Cheers,

Richard

#3 lore raw

That could be. I originally thought they are DESCRIPTIONs.
But for CacheData in cache.py, it seems not description but summary is used. Is it OK to change the code to make descriptions into CacheData?

--
Shane

Richard Purdie wrote on 2012-01-19:

Quoted 19 lines

Hi Shane,

Quoted 1 line · Shane Wang

Add SUMMARY to each image bb file according to poky reference manual

for Hob2 use later.

I think this is good but shouldn't some of these be DESCRIPTIONs? The difference is that summary should be a one line summary (~max 72 chars) whilst DESCRIPTION can be multiple lines of text...

Cheers,

Richard

_______________________________________________ Openembedded-core mailing list [email protected]
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-core

#4 lore raw
Quoted 3 lines · Shane

That could be. I originally thought they are DESCRIPTIONs.
But for CacheData in cache.py, it seems not description but summary is used. Is it OK to change the code to make descriptions into CacheData?

Please see cache_extra.py and add the DESCRIPTION there.

Cheers,

Richard