man page updates thanks to Francesco Turco. Update analyze and rebuild modules to use a new not_implemented() in the ModuleBase class.

4 files changed, 89 insertions, 62 deletions

diff --git a/man/enalyze.1 b/man/enalyze.1
index 506d619..08949ca 100644
--- a/man/enalyze.1
+++ b/man/enalyze.1
@@ -1,55 +1,55 @@
-.TH "ENALYZE" "22" "Febuary 2010" "GENTOOLKIT" ""
+.TH "ENALYZE" "1" "Febuary 2010" "GENTOOLKIT" ""
 .SH "NAME"
 enalyze \- Gentoo Installed Package Analysis Tool
 
 .SH "SYNOPSIS"
-.BI "enalyze " "[global\-options] " "module " "[local\-options]" "TARGET"
+.BI "enalyze " "[global\-options] " "module " "[local\-options]" " TARGET"
 
 .SH "DESCRIPTION"
 .B Enalyze
-Is a collection of modules for analyzing the state of installed Gentoo packages for
+is a collection of modules for analyzing the state of installed Gentoo packages for
 USE flags or keywords used for installation, and their current masking status.
-.br 
+.br
 It can also optionally (re)generate new /etc/portage/package.* files.
-.br 
+.br
 
-.br 
+.br
 .B CAUTION:
-This is beta software and is not yet feature complete. Some features, options 
+This is beta software and is not yet feature complete. Some features, options
 may change in the future.   Any files that it generates are saved to your home directory
-and will not harm your system without effort on your part.
-.br 
+and will not harm your system without effort on your part.  It also does not need to be run as root.
+.br
 
 .SH "GLOBAL OPTIONS"
 .HP
 .B \-h, \-\-help
-.br 
+.br
 Output a help message.
 .HP
 .B \-q, \-\-quiet
-.br 
+.br
 Be less verbose where possible. In some modules, this option can increase the output speed.
 .HP
 .B \-C, \-\-no\-color
-.br 
+.br
 Do not colorize output.
 .HP
 .B \-N, \-\-no\-pipe
-.br 
+.br
 Turn off automatic pipe detection. Use this option if you do not want
 .B enalyze
-To detect if the output is being directed to the screen or to another program
+to detect if the output is being directed to the screen or to another program
 and adjust color and verbosity accordingly.
 .HP
 .B \-V, \-\-version
-.br 
+.br
 Display \fBGentoolkit\fP's version. Please include this in all bug reports. (see
 .B BUGS
 below)
 
 .SH "MODULES"
 .B Enalyze
-Uses a system of modules. Each module has both a long and short name. 
+uses a system of modules. Each module has both a long and short name.
 The list below uses the notation "\fBmodule (m)\fP", where \fIm\fP is the short name
 and \fImodule\fP is the long name.
 .P
@@ -69,31 +69,32 @@ Report on all installed packages for \fITARGET\fP.
 .I R "TARGET" ":"
 .HP
 .B use
-.br 
+.br
 Will analyze the installed with USE flags for output results.
 .HP
 .B pkguse
-.br 
-Will analyze the USE flags information from the installed pkg's 'PKGUSE' file which contains 
+.br
+Will analyze the USE flags information from the installed pkg's 'PKGUSE' file which contains
 only flags settings from /etc/portage/package.use at the time of installation.
 .HP
 .B keywords
-.br 
+.br
 Will analyze the recorded keywords for output results.
 .HP
 .B unmask
-.br 
+.br
 Will analyze the installed packages and portage trees for pkgs that require unmasking and report them.
-.br 
+(Not implemented yet)
+.br
 .P
 .I R "LOCAL OPTIONS" ":"
 .HP
 .B \-u, \-\-unset
-.br 
+.br
 Will also include any USE flags used that were not enabled for some packages.
 .HP
-.B \-v, \-\-verebose
-.br 
+.B \-v, \-\-verbose
+.br
 Gives more detail about the results found and the current task being performed.
 
 .P
@@ -102,14 +103,14 @@ Gives more detail about the results found and the current task being performed.
 .HP
 enalyze a \-\-verbose \-\-unset use
 .EE
-.br 
+.br
 Report on all use flags used to install the packages.  (\-\-unset) Include in the report all flags
-that have been used but also were not set enabled for some packages.  
+that have been used but also were not set enabled for some packages.
 (\-\-verbose) Also list the packages that used the USE flag setting.
 The report will break down the useage and report the USE flag up to 3 times indicating its
