Rename the undocumented --conistent option to --complete-graph and add

some docs. (trunk r9846)

svn path=/main/branches/2.1.2/; revision=9847

diff --git a/bin/emerge b/bin/emerge
index cc4b8b27b85a2553d88af2dd30e05a6af3a350b1..8f12145a7e44349cdd984f76a1f877b2a74952af 100755 (executable)
--- a/bin/emerge
+++ b/bin/emerge
@@ -188,7 +188,7 @@ options=[
 "--ask",          "--alphabetical",
 "--buildpkg",     "--buildpkgonly",
 "--changelog",    "--columns",
-"--consistent",
+"--complete-graph",
 "--debug",        "--deep",
 "--digest",
 "--emptytree",
@@ -382,7 +382,7 @@ def create_depgraph_params(myopts, myaction):
                myparams.discard("recurse")
        if "--deep" in myopts:
                myparams.add("deep")
-       if "--consistent" in myopts:
+       if "--complete-graph" in myopts:
                myparams.add("consistent")
        return myparams
 
@@ -2989,7 +2989,7 @@ class depgraph(object):
                intially satisfied.
 
                Since this method can consume enough time to disturb users, it is
-               currently only enabled by the --consistent option.
+               currently only enabled by the --complete-graph option.
                """
                if "consistent" not in self.myparams:
                        # Skip this to avoid consuming enough time to disturb users.

diff --git a/man/emerge.1 b/man/emerge.1
index e641af0cc8b865ba2f5829ce944659944a706e3d..db7b409e99763ceafac961f17d796254ffe3d4c1 100644 (file)
--- a/man/emerge.1
+++ b/man/emerge.1
@@ -246,6 +246,17 @@ is not a tty (by default, color is disabled unless stdout is a tty).
 Used alongside \fB\-\-pretend\fR to cause the package name, new version, 
 and old version to be displayed in an aligned format for easy cut\-n\-paste.
 .TP
+.BR "\-\-complete\-graph"
+This causes \fBemerge\fR to consider the deep dependencies of all
+packages from the system and world sets. With this option enabled,
+\fBemerge\fR will bail out if it determines that the given operation will
+break any dependencies of the packages that have been added to the
+graph. Like the \fB\-\-deep\fR option, the \fB\-\-complete\-graph\fR
+option will significantly increase the time taken for dependency
+calculations. Note that, unlike the \fB\-\-deep\fR option, the
+\fB\-\-complete\-graph\fR option does not cause any more packages to
+be updated than would have otherwise been updated with the option disabled.
+.TP
 .BR \-\-config\-root=DIR
 Set the \fBPORTAGE_CONFIGROOT\fR environment variable.
 .TP

diff --git a/pym/emergehelp.py b/pym/emergehelp.py
index 99b1cbb60264d7377bf01482b3f4ddfe21048be3..038db678411d9adcebc9027c9e22cd8759ec8a61 100644 (file)
--- a/pym/emergehelp.py
+++ b/pym/emergehelp.py
@@ -17,7 +17,7 @@ def shorthelp():
        print bold("Options:")+" "+green("-")+"["+green("abBcCdDefgGhkKlnNoOpqPsStuvV")+"] ["+green("--oneshot")+"] ["+green("--newuse")+"] ["+green("--noconfmem")+"]"
        print      "                                          [ " + green("--color")+" < " + turquoise("y") + " | "+ turquoise("n")+" >  ] [ "+green("--columns")+" ]"
        print      "                                     [ "+green("--reinstall ")+turquoise("changed-use")+" ] ["+green("--nospinner")+"]"
-       print "                                          [ "+green("--deep")+"  ] [" + green("--with-bdeps")+" < " + turquoise("y") + " | "+ turquoise("n")+" > ]"
+       print "                    [ "+green("--complete-graph")+"  ] [ "+green("--deep")+"  ] [" + green("--with-bdeps")+" < " + turquoise("y") + " | "+ turquoise("n")+" > ]"
        print bold("Actions:")+" [ "+green("--clean")+" | "+green("--depclean")+" | "+green("--prune")+" | "+green("--regen")+" | "+green("--search")+" | "+green("--unmerge")+" ]"
 
 def help(myaction,myopts,havecolor=1):
@@ -220,6 +220,19 @@ def help(myaction,myopts,havecolor=1):
                print "              Display the pretend output in a tabular form. Versions are"
                print "              aligned vertically."
                print
+               print "       "+green("--complete-graph")
+               desc = "This causes emerge to consider the deep dependencies of all" + \
+                       " packages from the system and world sets. With this option enabled," + \
+                       " emerge will bail out if it determines that the given operation will" + \
+                       " break any dependencies of the packages that have been added to the" + \
+                       " graph. Like the --deep option, the --complete-graph" + \
+                       " option will significantly increase the time taken for dependency" + \
+                       " calculations. Note that, unlike the --deep option, the" + \
+                       " --complete-graph option does not cause any more packages to" + \
+                       " be updated than would have otherwise been updated with the option disabled."
+               for line in wrap(desc, desc_width):
+                       print desc_indent + line
+               print
                print "       "+green("--debug")+" ("+green("-d")+" short option)"
                print "              Tell emerge to run the ebuild command in --debug mode. In this"
                print "              mode, the bash build environment will run with the -x option,"