summaryrefslogtreecommitdiff
path: root/meta/classes/license.bbclass
AgeCommit message (Collapse)AuthorFiles
2012-07-19Remove a number of unneeded import os/bb callsRichard Purdie1
The bb and os modules are always imported so having these extra import calls are a waste of space/execution time. They also set a bad example for people copy and pasting code so clean them up. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-19Convert tab indentation in python functions into four-spaceRichard Purdie1
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-09classes/license: fix manifest to work with debPaul Eggleton1
Prepend the license manifest creation call to ROOTFS_POSTPROCESS_COMMAND instead of appending to ROOTFS_POSTINSTALL_COMMAND. The latter is not implemented for the deb backend (and probably ought to just be removed completely), and by using _prepend we can still ensure it occurs before package info is removed (and before buildhistory in case it is needed there in future). Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2012-06-05license.bbclass: optimize pkg runtime dataElizabeth Flanagan1
This fixes an ugly way I was trying to find pkg runtime data for package and license manifest creation. rootfs generation times for core-image-minimal: Prior to patch real 0m41.570s user 1m40.466s sys 0m6.768s With patch real 0m27.527s user 0m9.833s sys 0m3.496s Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Conflicts: meta/classes/license.bbclass
2012-06-05license.bbclass: Adding PV to package.manifestElizabeth Flanagan1
Per request, adding the package version to the package manifest file. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com>
2012-04-04license.bbclass: Check if copyfile succeeded with isfileAndrei Gherzan1
A cleaner way to check if copyfile suceeded is to use os.path.isfile. In this way we can omit warns in some python versions where copyfile return the same non-0 value even is this action is successfull. Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
2012-03-29license.bbclass: remove existing license.manifest before appending new dataEric Bénard1
without this fix, we append license each time we build again the same image, ending with a large not up to date file. Signed-off-by: Eric Bénard <eric@eukrea.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-25license.bbclass: Style guide complianceElizabeth Flanagan1
4 spaces. Correcting some bash whitespace in license to comply with the style guide. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-25INCOMPATIBLE_LICENSE: support for spdx and pkg licensesElizabeth Flanagan1
This adds a few things to the incompatible license functionality 1. INCOMPATIBLE_LICENSE was unable to distinguish any variation within LICENSE (e.g. GPLv3 v. GPLv3.0). This now utilizes the SPDXLICENSEMAP of the license indicated as INCOMPATIBLE_LICENSE 2. Given a recipe where the main LICENSE was incompatible but a package of the recipe was compatible, the entire recipe would be excluded. This allows us some finer grained control over what exactly gets excluded. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-25license.bbclass: Whitespace standardizationElizabeth Flanagan1
Removing tabs within check_license_flags to standardize to 4 space tabbing Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-25license.bbclass: Add spdx mapping to GPL-1.0Elizabeth Flanagan1
Perl is GPL-1.0. For consistency sake, adding an spdx map for GPLv1 Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-22Fix common typoes "existant", "dependant" and variationsRobert P. J. Day1
Fix a couple common typoes, all contained within comments so there should be no effect on functionality. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-13license.bbclass: Add mapping for LGPLv2.0, pango uses itRichard Purdie1
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-05meta: Convert getVar/getVarFlag(xxx, 1) -> (xxx, True)Richard Purdie1
Using "1" with getVar is bad coding style and "True" is preferred. This patch is a sed over the meta directory of the form: sed \ -e 's:\(\.getVar([^,()]*, \)1 *):\1True):g' \ -e 's:\(\.getVarFlag([^,()]*, [^,()]*, \)1 *):\1True):g' \ -i `grep -ril getVar *` Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-02-24license.bbclass: Symbolic links of generic licenseElizabeth Flanagan1
This is to reduce the size of licenses added to images. With this commit license.manifest, original license and generic license adds about .5M to a core-image-minimal image, substantially less than what is currently occuring when COPY_LIC_MANIFEST and COPY_LIC_DIRS are set. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-02-24license.bbclass: Gather Pkg level licensesElizabeth Flanagan1
We should look for LICENSE at a package level first. If it's not found, we should use the recipe level LICENSE. This adds a bit more granularity to license manifests where needed. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-24license.bbclass: add support for LICENSE_FLAGSTom Zanussi1
LICENSE_FLAGS are a per-recipe replacement for the COMMERCIAL_LICENSE mechanism. In the COMMERCIAL_LICENSE mechanism, any package name mentioned in the global COMMERCIAL_LICENSE list is 'blacklisted' from being included in an image. To allow the blacklisted package into the image, the corresponding packages need to be removed from the COMMERCIAL_LICENSE list. This mechanism relies on a global list defined in default-distrovars.inc. The LICENSE_FLAGS mechanism essentially implements the same thing but turns the global blacklist into a per-recipe whitelist. Any recipe can optionally define one or more 'license flags'; if defined, each of the license flags defined for a recipe must have matching entries in a global LICENSE_FLAGS_WHITELIST variable. The definition of 'matching' is simple, but there are a couple things users need to know in order to correctly and effectively use it. Before we test a flag against the whitelist, we append _${PN} to it, thus automatically making each LICENSE_FLAG recipe-specific. We then try to match that string against the whitelist. So if the user specifies LICENSE_FLAGS = 'commercial' for recipe 'foo', the string 'commercial_foo' should be specified in the whitelist in order for it to match. However, the user can also broaden the match by putting any '_'-separated beginning subset of a LICENSE_FLAG in the whitelist, which will also match e.g. simply specifying 'commercial' in the whitelist would match any expanded LICENSE_FLAG starting with 'commercial' such as 'commercial_foo' and 'commercial_bar' which are the strings that would have been automatically generated if those recipes had simply specified LICENSE_FLAGS = 'commercial' This allows for a range of specificity for the items in the whitelist, from more general to perfectly specific. So users have the choice of exhaustively enumerating each license flag in the whitelist to allow only those specific recipes into the image, or of using a more general string to pick up anything matching just the first component(s). Note that this scheme works even if the flag already has _pn appended - the extra _pn is redundant, but doesn't affect the outcome e.g. a license flag of 'commercial_1.2_foo' would turn into 'commercial_1.2_foo_foo' and would match both the general 'commercial' and the specific 'commercial_1.2_foo' as expected (it would also match commercial_1.2_foo_foo' and 'commercial_1.2', which don't make much sense as far as something a user would think of specifying in the whitelist). For a versioned string, the user could instead specify 'commercial_foo_1.2', which would turn into 'commercial_foo_1.2_foo', but which would as expected allow the user to pick up this package along with anything else 'commercial' by specifying 'commercial' in the whitelist, or anything with a 'commercial_foo' license regardless of version by using 'commercial_foo' in the whitelist, or 'commercial_foo_1.1' to be completely specific about package and version. The current behavior of COMMERCIAL_LICENSE is replicated as mentioned above by having the current set of COMMERCIAL_LICENSE flags implemented using LICENSE_FLAGS = "commercial". That being the case, the current COMMERCIAL_LICENSE can equivalently be specified in the new scheme by putting the below in local.conf: # This is a list of packages that require a commercial license to ship # product. If shipped as part of an image these packages may have # implications so they are disabled by default. To enable them, # un-comment the below as appropriate. #LICENSE_FLAGS_WHITELIST = "commercial_gst-fluendo-mp3 \ # commercial_gst-openmax \ # commercial_gst-plugins-ugly \ # commercial_lame \ # commercial_libmad \ # commercial_libomxil \ # commercial_mpeg2dec \ # commercial_qmmp" The above allows all of the current COMMERCIAL_LICENSE packages in - to disallow a particular package from appearing in the image, simply remove it from the whitelist. To allow them all in, you could also specify LICENSE_FLAGS_WHITELIST = "commercial". Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
2012-01-10license.bbclass base.bbclass: support for 'or' operand in LICENSE and for ↵Andrei Gherzan1
SPDX license names A new function was defined in license.bbclass in order to correctly exclude packages where OE-Style licence naming is used. In this way licenses as GPL-3, GPLv3, GPLv3.0 etc will be excluded from a non-GPLv3 build. This function takes into consideration if 'or' operand is used. The function defined in license.bbclass is called in base.bbclass where packages are excluded based on INCOMPATIBLE_LICENSE variable. [YOCTO #1884] [YOCTO #1844] Signed-off-by: Andrei Gherzan <andrei at gherzan.ro> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-21license: Fix manifest conditionalBeth Flanagan1
The manifest conditionals COPY_LIC_MANIFEST and COPY_LIC_DIRS were returning true due to missing quotes in the bash test. This made images larger than expected. Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-16license.bbclass: remove bashismElizabeth Flanagan1
Removing a bashism that was dumping errors into rootfs log. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-12license: PR bump failureElizabeth Flanagan1
This addtask for do_populate_lic should be reverted back to before do_package as before do_compile causes failures when recipes are updated. [YOCTO #1819] Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com>
2011-12-10license/copyleft: exception for ast parseElizabeth Flanagan1
As the standard for LICENSE format is not well defined, we may well run into issues where LICENSE cannot be parsed via ast. In cases like this, we need to warn and continue. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-10license.bbclass: remove deb exclusionElizabeth Flanagan1
This commit requires 4a13766c7b223d as it removes the exclusion of deb package types from license manifest creation. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-10license.bbclass: remove bashism.Elizabeth Flanagan1
bashism in create_license_manifest removed. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-08[YOCTO #1776] license: manifest and license pathElizabeth Flanagan1
This is a fairly large commit, so I want to step through some of what this accomplishes: 1. Additional licenses I've added/modified/corrected some of the common licenses within OE-core in prep. for a major license audit. Most of these are in SPDX format. A few, there is no OSI equivalent. 2. Additional SPDX mappings I've added some additional SPDX mappings to account for removing some duplicate licenses. (ie GPL-2 and GPL-2.0 were the same) I've also remapped a few things to more accurately reflect what they should be pointing at. Note: Artistic/LGPL/GPL/MPL. Quite a few LICENSE fields list these licenses. They make no sense and need auditing. In a future commit I have some fixes to particularly egregious LICENSE fields, but a full audit should be done. I've listed to obvious candidates at: https://wiki.yoctoproject.org/wiki/License_Audit 3. License manifest We now have a license manifest generation that occurs in rootfs for everything BUT .deb. This requires the changes Paul Eggleton has done to rootfs_* particularly the list_installed_packages function. The manifest is accurate during a parallel bitbake now (Weee!) and is prime for my planned SPDX format manifest during the next period. 4. License manifest on image. We also want the ability to add licenses to the image. This functionality is also in base-files and will be stripped out in my next commit. The manifest is not added by default and is a two var setting in license.conf: If I want *just* the manifest on the image (small) then I set: COPY_LIC_MANIFEST = "1" This copies the manifest to: /usr/share/common-licenses/license.manifest If I want the actual PKG license text on the image (much larger) I need to set both both COPY_LIC_MANIFEST and COPY_LIC_DIRS in license.conf. This will create: /usr/share/common-licenses/(package name)/(licenses in LIC_SRC_URI) Word of warning. This can be larger than wanted depending on image and is probably ripe for linking licenses, but I ran out of time this week to get that done. 5. Custom License search path. We now have the ability to add licenses to the build without touching common-licenses. This is set via license.conf: LICENSE_PATH += "/path/to/custom/licenses" You want to make sure the license is unique. license.bbclass picks the first license it finds. Signed-off-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com>
2011-12-08license: split license parsing into oe.licenseChristopher Larson1
In addition to moving this functionality to oe.license, makes the string preparation more picky before passing it off to the ast compilation. This ensures that LICENSE entries like 'GPL/BSD' are seen as invalid (due to the presence of the unsupported '/'). Signed-off-by: Christopher Larson <kergoth@gmail.com>
2011-11-10Convert to use direct access to the data store (instead of bb.data.*Var*())Richard Purdie1
This is the result of running the following over the metadata: sed \ -e 's:bb.data.\(setVar([^,()]*,[^,()]*\), *\([^ )]*\) *):\2.\1):g' \ -e 's:bb.data.\(setVarFlag([^,()]*,[^,()]*,[^,()]*\), *\([^) ]*\) *):\2.\1):g' \ -e 's:bb.data.\(getVar([^,()]*\), *\([^(), ]*\) *,\([^)]*\)):\2.\1,\3):g' \ -e 's:bb.data.\(getVarFlag([^,()]*,[^,()]*\), *\([^(), ]*\) *,\([^)]*\)):\2.\1,\3):g' \ -e 's:bb.data.\(getVarFlag([^,()]*,[^,()]*\), *\([^() ]*\) *):\2.\1):g' \ -e 's:bb.data.\(getVar([^,()]*\), *\([^) ]*\) *):\2.\1):g' \ -i `grep -ril bb.data *` Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-07libcense.bbclass: fix OpenSSL mappingMartin Jansa1
[YOCTO #1712] Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com> Fixed YOCTO bug format and location Signed-off-by: Saul Wold <sgw@linux.intel.com>
2011-05-29license.bbclass: Infinite recursion of or nodesBeth Flanagan1
This fixes two bugs. When populate_lic was hitting | it was going into an infinite recursion of the node. Also, some LICENSE fields may start with "(". We want to avoid invalid python syntax here, so we strip out the whitespace. Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
2011-05-27license.bbclass: Sane Parsing of licensesBeth Flanagan1
This is a first pass at sane license parsing, using python abstract syntax trees. A few notes on this since ast is not generally used. I massage the LICENSE field to be more pythonesque and then create an ast. I then dump the ast and using a LicenseVisitor class, recurse through the tree, looking for licenses. I then copy and link. It's cleaner, allows for easier addition of logic and while it takes slightly more CPU, it's also slightly faster in initial small scale tests. It doesn't recognize the '+' or '*' modifiers to the licenses yet nor does it know what to do with bitors (|), since I'm not even sure what to do with them. Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
2011-05-17license bbclass: put licenses in DEPLOY_DIR/licenses to avoid sstate ↵Koen Kooi1
problems when MACHINE is part of DEPLOY_DIR_IMAGE See http://lists.linuxtogo.org/pipermail/openembedded-core/2011-May/002535.html for more info. Signed-off-by: Koen Kooi <koen@dominion.thruhere.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21Further cleanup of various poky referencesRichard Purdie1
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-01Fixing type: license.bbclassBeth Flanagan1
Munged a tab. Fixing Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
2011-03-01Fixing my bad license parsing: license.bbclassBeth Flanagan1
Fix to my bad license parsing. Also added the MIT generic license files. Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
2011-03-01[BUG:650] Fix LICENSE parsing: license.bblcassBeth Flanagan1
LICENSE parsing was missing some cases. Fixed Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
2011-02-03license.bbclass: Add coverage by sstate code (also use cleandirs and dirs ↵Richard Purdie1
task attribures for directory handling) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-01-31license.bbclass: don't mark it as 'nostamp'Kevin Tian1
'nostamp' is normally used for some standalone tasks like clean, checkuri, etc. It doesn't make sense to mark do_populate_lic as 'nostamp', which is depended by do_package. No stamp file in the build dependency chain implicates that do_package needs to be reinvoked and thus further do_package_write* stuff. This together with another sstate bug fully confused recent master, that people keep observing unnecessary do_package rebuilt with or without change. Below is a short explanation for two behaviors we observed: a) a fresh build, and then bitbake same target w/o any change. User will observe one unnecessary rebuild and then later rebuild is fine: [1st rebuild] * do_populate_lic has no stamp, and thus do_package is thought not current * do_package_setscene is then invoked with stamp file created * then later do_package_write*** also are rebuilt [2nd and later rebuild] * do_populate_lic has no stamp, and thus do_package is thought not current * do_package_setscene has stamp file and thus no need to re-execute setscene * thus no further rebuild required b) a fresh build, and then adjust order of PACKAGE_CLASSES. There's one bug regarding to PACKAGE_CLASSES and do_package_setscene, that only switch the order in PACKAGE_CLASSES generates different checksum. In this case user may observe up to 3 rebuilds when switching package_rpm/package_ipk back and forth. Signed-off-by: Lianhao Lu <lianhao.lu@intel.com> Signed-off-by: Kevin Tian <kevin.tian@intel.com>
2011-01-31license.bbclass: handle | (or) in the LICENSE fieldJoshua Lock1
The class strips out operators from the LICENSE field and to reduce it to a list of license, | was missing but is quite frequently used so add it to the list of replaced characters. Signed-off-by: Joshua Lock <josh@linux.intel.com>
2011-01-28Initial commit of license reporting:Beth Flanagan1
This is an intial commit for the license reporting system. A few notes: The LICENSE fields needs to be standardized throughout poky. As it stands, we throw a warning if the license file is not found (either because it does not exist or because LICENSE_FILE_CHKSUM is munged) in the generic license directory. This should eventually become an error. I've seen a few places where Apache-v2.0 is written differently and I'm sure this will throw the above warning. This does not put the license data on the rootfs. Also, I provide both the actual license text and a link to the best guess of the generic_license. That guessing is not very robust and I'm loath to get into a bunch of pattern matching rather than standardize LICENSE. This adds one new param to poky.conf and one new to license.bbclass: LICENSE_DIR: the base directory we copy all the license results to (set in license.bbclass) COMMON_LICENSE_DIR: this is the directory that holds all the common generic license files. currently meta/files/common-licenses (set in poky.conf) TODO: - We should verify the common-licenses. I stripped these from my Ubuntu 10.10 system. - We should allow the capability of licenses on the rootfs, although the resulting image created would be a lot larger. - More common-licenses. I don't include bzip, zlib, ICS.... I should, but that means tracking down a lot of licenses. - General cleanup of licensing and standardization of names. We should standardize on a naming convention. What's in licenses.conf should match up with what is in the recipes which should match with what is in common-licenses. Outside the scope of this though. See: http://bugzilla.pokylinux.org/show_bug.cgi?id=650