Update --depclean and package.provided docs to indicate interaction

between them.

svn path=/main/trunk/; revision=10563

3 files changed, 51 insertions, 25 deletions

diff --git a/man/emerge.1 b/man/emerge.1
index 5bb48952d..b01e8374e 100644
--- a/man/emerge.1
+++ b/man/emerge.1
@@ -97,17 +97,23 @@ setups that the user may wish to run.
 .BR \-\-depclean
 Cleans the system by removing packages that are not associated
 with explicitly merged packages. Depclean works by creating the
-full dependency tree from the system list and the world file,
+full dependency tree from the system and world sets,
 then comparing it to installed packages. Packages installed, but
-not associated with an explicit merge are listed as candidates
-for unmerging. Inexperienced users are advised to use \fB\-\-pretend\fR
+not part of the dependency tree, will be uninstalled by depclean.
+Inexperienced users are advised to use \fB\-\-pretend\fR
 with this option in order to see a preview of which packages
-will be uninstalled. \fBWARNING: Removing some
+will be uninstalled.
+
+\fBWARNING: Removing some
 packages may cause packages which link to the removed package 
 to stop working and complain about missing libraries.\fR
 Rebuild the complaining package to fix this issue.  Also see
 \fB\-\-with\-bdeps\fR for behavior with respect to build time dependencies that
-are not strictly required. Depclean serves as a dependency aware
+are not strictly required. Note that packages listed in
+package.provided (see \fBportage\fR(5)) may be removed by
+depclean, even if they are part of the world set.
+
+Depclean serves as a dependency aware
 version of \fB\-\-unmerge\fR. When given one or more atoms, it will
 unmerge matched packages that have no reverse dependencies. Use
 \fB\-\-depclean\fR together with \fB\-\-verbose\fR to show reverse
diff --git a/man/portage.5 b/man/portage.5
index 9164ada88..d6eb83cb6 100644
--- a/man/portage.5
+++ b/man/portage.5
@@ -213,15 +213,20 @@ useful for stage builders.
 .TP
 .BR package.provided
 A list of packages (one per line) that portage should assume have been 
-provided.  Useful for porting to non-Linux systems.  Portage will not 
-attempt to update a package that is listed here unless another package 
-explicitly requires a version that is newer than what has been listed.  
-Basically, it's a list that replaces the \fBemerge \-\-inject\fR syntax.
+provided.  Useful for porting to non-Linux systems. Basically, it's a
+list that replaces the \fBemerge \-\-inject\fR syntax.
 
 For example, if you manage your own copy of a 2.6 kernel, then you can 
 tell portage that 'sys-kernel/development-sources-2.6.7' is already taken 
 care of and it should get off your back about it.
 
+Portage will not attempt to update a package that is listed here unless
+another package explicitly requires a version that is newer than what
+has been listed. Dependencies that are satisfied by package.provided
+entries may cause installed packages satisfying equivalent dependencies
+to be removed by \fBemerge\fR(1) \fB\-\-depclean\fR actions (see the
+\fBACTIONS\fR section of the \fBemerge\fR(1) man page for more information).
+
 Virtual packages (virtual/*) should not be specified in package.provided.
 Depending on the type of virtual, it may be necessary to add an entry to the
 virtuals file and/or add a package that satisfies a virtual to
diff --git a/pym/_emerge/help.py b/pym/_emerge/help.py
index 1e3f54aff..1996a61ab 100644
--- a/pym/_emerge/help.py
+++ b/pym/_emerge/help.py
@@ -65,22 +65,37 @@ def help(myaction,myopts,havecolor=1):
 		print "              file setup or other similar setups that the user may wish to run."
 		print
 		print "       "+green("--depclean")
-		print "              Cleans the system by removing packages that are not associated"
-		print "              with explicitly merged packages. Depclean works by creating the"
-		print "              full dependency tree from the system list and the world file,"
-		print "              then comparing it to installed packages. Packages installed, but"
-		print "              not associated with an explicit merge are listed as candidates"
-		print "              for unmerging. Inexperienced users are advised to use --pretend"
-		print "              with this option in order to see a preview of which packages will"
-		print "              be uninstalled. "+turquoise(" WARNING: Removing some packages may cause")
-		print "              "+turquoise("packages which link to the removed package to stop working and")
-		print "              "+turquoise("complain about missing libraries. Rebuild the complaining package")
-		print "              "+turquoise("to fix this issue.")+" Also see --with-bdeps for behavior with"
-		print "              respect to build time dependencies that are not strictly"
-		print "              required. Depclean serves as a dependency aware version of"
-		print "              --unmerge. When given one or more atoms, it will unmerge matched"
-		print "              packages that have no reverse dependencies. Use --depclean"
-		print "              together with --verbose to show reverse dependencies."
+		paragraph = "Cleans the system by removing packages that are not associated " + \
+			"with explicitly merged packages. Depclean works by creating the " + \
+			"full dependency tree from the system and world sets, " + \
+			"then comparing it to installed packages. Packages installed, but " + \
+			"not part of the dependency tree, will be uninstalled by depclean. " + \
+			"Inexperienced users are advised to use --pretend " + \
+			"with this option in order to see a preview of which packages " + \
+			"will be uninstalled."
+		for line in wrap(paragraph, desc_width):
+			print desc_indent + line
+		print
+
+		paragraph =  "WARNING: Removing some " + \
+			"packages may cause packages which link to the removed package  " + \
+			"to stop working and complain about missing libraries. " + \
+			"Rebuild the complaining package to fix this issue.  Also see " + \
+			"--with-bdeps for behavior with respect to build time dependencies that " + \
+			"are not strictly required. Note that packages listed in " + \
+			"package.provided (see portage(5)) may be removed by " + \
+			"depclean, even if they are part of the world set."
+		for line in wrap(paragraph, desc_width):
+			print desc_indent + line
+		print
+
+		paragraph = "Depclean serves as a dependency aware " + \
+			"version of --unmerge. When given one or more atoms, it will " + \
+			"unmerge matched packages that have no reverse dependencies. Use " + \
+			"--depclean together with --verbose to show reverse " + \
+			"dependencies."
+		for line in wrap(paragraph, desc_width):
+			print desc_indent + line
 		print
 		print "       "+green("--info")
 		print "              Displays important portage variables that will be exported to"