Revised summary & description patch

PATCH Applied Mark Hatle 2 participants 4 messages Feb 3, 2011

Share & tools

Mark Hatle

author

2011-02-03 19:36 UTC #0 lore raw

cover Revised summary & description patch

This is an update pull request for the revised summary & description patch. It stop the failure mentioned by Saul in a previous email.

The second chunk of the patch is new and includes the workaround I sent earlier today on the prelink documentation issue. I'm not sure this is really the right patch, but it should unblock people.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: mhatle/wrsync
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=mhatle/wrsync

Thanks,
Mark Hatle <[email protected]>
---

Mark Hatle (2):
bitbake.conf & package.bbclass: Use default SUMMARY and DESCRIPTION Docbook workaround

 meta/classes/package.bbclass                 |    5 +++-
 meta/conf/bitbake.conf                       |   30 +++++++++++++++++++-------
 meta/recipes-devtools/prelink/prelink_git.bb |    5 ++++
 3 files changed, 31 insertions(+), 9 deletions(-)

Signature · 1 line

1.7.3.4

Mark Hatle

author

2011-02-03 19:36 UTC #1 lore raw

PATCH 1/2 bitbake.conf & package.bbclass: Use default SUMMARY and DESCRIPTION

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 <[email protected]>

---
 meta/classes/package.bbclass |    5 ++++-
 meta/conf/bitbake.conf       |   30 ++++++++++++++++++++++--------
 2 files changed, 26 insertions(+), 9 deletions(-)

meta/classes/package.bbclass +4 -1

index bdc5d93..e64e441 100644
@@ -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)

meta/conf/bitbake.conf +22 -8

index 3292a49..f08dda6 100644
@@ -166,14 +166,28 @@ 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}"
+
+# The following two are commented out because they result in a recursive
+# definition of the variable in some corner cases.  These are left in
+# to illustrate the intended behavior.
+#SUMMARY_${PN} ?= "${SUMMARY}"
+#DESCRIPTION_${PN} ?= "${DESCRIPTION}"
+
+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 <[email protected]>"
 HOMEPAGE = "unknown"

Signature · 1 line

1.7.3.4

Mark Hatle

author

2011-02-03 19:36 UTC #2 lore raw

PATCH 2/2 Docbook workaround

In reply to Mark Hatle

Signed-off-by Mark Hatle <[email protected]>

---
 meta/recipes-devtools/prelink/prelink_git.bb |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

meta/recipes-devtools/prelink/prelink_git.bb +5 -0

index 1601443..8620513 100644
@@ -27,6 +27,11 @@ BBCLASSEXTEND = "native"
 EXTRA_OECONF = "--disable-selinux --with-pkgversion=${PV}-${PR} \
 	--with-bugurl=http://bugzilla.pokylinux.org/"
 
+do_configure_prepend () {
+        # Disable documentation!
+        echo "all:" > ${S}/doc/Makefile.am
+}
+
 do_install_append () {
 	install -d ${D}${sysconfdir}/cron.daily ${D}${sysconfdir}/default
 	install -m 0644 ${WORKDIR}/prelink.conf ${D}${sysconfdir}/prelink.conf

Signature · 1 line

1.7.3.4

Saul Wold

Applied

2011-02-03 20:00 UTC #3 lore raw

In reply to Mark Hatle

Quoted 16 lines · Mark Hatle

This is an update pull request for the revised summary& description patch. It stop the failure mentioned by Saul in a previous email.
The second chunk of the patch is new and includes the workaround I sent earlier today on the prelink documentation issue. I'm not sure this is really the right patch, but it should unblock people.
Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: mhatle/wrsync
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=mhatle/wrsync
Thanks,
Mark Hatle<[email protected]>
---

Quoted 9 lines

Mark Hatle (2):
bitbake.conf& package.bbclass: Use default SUMMARY and DESCRIPTION Docbook workaround

  meta/classes/package.bbclass                 |    5 +++-
  meta/conf/bitbake.conf                       |   30 +++++++++++++++++++-------
  meta/recipes-devtools/prelink/prelink_git.bb |    5 ++++
  3 files changed, 31 insertions(+), 9 deletions(-)

Mark,

I merged the SUMMARY & DESCRIPTION changes, but held off on the workaround to give Scott G. a chance to fix it properly.

Thanks

Sau!