diff options
author | Zac Medico <zmedico@gentoo.org> | 2012-03-27 08:52:35 -0700 |
---|---|---|
committer | Zac Medico <zmedico@gentoo.org> | 2012-03-27 08:52:35 -0700 |
commit | b2147b15e11b3d30d646098696ef69d749aeb5b2 (patch) | |
tree | 87bd634e6a305434351128469ef000ed267ee441 /pym/portage | |
parent | ae8070542fcee0516fbfa270f6ef3f3e53a8d220 (diff) | |
download | portage-b2147b15e11b3d30d646098696ef69d749aeb5b2.tar.gz portage-b2147b15e11b3d30d646098696ef69d749aeb5b2.tar.bz2 portage-b2147b15e11b3d30d646098696ef69d749aeb5b2.zip |
Replace @returns with @return.
Diffstat (limited to 'pym/portage')
-rw-r--r-- | pym/portage/cache/mappings.py | 2 | ||||
-rw-r--r-- | pym/portage/dbapi/bintree.py | 6 | ||||
-rw-r--r-- | pym/portage/dbapi/porttree.py | 6 | ||||
-rw-r--r-- | pym/portage/dbapi/vartree.py | 10 | ||||
-rw-r--r-- | pym/portage/dep/__init__.py | 2 | ||||
-rw-r--r-- | pym/portage/env/loaders.py | 4 | ||||
-rw-r--r-- | pym/portage/glsa.py | 8 | ||||
-rw-r--r-- | pym/portage/news.py | 2 | ||||
-rw-r--r-- | pym/portage/package/ebuild/_ipc/QueryCommand.py | 2 | ||||
-rw-r--r-- | pym/portage/package/ebuild/digestcheck.py | 2 | ||||
-rw-r--r-- | pym/portage/package/ebuild/digestgen.py | 2 | ||||
-rw-r--r-- | pym/portage/package/ebuild/doebuild.py | 4 | ||||
-rw-r--r-- | pym/portage/process.py | 4 | ||||
-rw-r--r-- | pym/portage/util/ExtractKernelVersion.py | 2 | ||||
-rw-r--r-- | pym/portage/util/__init__.py | 2 | ||||
-rw-r--r-- | pym/portage/util/_dyn_libs/PreservedLibsRegistry.py | 2 | ||||
-rw-r--r-- | pym/portage/util/_eventloop/EventLoop.py | 2 | ||||
-rw-r--r-- | pym/portage/util/_pty.py | 2 | ||||
-rw-r--r-- | pym/portage/util/lafilefixer.py | 2 | ||||
-rw-r--r-- | pym/portage/util/listdir.py | 2 |
20 files changed, 34 insertions, 34 deletions
diff --git a/pym/portage/cache/mappings.py b/pym/portage/cache/mappings.py index 60a918e01..bc8ce9af8 100644 --- a/pym/portage/cache/mappings.py +++ b/pym/portage/cache/mappings.py @@ -316,7 +316,7 @@ def slot_dict_class(keys, prefix="_val_"): attribute names from keys @type prefix: String @rtype: SlotDict - @returns: A class that constructs SlotDict instances + @return: A class that constructs SlotDict instances having the specified keys. """ if isinstance(keys, frozenset): diff --git a/pym/portage/dbapi/bintree.py b/pym/portage/dbapi/bintree.py index 31ba364a4..2295b9f59 100644 --- a/pym/portage/dbapi/bintree.py +++ b/pym/portage/dbapi/bintree.py @@ -214,7 +214,7 @@ def _pkgindex_cpv_map_latest_build(pkgindex): @param pkgindex: A PackageIndex instance. @type pkgindex: PackageIndex @rtype: dict - @returns: a dict containing entry for the give cpv. + @return: a dict containing entry for the give cpv. """ cpv_map = {} @@ -1157,7 +1157,7 @@ class binarytree(object): Performs checksums and evaluates USE flag conditionals. Raises InvalidDependString if necessary. @rtype: dict - @returns: a dict containing entry for the give cpv. + @return: a dict containing entry for the give cpv. """ pkg_path = self.getname(cpv) @@ -1363,7 +1363,7 @@ class binarytree(object): Verify digests for the given package and raise DigestException if verification fails. @rtype: bool - @returns: True if digests could be located, False otherwise. + @return: True if digests could be located, False otherwise. """ cpv = pkg if not isinstance(cpv, basestring): diff --git a/pym/portage/dbapi/porttree.py b/pym/portage/dbapi/porttree.py index 233a2c1d1..382bcda43 100644 --- a/pym/portage/dbapi/porttree.py +++ b/pym/portage/dbapi/porttree.py @@ -254,7 +254,7 @@ class portdbapi(dbapi): @param canonical_repo_path: the canonical path of a repository, as resolved by os.path.realpath() @type canonical_repo_path: String - @returns: The repo_name for the corresponding repository, or None + @return: The repo_name for the corresponding repository, or None if the path does not correspond a known repository @rtype: String or None """ @@ -331,7 +331,7 @@ class portdbapi(dbapi): Create an EbuildMetadataPhase instance to generate metadata for the give ebuild. @rtype: EbuildMetadataPhase - @returns: A new EbuildMetadataPhase instance, or None if the + @return: A new EbuildMetadataPhase instance, or None if the metadata cache is already valid. """ metadata, ebuild_hash = self._pull_valid_cache(cpv, ebuild_path, repo_path) @@ -551,7 +551,7 @@ class portdbapi(dbapi): @param mytree: The canonical path of the tree in which the ebuild is located, or None for automatic lookup @type mypkg: String - @returns: A dict which maps each file name to a set of alternative + @return: A dict which maps each file name to a set of alternative URIs. @rtype: dict """ diff --git a/pym/portage/dbapi/vartree.py b/pym/portage/dbapi/vartree.py index 3e603e233..25ea4c189 100644 --- a/pym/portage/dbapi/vartree.py +++ b/pym/portage/dbapi/vartree.py @@ -921,7 +921,7 @@ class vardbapi(dbapi): @param myroot: ignored, self._eroot is used instead @param mycpv: ignored @rtype: int - @returns: new counter value + @return: new counter value """ myroot = None mycpv = None @@ -1732,7 +1732,7 @@ class dblink(object): PreservedLibsRegistry yet. @type preserve_paths: set @rtype: Integer - @returns: + @return: 1. os.EX_OK if everything went well. 2. return code of the failed phase (for prerm, postrm, cleanrm) """ @@ -2546,7 +2546,7 @@ class dblink(object): @param destroot: @type destroot: @rtype: Boolean - @returns: + @return: 1. True if this package owns the file. 2. False if this package does not own the file. """ @@ -3376,7 +3376,7 @@ class dblink(object): @param prev_mtimes: { Filename:mtime } mapping for env_update @type prev_mtimes: Dictionary @rtype: Boolean - @returns: + @return: 1. 0 on success 2. 1 on failure @@ -4193,7 +4193,7 @@ class dblink(object): @param thismtime: The current time (typically long(time.time()) @type thismtime: Long @rtype: None or Boolean - @returns: + @return: 1. True on failure 2. None otherwise diff --git a/pym/portage/dep/__init__.py b/pym/portage/dep/__init__.py index 389916f8e..3832b0bde 100644 --- a/pym/portage/dep/__init__.py +++ b/pym/portage/dep/__init__.py @@ -62,7 +62,7 @@ def cpvequal(cpv1, cpv2): @param cpv2: CategoryPackageVersion (no operators) Example: "sys-apps/portage-2.1" @type cpv2: String @rtype: Boolean - @returns: + @return: 1. True if cpv1 = cpv2 2. False Otherwise 3. Throws PortageException if cpv1 or cpv2 is not a CPV diff --git a/pym/portage/env/loaders.py b/pym/portage/env/loaders.py index b540fbbd3..372bc12fa 100644 --- a/pym/portage/env/loaders.py +++ b/pym/portage/env/loaders.py @@ -40,7 +40,7 @@ def RecursiveFileLoader(filename): @param filename: name of a file/directory to traverse @rtype: list - @returns: List of files to process + @return: List of files to process """ try: @@ -139,7 +139,7 @@ class FileLoader(DataLoader): load all files in self.fname @type: Boolean @rtype: tuple - @returns: + @return: Returns (data,errors), both may be empty dicts or populated. """ data = {} diff --git a/pym/portage/glsa.py b/pym/portage/glsa.py index a784d14e1..2df7ec3a7 100644 --- a/pym/portage/glsa.py +++ b/pym/portage/glsa.py @@ -488,7 +488,7 @@ class Glsa: @type myfile: String @param myfile: Filename to grab the XML data from @rtype: None - @returns: None + @return: None """ self.DOM = xml.dom.minidom.parse(myfile) if not self.DOM.doctype: @@ -634,7 +634,7 @@ class Glsa: architectures. @rtype: Boolean - @returns: True if the system is affected, False if not + @return: True if the system is affected, False if not """ rValue = False for k in self.packages: @@ -654,7 +654,7 @@ class Glsa: GLSA was already applied. @rtype: Boolean - @returns: True if the GLSA was applied, False if not + @return: True if the GLSA was applied, False if not """ return (self.nr in get_applied_glsas(self.config)) @@ -665,7 +665,7 @@ class Glsa: applied or on explicit user request. @rtype: None - @returns: None + @return: None """ if not self.isApplied(): checkfile = io.open( diff --git a/pym/portage/news.py b/pym/portage/news.py index f34fd6ff8..bbd93257a 100644 --- a/pym/portage/news.py +++ b/pym/portage/news.py @@ -370,7 +370,7 @@ def count_unread_news(portdb, vardb, repos=None, update=True): @param update: check for new items (default is True) @type update: boolean @rtype: dict - @returns: dictionary mapping repos to integer counts of unread news items + @return: dictionary mapping repos to integer counts of unread news items """ NEWS_PATH = os.path.join("metadata", "news") diff --git a/pym/portage/package/ebuild/_ipc/QueryCommand.py b/pym/portage/package/ebuild/_ipc/QueryCommand.py index 949a14801..7bbb0e83b 100644 --- a/pym/portage/package/ebuild/_ipc/QueryCommand.py +++ b/pym/portage/package/ebuild/_ipc/QueryCommand.py @@ -27,7 +27,7 @@ class QueryCommand(IpcCommand): def __call__(self, argv): """ - @returns: tuple of (stdout, stderr, returncode) + @return: tuple of (stdout, stderr, returncode) """ cmd, root, atom_str = argv diff --git a/pym/portage/package/ebuild/digestcheck.py b/pym/portage/package/ebuild/digestcheck.py index c8d168e0f..8705639d1 100644 --- a/pym/portage/package/ebuild/digestcheck.py +++ b/pym/portage/package/ebuild/digestcheck.py @@ -15,7 +15,7 @@ def digestcheck(myfiles, mysettings, strict=False, justmanifest=None, mf=None): """ Verifies checksums. Assumes all files have been downloaded. @rtype: int - @returns: 1 on success and 0 on failure + @return: 1 on success and 0 on failure """ if justmanifest is not None: diff --git a/pym/portage/package/ebuild/digestgen.py b/pym/portage/package/ebuild/digestgen.py index 38e9991bd..6ad339737 100644 --- a/pym/portage/package/ebuild/digestgen.py +++ b/pym/portage/package/ebuild/digestgen.py @@ -33,7 +33,7 @@ def digestgen(myarchives=None, mysettings=None, myportdb=None): @param myportdb: a portdbapi instance @type myportdb: portdbapi @rtype: int - @returns: 1 on success and 0 on failure + @return: 1 on success and 0 on failure """ if mysettings is None or myportdb is None: raise TypeError("portage.digestgen(): 'mysettings' and 'myportdb' parameter are required.") diff --git a/pym/portage/package/ebuild/doebuild.py b/pym/portage/package/ebuild/doebuild.py index ffad4563f..49672e107 100644 --- a/pym/portage/package/ebuild/doebuild.py +++ b/pym/portage/package/ebuild/doebuild.py @@ -480,7 +480,7 @@ def doebuild(myebuild, mydo, _unused=None, settings=None, debug=0, listonly=0, caller clean up all returned PIDs. @type returnpid: Boolean @rtype: Boolean - @returns: + @return: 1. 0 for success 2. 1 for error @@ -1368,7 +1368,7 @@ def spawn(mystring, mysettings, debug=0, free=0, droppriv=0, sesandbox=0, fakero @param keywords: Extra options encoded as a dict, to be passed to spawn @type keywords: Dictionary @rtype: Integer - @returns: + @return: 1. The return code of the spawned process. """ diff --git a/pym/portage/process.py b/pym/portage/process.py index febaf662e..94687eaa0 100644 --- a/pym/portage/process.py +++ b/pym/portage/process.py @@ -354,7 +354,7 @@ def _exec(binary, mycommand, opt_name, fd_pipes, env, gid, groups, uid, umask, @param pre_exec: A function to be called with no arguments just prior to the exec call. @type pre_exec: callable @rtype: None - @returns: Never returns (calls os.execve) + @return: Never returns (calls os.execve) """ # If the process we're creating hasn't been given a name @@ -429,7 +429,7 @@ def find_binary(binary): @param binary: Name of the binary to find @type string @rtype: None or string - @returns: full path to binary or None if the binary could not be located. + @return: full path to binary or None if the binary could not be located. """ for path in os.environ.get("PATH", "").split(":"): filename = "%s/%s" % (path, binary) diff --git a/pym/portage/util/ExtractKernelVersion.py b/pym/portage/util/ExtractKernelVersion.py index 49957f5fb..69bd58a68 100644 --- a/pym/portage/util/ExtractKernelVersion.py +++ b/pym/portage/util/ExtractKernelVersion.py @@ -14,7 +14,7 @@ def ExtractKernelVersion(base_dir): @param base_dir: Path to sources (usually /usr/src/linux) @type base_dir: string @rtype: tuple( version[string], error[string]) - @returns: + @return: 1. tuple( version[string], error[string]) Either version or error is populated (but never both) diff --git a/pym/portage/util/__init__.py b/pym/portage/util/__init__.py index 02fb75dfd..dd692a13a 100644 --- a/pym/portage/util/__init__.py +++ b/pym/portage/util/__init__.py @@ -346,7 +346,7 @@ def grabdict(myfilename, juststrings=0, empty=0, recursive=0, incremental=1): @param incremental: Append to the return list, don't overwrite @type incremental: Boolean (integer) @rtype: Dictionary - @returns: + @return: 1. Returns the lines in a file in a dictionary, for example: 'sys-apps/portage x86 amd64 ppc' would return diff --git a/pym/portage/util/_dyn_libs/PreservedLibsRegistry.py b/pym/portage/util/_dyn_libs/PreservedLibsRegistry.py index 26da0cf20..4bc64dbfe 100644 --- a/pym/portage/util/_dyn_libs/PreservedLibsRegistry.py +++ b/pym/portage/util/_dyn_libs/PreservedLibsRegistry.py @@ -242,7 +242,7 @@ class PreservedLibsRegistry(object): def getPreservedLibs(self): """ Return a mapping of packages->preserved objects. - @returns mapping of package instances to preserved objects + @return mapping of package instances to preserved objects @rtype Dict cpv->list-of-paths """ if self._data is None: diff --git a/pym/portage/util/_eventloop/EventLoop.py b/pym/portage/util/_eventloop/EventLoop.py index a2d4cd40b..ef20ce401 100644 --- a/pym/portage/util/_eventloop/EventLoop.py +++ b/pym/portage/util/_eventloop/EventLoop.py @@ -435,7 +435,7 @@ def can_poll_device(): Test if it's possible to use poll() on a device such as a pty. This is known to fail on Darwin. @rtype: bool - @returns: True if poll() on a device succeeds, False otherwise. + @return: True if poll() on a device succeeds, False otherwise. """ global _can_poll_device diff --git a/pym/portage/util/_pty.py b/pym/portage/util/_pty.py index 95082cf5b..11c8b92af 100644 --- a/pym/portage/util/_pty.py +++ b/pym/portage/util/_pty.py @@ -27,7 +27,7 @@ def _create_pty_or_pipe(copy_term_size=None): then the term size will be copied to the pty. @type copy_term_size: int @rtype: tuple - @returns: A tuple of (is_pty, master_fd, slave_fd) where + @return: A tuple of (is_pty, master_fd, slave_fd) where is_pty is True if a pty was successfully allocated, and False if a normal pipe was allocated. """ diff --git a/pym/portage/util/lafilefixer.py b/pym/portage/util/lafilefixer.py index 2b093d87b..54ff20de5 100644 --- a/pym/portage/util/lafilefixer.py +++ b/pym/portage/util/lafilefixer.py @@ -80,7 +80,7 @@ def rewrite_lafile(contents): @param contents: the contents of a libtool archive file @type contents: bytes @rtype: tuple - @returns: (True, fixed_contents) if something needed to be + @return: (True, fixed_contents) if something needed to be fixed, (False, None) otherwise. """ #Parse the 'dependency_libs' and 'inherited_linker_flags' lines. diff --git a/pym/portage/util/listdir.py b/pym/portage/util/listdir.py index 5753d2f97..c2628cbfe 100644 --- a/pym/portage/util/listdir.py +++ b/pym/portage/util/listdir.py @@ -109,7 +109,7 @@ def listdir(mypath, recursive=False, filesonly=False, ignorecvs=False, ignorelis @param dirsonly: Only return directories. @type dirsonly: Boolean @rtype: List - @returns: A list of files and directories (or just files or just directories) or an empty list. + @return: A list of files and directories (or just files or just directories) or an empty list. """ list, ftype = cacheddir(mypath, ignorecvs, ignorelist, EmptyOnError, followSymlinks) |