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 /meta/conf/documentation.conf | |
parent | 4a10634a88f15bff4660310df772e0300dfe61d3 (diff) | |
download | poky-3c5984a5ba8cde2171e0cfb62803c5e6a7bf35e6.tar.gz |
bitbake.conf/documentation.conf: Start using SUMMARY variable and document it
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
Diffstat (limited to 'meta/conf/documentation.conf')
-rw-r--r-- | meta/conf/documentation.conf | 3 |
1 files changed, 2 insertions, 1 deletions
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)" | |||
59 | S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory." | 59 | S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory." |
60 | SECTION[doc] = "Section of the packages e.g. console/networking" | 60 | SECTION[doc] = "Section of the packages e.g. console/networking" |
61 | PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'." | 61 | PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'." |
62 | DESCRIPTION[doc] = "A small description of the package." | 62 | DESCRIPTION[doc] = "An extended description of the package which can span mutliple lines. Paragraphs should be delimited by '\n'." |
63 | SUMMARY[doc] = "A short synopsis of package which should be a maximum of 80 characters in size" | ||
63 | LICENSE[doc] = "The license of the resulting package e.g. GPL" | 64 | LICENSE[doc] = "The license of the resulting package e.g. GPL" |
64 | AUTHOR[doc] = "The author of the files installed." | 65 | AUTHOR[doc] = "The author of the files installed." |
65 | MAINTAINER[doc] = "Distributions can put this in their .conf file to add their contact information into packages, this is not valid inside recipes" | 66 | MAINTAINER[doc] = "Distributions can put this in their .conf file to add their contact information into packages, this is not valid inside recipes" |