[yum-commits] Branch 'yum-3_2_X' - docs/yum.8

[James Antill]

 docs/yum.8 |   14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

New commits:
commit a6efb65474cb2b023e4e021de0fbafad847f472d
Author: James Antill <james at and.org>
Date:   Mon Mar 7 10:33:50 2011 -0500

    Document --installroot a bit more, let people know about --releasever=/.

diff --git a/docs/yum.8 b/docs/yum.8
index 3b414e2..60fa2ea 100644
--- a/docs/yum.8
+++ b/docs/yum.8
@@ -406,7 +406,11 @@ Doesn't limit packages to their latest versions in the info, list and search
 commands (will also affect plugins which use the doPackageLists() API).
 .IP "\fB\-\-installroot=root\fP" 
 Specifies an alternative installroot, relative to which all packages will be
-installed.
+installed. Think of this like doing "chroot <root> yum" except using
+\-\-installroot allows yum to work before the chroot is created.
+Note: You may also want to use the option \-\-releasever=/ when creating the
+installroot as otherwise the $releasever value is taken from the rpmdb within
+the installroot (and thus. will be empty, before creation).
 .br
 Configuration Option: \fBinstallroot\fP
 .IP "\fB\-\-enablerepo=repoidglob\fP"
@@ -462,9 +466,11 @@ Configuration Option: \fBskip_broken\fP
 .br
 .IP "\fB\-\-releasever=version\fP"
 Pretend the current release version is the given string. This is very useful
-when combined with \-\-installroot. Note that with the default upstream cachedir,
-of /var/cache/yum, using this option will corrupt your cache (and you can use
-$releasever in your cachedir configuration to stop this).
+when combined with \-\-installroot. You can also use \-\-releasever=/ to take
+the releasever information from outside the installroot.
+Note that with the default upstream cachedir, of /var/cache/yum, using this
+option will corrupt your cache (and you can use $releasever in your cachedir
+configuration to stop this).
 .PP 
 .IP "\fB\-t, \-\-tolerant\fP"
 This option currently does nothing.