Re: [PATCH 3/3] bitbake.conf & package.bbclass: Use default SUMMARY and DESCRIPTION

[Saul Wold <saul.wold@intel.com>]

On 02/02/2011 10:52 AM, Mark Hatle wrote:
> A new default SUMMARY and DESCRIPTION was defined for any package that
> previously did not contain one.  This value is based on the original
> SUMMARY_${PN} value.
>
> The new default SUMMARY and DESCRIPTION is used as a basis for all of
> the automatic summary and descriptions for the various package splits,
> include ${PN}, ${PN}-dbg, ${PN}-dev, ${PN}-doc, and locales.
>
> A recipe may also override any of the automatic summaries by simply
> specifying the value.
>
> Signed-off-by: Mark Hatle<mark.hatle@windriver.com>
> ---
>   meta/classes/package.bbclass |    5 ++++-
>   meta/conf/bitbake.conf       |   27 +++++++++++++++++++--------
>   2 files changed, 23 insertions(+), 9 deletions(-)
>
> diff --git a/meta/classes/package.bbclass b/meta/classes/package.bbclass
> index bdc5d93..e64e441 100644
> --- a/meta/classes/package.bbclass
> +++ b/meta/classes/package.bbclass
> @@ -289,6 +289,8 @@ python package_do_split_locales() {
>   	if mainpkg.find('-dev'):
>   		mainpkg = mainpkg.replace('-dev', '')
>
> +	summary = bb.data.getVar('SUMMARY', d, True) or pn
> +	description = bb.data.getVar('DESCRIPTION', d, True) or ""
>   	for l in locales:
>   		ln = legitimize_package_name(l)
>   		pkg = pn + '-locale-' + ln
> @@ -296,7 +298,8 @@ python package_do_split_locales() {
>   		bb.data.setVar('FILES_' + pkg, os.path.join(datadir, 'locale', l), d)
>   		bb.data.setVar('RDEPENDS_' + pkg, '%s virtual-locale-%s' % (mainpkg, ln), d)
>   		bb.data.setVar('RPROVIDES_' + pkg, '%s-locale %s-translation' % (pn, ln), d)
> -		bb.data.setVar('DESCRIPTION_' + pkg, '%s translation for %s' % (l, pn), d)
> +		bb.data.setVar('SUMMARY_' + pkg, '%s - %s translations' % (summary, l), d)
> +		bb.data.setVar('DESCRIPTION_' + pkg, '%s  This package contains language translation files for the %s locale.' % (description, l), d)
>
>   	bb.data.setVar('PACKAGES', ' '.join(packages), d)
>
> diff --git a/meta/conf/bitbake.conf b/meta/conf/bitbake.conf
> index 3292a49..668f250 100644
> --- a/meta/conf/bitbake.conf
> +++ b/meta/conf/bitbake.conf
> @@ -166,14 +166,25 @@ BP = "${BPN}-${PV}"
>
>   SECTION = "base"
>   PRIORITY = "optional"
> -SUMMARY_${PN} ?= "${PN} version ${PV}-${PR}"
> -SUMMARY_${PN}-dbg ?= "Debugging files for ${PN}"
> -SUMMARY_${PN}-dev ?= "Development files for ${PN}"
> -SUMMARY_${PN}-doc ?= "Documentation files for ${PN}"
> -DESCRIPTION_${PN} ?= "${SUMMARY_${PN}}"
> -DESCRIPTION_${PN}-dbg ?= "${SUMMARY_${PN}-dbg}"
> -DESCRIPTION_${PN}-dev ?= "${SUMMARY_${PN}-dev}"
> -DESCRIPTION_${PN}-doc ?= "${SUMMARY_${PN}-doc}"
> +SUMMARY ?= "${PN} version ${PV}-${PR}"
> +DESCRIPTION ?= "${SUMMARY}"
> +
> +SUMMARY_${PN} ?= "${SUMMARY}"
> +DESCRIPTION_${PN} ?= "${DESCRIPTION}"
> +
Mark,

I am not sure about this change a from scratch build show the following 
failure:
Pseudo is not present but is required, building this first before the 
main build
Parsing recipes...NOTE: Error expanding variable SUMMARY
ERROR: Error parsing 
/vol/1/sgw/autobuilder/poky-slave/poky-full-ia/build/meta/recipes-kernel/linux/linux_2.6.23.bb: 
variable SUMMARY references itself!
ERROR: Command execution failed: Exited with 1

I think your odering needs to have the SUMMARY_${PN} first and then set 
SUMMARY from the ${SUMMARY_${PN}}, same for DESCRIPTION, maybe Richard 
can comment on this.

Sau!


> +SUMMARY_${PN}-dbg ?= "${SUMMARY} - Debugging files"
> +DESCRIPTION_${PN}-dbg ?= "${DESCRIPTION}  \
> +This package contains ELF symbols and related sources for debugging purposes."
> +
> +SUMMARY_${PN}-dev ?= "${SUMMARY} - Development files"
> +DESCRIPTION_${PN}-dev ?= "${DESCRIPTION}  \
> +This package contains symbolic links, static binaries, header files, and \
> +related items necessary for software development."
> +
> +SUMMARY_${PN}-doc ?= "${SUMMARY} - Documentation files"
> +DESCRIPTION_${PN}-doc ?= "${DESCRIPTION}  \
> +This package contains documentation."
> +
>   LICENSE = "INVALID"
>   MAINTAINER = "Yocto Project Team<poky@yoctoproject.org>"
>   HOMEPAGE = "unknown"