diff options
| author |   Richard Purdie <rpurdie@linux.intel.com> | 2010-09-21 23:53:07 +0100 |
|---|---|---|
| committer | Richard Purdie <rpurdie@linux.intel.com> | 2010-09-21 23:53:07 +0100 |
| commit | 3c5984a5ba8cde2171e0cfb62803c5e6a7bf35e6 (patch) | |
| tree | 2ab455960b21b2d1836216ae6066bc21a4e6068f | |
| parent | 4a10634a88f15bff4660310df772e0300dfe61d3 (diff) | |
| download | openembedded-core-contrib-3c5984a5ba8cde2171e0cfb62803c5e6a7bf35e6.tar.gz | |
bitbake.conf/documentation.conf: Start using SUMMARY variable and document it
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
| -rw-r--r-- | meta/conf/bitbake.conf | 12 | ||||
| -rw-r--r-- | meta/conf/documentation.conf | 3 |
2 files changed, 10 insertions, 5 deletions
diff --git a/meta/conf/bitbake.conf b/meta/conf/bitbake.conf index f6eee7d2af..e2c160685c 100644 --- 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 0f75b2aa13..d984d0d656 100644 --- 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" |