summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <rpurdie@linux.intel.com>2010-09-21 23:53:07 +0100
committerRichard Purdie <rpurdie@linux.intel.com>2010-09-21 23:53:07 +0100
commit3c5984a5ba8cde2171e0cfb62803c5e6a7bf35e6 (patch)
tree2ab455960b21b2d1836216ae6066bc21a4e6068f
parent4a10634a88f15bff4660310df772e0300dfe61d3 (diff)
downloadpoky-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.conf12
-rw-r--r--meta/conf/documentation.conf3
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}"
162 162
163SECTION = "base" 163SECTION = "base"
164PRIORITY = "optional" 164PRIORITY = "optional"
165DESCRIPTION = "Version ${PV}-${PR} of package ${PN}" 165SUMMARY_${PN} ?= "${PN} version ${PV}-${PR}"
166DESCRIPTION_${PN}-dbg = "Debbugging files for ${PN}" 166SUMMARY_${PN}-dbg ?= "Debugging files for ${PN}"
167DESCRIPTION_${PN}-dev = "Development files for ${PN}" 167SUMMARY_${PN}-dev ?= "Development files for ${PN}"
168DESCRIPTION_${PN}-doc = "Documentation for ${PN}" 168SUMMARY_${PN}-doc ?= "Documentation files for ${PN}"
169DESCRIPTION_${PN} ?= "${SUMMARY_${PN}}"
170DESCRIPTION_${PN}-dbg ?= "${SUMMARY_${PN}-dbg}"
171DESCRIPTION_${PN}-dev ?= "${SUMMARY_${PN}-dev}"
172DESCRIPTION_${PN}-doc ?= "${SUMMARY_${PN}-doc}"
169LICENSE = "unknown" 173LICENSE = "unknown"
170MAINTAINER = "Poky Team <poky@openedhand.com>" 174MAINTAINER = "Poky Team <poky@openedhand.com>"
171HOMEPAGE = "unknown" 175HOMEPAGE = "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)"
59S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory." 59S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory."
60SECTION[doc] = "Section of the packages e.g. console/networking" 60SECTION[doc] = "Section of the packages e.g. console/networking"
61PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'." 61PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'."
62DESCRIPTION[doc] = "A small description of the package." 62DESCRIPTION[doc] = "An extended description of the package which can span mutliple lines. Paragraphs should be delimited by '\n'."
63SUMMARY[doc] = "A short synopsis of package which should be a maximum of 80 characters in size"
63LICENSE[doc] = "The license of the resulting package e.g. GPL" 64LICENSE[doc] = "The license of the resulting package e.g. GPL"
64AUTHOR[doc] = "The author of the files installed." 65AUTHOR[doc] = "The author of the files installed."
65MAINTAINER[doc] = "Distributions can put this in their .conf file to add their contact information into packages, this is not valid inside recipes" 66MAINTAINER[doc] = "Distributions can put this in their .conf file to add their contact information into packages, this is not valid inside recipes"