[patch] 0001-docompress-Update-description.patch

0001-docompress-Update-description.patch (text/plain), 2.70 KB, created by Ulrich Müller on 2011-02-03 16:23:32 UTC

From 20a06d34f3f9a5883a3eaeb5f5b5429848e8219c Mon Sep 17 00:00:00 2001
From: Ulrich Mueller <[e-mail]>
Date: Thu, 3 Feb 2011 17:07:31 +0100
Subject: [PATCH 1/4] docompress: Update description.

---
 ebuild-writing/eapi/text.xml |   33 ++++++++++++++++++++-------------
 1 files changed, 20 insertions(+), 13 deletions(-)

diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 819a9c0..c6111fb 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -414,11 +414,10 @@ src_install() {
 		<p><b>controllable compression via docompress</b></p>
 		<p>
 			To compress files in the destination-folder <c>${D}</c>, the
-			<c>docompress</c> command may be used (in <c>src_install</c>, after
-			the target files are in <c>${D}</c>).
+			<c>docompress</c> command may be used in <c>src_install</c>.
 			To control which items should be compressed and which shouldn't
-			be compressed, you may include and exclude directories. The default
-			inclusion list contains:
+			be compressed, you may include or exclude directories or plain
+			files. The default inclusion list contains:
 			<ul>
 				<li><c>/usr/share/doc</c></li>
 				<li><c>/usr/share/info</c></li>
@@ -428,16 +427,24 @@ src_install() {
 			<ul>
 				<li><c>/usr/share/doc/${PF}/html</c></li>
 			</ul>
-			When a directory is in- or excluded, all files and directories in the
-			given directories shall be added to the corresponding list. If a
-			file is in- or excluded, the file shall be added to the corresponding
-			list (exclusion is stronger than inclusion <d/> if a file is in both
-			lists, the inclusion will be ignored). If a non-existing file or
-			directory is given, it will be ignored.
-			If the first argument of <c>docompress</c> is <c>-x</c>, the item
-			specified will be added to the exclusion list, otherwise it will be
-			added to the inclusion list.
+			When a directory is in- or excluded, all files and directories in
+			the given directories shall be added to the corresponding list.
+			If a file is in- or excluded, the file shall be added to the
+			corresponding list (exclusion is stronger than inclusion <d/>
+			if a file is in both lists, the inclusion will be ignored).
 		</p>
+		<p>
+			If the first argument of <c>docompress</c> is <c>-x</c>, the items
+			specified will be added to the exclusion list, otherwise they will
+			be added to the inclusion list.
+		</p>
+		<note>
+			When <c>docompress</c> is called, it is <e>not</e> required that
+			the paths specified as its arguments are pointing to existing files
+			or directories. However, if a file still doesn't exist when
+			<c>src_install</c> has completed, it will be ignored with a
+			warning.
+		</note>
 	</li>
 </ul>
 </body>
-- 
1.7.4