-setting {"+","\-"," "= unset} prepended to the flag name. 
+setting {"+","\-"," "= unset} prepended to the flag name.
 It will also color the output, red = Disabled, blue = Enabled, plain text = unset
-.br 
+.br
 
 .SS
 .BI "rebuild (r) [OPTIONS] TARGET"
@@ -119,36 +120,36 @@ other than the default settings.
 .I R "TARGET" ":"
 .HP
 .B use
-.br 
+.br
 Will analyze the USE flags for output results.
 .HP
 .B keywords
-.br 
+.br
 Will analyze the keywords for output results.
 .HP
 .B unmask
-.br 
+.br
 Will analyze the installed packages and portage trees for pkgs that require
 unmasking and produce output/a new /etc/portage/package.unmask file.
 .P
 .I R "LOCAL OPTIONS" ":"
 .HP
 .B \-a, \-\-all
-.br 
-Create files/output for all TARGET(s) found to need it. (not Implemented yet)
+.br
+Create files/output for all TARGET(s) found to need it. (Not implemented yet)
 .HP
-.B \-e, \-\-excact
-.br 
+.B \-e, \-\-exact
+.br
 Will prepend the pkg with = as well as use the version information for the entries.
-.br 
-eg.:  =CAT/PKG\-VER flag1 flag2
+.br
+e.g.:  =CAT/PKG\-VER flag1 flag2
 .HP
 .B \-p, \-\-pretend
-.br 
+.br
 Sends the output to the screen instead of a file.
 .HP
-.B \-v, \-\-verebose
-.br 
+.B \-v, \-\-verbose
+.br
 Gives more detail about the results found and the current task being performed.
 .P
 .I R "EXAMPLES" ":"
@@ -156,49 +157,49 @@ Gives more detail about the results found and the current task being performed.
 .HP
 enalyze rebuild \-p use
 .EE
-.br 
+.br
 Analyze the installed packages database and current system USE flag settings
  and output the results in the form of:
-.br 
-   
-.br 
+.br
+
+.br
 .EX
 CAT/PKG \-flag1 \-flag2 flag3 flag4...
 
 .SS
 .BI "clean (c) [OPTIONS] TARGET"
 Clean all packages for \fITARGET\fP settings that are found with obsolete settings
-for the current settings and pkg ebuild. (not Implemented yet)
+for the current settings and pkg ebuild. (Not implemented yet)
 
 .I R "TARGET" ":"
 .HP
 .B use
-.br 
+.br
 Will analyze the USE flags and /etc/portage/package.use file(s) for entries that
 are redundant or no longer used by the pkg.
 .HP
 .B keywords
-.br 
+.br
 Will analyze the keywords and /etc/portage/package.keywords file(s) for entries
 that are no longer needed.
 .HP
 .B unmask
-.br 
+.br
 Will analyze the installed packages, /etc/portage/package.unmask file(s) and
 portage trees for pkgs that no longer require unmasking.
 .P
 .I R "LOCAL OPTIONS" ":"
 .HP
 .B \-a, \-\-all
-.br 
-Clean files/output for all TARGET(s) found to need it. (not Implemented yet)
+.br
+Clean files/output for all TARGET(s) found to need it. (not implemented yet)
 .HP
 .B \-p, \-\-pretend
-.br 
+.br
 Sends the output to the screen instead of a file.
 .HP
-.B \-v, \-\-verebose
-.br 
+.B \-v, \-\-verbose
+.br
 Gives more detail about the results found and the current task being performed.
 
 
@@ -206,5 +207,5 @@ Gives more detail about the results found and the current task being performed.
 Submit bug reports to http://bugs.gentoo.org.
 
 .SH "AUTHORS"
