From 891f15514e052b57d635db8bbc0bc14a535ddeb6 Mon Sep 17 00:00:00 2001 From: Zac Medico Date: Tue, 20 Mar 2007 22:08:41 +0000 Subject: Add a docstring to config.getMissingLicenses(). svn path=/main/trunk/; revision=6259 --- pym/portage/__init__.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pym/portage/__init__.py b/pym/portage/__init__.py index 485f89e06..11dca580a 100644 --- a/pym/portage/__init__.py +++ b/pym/portage/__init__.py @@ -1749,6 +1749,19 @@ class config: self.reset(keeping_pkg=1,use_cache=use_cache) def getMissingLicenses(self, licenses, cpv): + """ + Take a LICENSE string and return a list any licenses that the user may + may need to accept for the given package. The returned list will not + contain any licenses that have already been accepted. This method + can throw an InvalidDependString exception. + + @param licenses: A raw LICENSE string as returned form dbapi.aux_get() + @type licenses: String + @param cpv: The package name (for evaluation of USE conditionals) + @type cpv: String + @rtype: List + @return: A list of licenses that have not been accepted. + """ cpdict = self._plicensedict.get(dep_getkey(cpv), None) acceptable_licenses = self._accept_license.copy() if cpdict: -- cgit v1.2.3-1-g7c22