From: Zac Medico <zmedico@gentoo.org>
Date: Wed, 14 Jul 2010 02:31:41 +0000 (-0700)
Subject: Use epytext markup in rewrite_lafile() docstring, and add note about
X-Git-Tag: v2.2_rc68~507
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=c30b707e5a98420ef4c780f9f6b60f4e990a2c32;p=portage.git

Use epytext markup in rewrite_lafile() docstring, and add note about
use of raw bytes.
---

diff --git a/pym/portage/util/lafilefixer.py b/pym/portage/util/lafilefixer.py
index 3c39a49f5..7d6171c16 100644
--- a/pym/portage/util/lafilefixer.py
+++ b/pym/portage/util/lafilefixer.py
@@ -74,10 +74,14 @@ def _parse_lafile_contents(contents):
 def rewrite_lafile(contents):
 	"""
 	Given the contents of an .la file, parse and fix it.
-	Returns a bool, string tuple. 
-	The bool indicates if the file needs fixing.
-	The string contains the fixed contents if the file needs fixing.
+	This operates with strings of raw bytes (assumed to contain some ascii
+	characters), in order to avoid any potential character encoding issues.
 	Raises 'InvalidData' if the .la file is invalid.
+	@param contents: the contents of a libtool archive file
+	@type contents: bytes
+	@rtype: tuple
+	@returns: (True, fixed_contents) if something needed to be
+		fixed, (False, None) otherwise.
 	"""
 	#Parse the 'dependency_libs' and 'inherited_linker_flags' lines.
 	dep_libs, inh_link_flags = \