bitbake.conf/documentation.conf: Start using SUMMARY variable and document it

Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>

diff --git a/meta/conf/bitbake.conf b/meta/conf/bitbake.conf
index f6eee7d2af06bc14dea44e8fc81fdf6924eb5833..e2c160685c4d2deefef39ff7cce3f4d3d5ea88d1 100644 (file)
--- a/meta/conf/bitbake.conf
+++ b/meta/conf/bitbake.conf
@@ -162,10 +162,14 @@ BP = "${BPN}-${PV}"
 
 SECTION = "base"
 PRIORITY = "optional"
-DESCRIPTION = "Version ${PV}-${PR} of package ${PN}"
-DESCRIPTION_${PN}-dbg = "Debbugging files for ${PN}"
-DESCRIPTION_${PN}-dev = "Development files for ${PN}"
-DESCRIPTION_${PN}-doc = "Documentation for ${PN}"
+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}"
 LICENSE = "unknown"
 MAINTAINER = "Poky Team <poky@openedhand.com>"
 HOMEPAGE = "unknown"

diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
index 0f75b2aa13e87264260df6516fe289490ca5f80c..d984d0d65668801b233abf55280c57e89a024c1c 100644 (file)
--- a/meta/conf/documentation.conf
+++ b/meta/conf/documentation.conf
@@ -59,7 +59,8 @@ P[doc]  = "Package name - Package version (PN-PF)"
 S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory."
 SECTION[doc]  = "Section of the packages e.g. console/networking"
 PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'."
-DESCRIPTION[doc] = "A small description of the package."
+DESCRIPTION[doc] = "An extended description of the package which can span mutliple lines. Paragraphs should be delimited by '\n'."
+SUMMARY[doc] = "A short synopsis of package which should be a maximum of 80 characters in size"
 LICENSE[doc] = "The license of the resulting package e.g. GPL"
 AUTHOR[doc] = "The author of the files installed."
 MAINTAINER[doc] = "Distributions can put this in their .conf file to add their contact information into packages, this is not valid inside recipes"