Clean up/sync docs for emerge --sync, and add a note about PORTAGE_SYNC_STALE.

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

1 files changed, 20 insertions, 5 deletions

diff --git a/man/emerge.1 b/man/emerge.1
index d138d991c..072553432 100644
--- a/man/emerge.1
+++ b/man/emerge.1
@@ -212,11 +212,26 @@ the package name.  \fBTake caution\fR as the descriptions are also
 matched as regular expressions.
 .TP
 .BR \-\-sync
-Initiates a portage tree update with one of the rsync.gentoo.org
-mirrors.  \fBNote that any changes you have made to the portage
-tree will be erased\fR.  Except for special circumstances, 
-this uses \fBrsync\fR to do the update.  See \fBmake.conf\fR(5)'s 
-description of PORTDIR_OVERLAY for a method to avoid deletions.
+This updates the portage tree that is located in the
+directory that the PORTDIR variable refers to (default
+location is /usr/portage). The SYNC variable specifies
+the remote URI from which files will be synchronized.
+The \fBPORTAGE_SYNC_STALE\fR variable configures
+warnings that are shown when emerge \-\-sync has not
+been executed recently.
+
+\fBWARNING:\fR
+The emerge \-\-sync action will modify and/or delete
+files located inside the directory that the PORTDIR
+variable refers to (default location is /usr/portage).
+For more information, see the PORTDIR documentation in
+the make.conf(5) man page.
+
+\fBNOTE:\fR
+The \fBemerge\-webrsync\fR program will download the entire
+portage tree as a tarball, which is much faster than emerge
+\-\-sync for first time syncs.
+
 .TP
 .BR "\-\-unmerge " (\fB\-C\fR)
 \fBWARNING: This action can remove important packages!\fR Removes