From: Zac Medico <zmedico@gentoo.org>
Date: Mon, 23 Mar 2009 02:16:34 +0000 (-0000)
Subject: Add docstrings for the fd_pipes and returnpid parameters of doebuild().
X-Git-Tag: v2.1.6.10~15
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=61b936f49630797342015edbf29ddffdbb816a38;p=portage.git

Add docstrings for the fd_pipes and returnpid parameters of doebuild().
(trunk r13135)

svn path=/main/branches/2.1.6/; revision=13154
---

diff --git a/pym/portage/__init__.py b/pym/portage/__init__.py
index 343a53b6a..2c4b447b6 100644
--- a/pym/portage/__init__.py
+++ b/pym/portage/__init__.py
@@ -5509,6 +5509,13 @@ def doebuild(myebuild, mydo, myroot, mysettings, debug=0, listonly=0,
 	@type vartree: vartree instance
 	@param prev_mtimes: A dict of { filename:mtime } keys used by merge() to do config_protection
 	@type prev_mtimes: dictionary
+	@param fd_pipes: A dict of mapping for pipes, { '0': stdin, '1': stdout }
+		for example.
+	@type fd_pipes: Dictionary
+	@param returnpid: Return a list of process IDs for a successful spawn, or
+		in integer value if spawn is unsuccessful. NOTE: This requires the
+		caller clean up all returned PIDs.
+	@type returnpid: Boolean
 	@rtype: Boolean
 	@returns:
 	1. 0 for success