-.br 
-Brian Dolbec <brian.dolbec@gmail.com>, 2010
+.br
+Brian Dolbec <dolsen@gentoo.org>, 2010
diff --git a/pym/gentoolkit/enalyze/analyze.py b/pym/gentoolkit/enalyze/analyze.py
index 7033422..e068351 100644
--- a/pym/gentoolkit/enalyze/analyze.py
+++ b/pym/gentoolkit/enalyze/analyze.py
@@ -165,7 +165,8 @@ class Analyse(ModuleBase):
 	"""
 	def __init__(self):
 		ModuleBase.__init__(self)
-		self.module_name = "enalyze"
+		self.command_name = "enalyze"
+		self.module_name = "analyze"
 		self.options = {
 			"flags": False,
 			"keywords": False,
@@ -220,12 +221,16 @@ class Analyse(ModuleBase):
 			"Causes the action to analyze the installed packages and the"),
 			("  ",
 			"USE flags they were installed with"),
+			("  unmask",
+			"Causes the action to analyze the installed packages"),
+			("  ",
+			"for those that need to be unmasked")
 		]
 		self.short_opts = "huvpG"
 		self.long_opts = ("help", "unset", "verbose", "prefix") #, "portage")
 		self.need_queries = True
 		self.arg_spec = "Target"
-		self.arg_options = ['use', 'pkguse','keywords', 'packages']
+		self.arg_options = ['use', 'pkguse','keywords', 'packages', 'unmask']
 		self.arg_option = False
 		self.warning = (
 			"   CAUTION",
@@ -248,6 +253,8 @@ class Analyse(ModuleBase):
 			self.analyse_keywords()
 		elif query in ["packages"]:
 			self.analyse_packages()
+		elif query in ["unmask"]:
+			self.analyse_unmask()
 
 	def analyse_flags(self, target):
 		"""This will scan the installed packages db and analyze the
@@ -435,6 +442,14 @@ class Analyse(ModuleBase):
 			print()
 
 
+	def analyse_unmask(self):
+		"""This will scan the installed packages db and analyze the
+		unmasking used for installation and produce a report on them.
+		"""
+		self.not_implemented("unmask")
+
+
+
 def main(input_args):
 	"""Common starting method by the analyze master
 	unless all modules are converted to this class method.
diff --git a/pym/gentoolkit/enalyze/rebuild.py b/pym/gentoolkit/enalyze/rebuild.py
index cd1a08a..778fed4 100644
--- a/pym/gentoolkit/enalyze/rebuild.py
+++ b/pym/gentoolkit/enalyze/rebuild.py
@@ -146,6 +146,7 @@ class Rebuild(ModuleBase):
 	"""
 	def __init__(self):
 		ModuleBase.__init__(self)
+		self.command_name = "enalyze"
 		self.module_name = "rebuild"
 		self.options = {
 			"use": False,
@@ -235,6 +236,7 @@ class Rebuild(ModuleBase):
 			print((pp.emph("  -- Found ") +  pp.number(str(pkg_count)) +
 				pp.emph(" packages that need entries")))
 			#print pp.emph("     package.use to maintain their current setting")
+		pkg_keys = []
 		if pkgs:
 			pkg_keys = sorted(pkgs)
 			#print len(pkgs)
@@ -266,8 +268,8 @@ class Rebuild(ModuleBase):
 				self.save_file(filepath, output.lines)
 
 	def rebuild_keywords(self):
-		print("Module action not yet available")
-		print()
+		#print("Module action not yet available")
+		#print()
 		"""This will scan the installed packages db and analyze the
 		keywords used for installation and produce a report on them.
 		"""
@@ -303,6 +305,7 @@ class Rebuild(ModuleBase):
 			analyser = self.analyser
 			)
 		#print([pkgs[p][0].cpv for p in pkgs])
+		pkg_keys = []
 		if pkgs:
 			pkg_keys = sorted(pkgs)
 			#print(len(pkgs))
@@ -338,8 +341,7 @@ class Rebuild(ModuleBase):
 
 
 	def rebuild_unmask(self):
-		print("Module action not yet available")
-		print()
+		self.not_implemented("unmask")
 
 
 	def save_file(self, filepath, data):
diff --git a/pym/gentoolkit/module_base.py b/pym/gentoolkit/module_base.py
index f8a6774..87e04f1 100644
--- a/pym/gentoolkit/module_base.py
+++ b/pym/gentoolkit/module_base.py
@@ -145,4 +145,13 @@ class ModuleBase(object):
 		return queries
 
 
+	def not_implemented(self, target):
+		"""Prints a standard module not implemented message"""
+		print()
+		print(pp.error(
+			"Sorry %s module and/or target is not implenented yet."
+			% pp.emph(self.command_name)))
+		print("module: %s, target: %s" %(pp.emph(self.module_name), pp.emph(target)))
+		print()
+
 # vim: set ts=4 sw=4 tw=79: