summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2012-08-22 11:53:06 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-08-22 13:59:54 +0100
commitbf64b6ec396239b08cf1b602e6167c56519e555a (patch)
tree5c9e3d82aca7e1bf27f02e993a1c3807028cd442
parent603f6c631e9454d10517599e229943f2b26d08a5 (diff)
downloadpoky-bf64b6ec396239b08cf1b602e6167c56519e555a.tar.gz
classes/package: document do_packages_split arguments
This function takes quite a number of arguments and can be tricky to use properly; this is not made easier if it is undocumented, so document all of the arguments. (No functional changes, comments only.) (From OE-Core rev: 324fbcc047819b6948d13eda627ec898cb1f1eb8) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--meta/classes/package.bbclass41
1 files changed, 41 insertions, 0 deletions
diff --git a/meta/classes/package.bbclass b/meta/classes/package.bbclass
index b17fa08da1..46facf726b 100644
--- a/meta/classes/package.bbclass
+++ b/meta/classes/package.bbclass
@@ -73,6 +73,47 @@ def do_split_packages(d, root, file_regex, output_pattern, description, postinst
73 """ 73 """
74 Used in .bb files to split up dynamically generated subpackages of a 74 Used in .bb files to split up dynamically generated subpackages of a
75 given package, usually plugins or modules. 75 given package, usually plugins or modules.
76
77 Arguments:
78 root -- the path in which to search
79 file_regex -- regular expression to match searched files. Use
80 parentheses () to mark the part of this expression
81 that should be used to derive the module name (to be
82 substituted where %s is used in other function
83 arguments as noted below)
84 output_pattern -- pattern to use for the package names. Must include %s.
85 description -- description to set for each package. Must include %s.
86 postinst -- postinstall script to use for all packages (as a
87 string)
88 recursive -- True to perform a recursive search - default False
89 hook -- a hook function to be called for every match. The
90 function will be called with the following arguments
91 (in the order listed):
92 f: full path to the file/directory match
93 pkg: the package name
94 file_regex: as above
95 output_pattern: as above
96 modulename: the module name derived using file_regex
97 extra_depends -- extra runtime dependencies (RDEPENDS) to be set for
98 all packages. The default value of None causes a
99 dependency on the main package (${PN}) - if you do
100 not want this, pass '' for this parameter.
101 aux_files_pattern -- extra item(s) to be added to FILES for each
102 package. Can be a single string item or a list of
103 strings for multiple items. Must include %s.
104 postrm -- postrm script to use for all packages (as a string)
105 allow_dirs -- True allow directories to be matched - default False
106 prepend -- if True, prepend created packages to PACKAGES instead
107 of the default False which appends them
108 match_path -- match file_regex on the whole relative path to the
109 root rather than just the file name
110 aux_files_pattern_verbatim -- extra item(s) to be added to FILES for
111 each package, using the actual derived module name
112 rather than converting it to something legal for a
113 package name. Can be a single string item or a list
114 of strings for multiple items. Must include %s.
115 allow_links -- True to allow symlinks to be matched - default False
116
76 """ 117 """
77 118
78 ml = d.getVar("MLPREFIX", True) 119 ml = d.getVar("MLPREFIX", True)