From: W. Trevor King <wking@tremily.us>
Date: Sat, 9 Mar 2013 19:28:11 +0000 (-0500)
Subject: emaint: Clean and standardize package docstrings and module descriptions
X-Git-Tag: v2.2.0_alpha167~45
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=76380aadc45248a704b1a0f8c7c0cc7ed66615c8;p=portage.git

emaint: Clean and standardize package docstrings and module descriptions
---

diff --git a/bin/emaint b/bin/emaint
index f3ef40943..f0e497822 100755
--- a/bin/emaint
+++ b/bin/emaint
@@ -2,8 +2,7 @@
 # Copyright 2005-2013 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""The emaint program provides an interface to system health
-	checks and maintenance.
+"""System health checks and maintenance utilities.
 """
 
 from __future__ import print_function
diff --git a/pym/portage/emaint/__init__.py b/pym/portage/emaint/__init__.py
index 28169171f..48bc6e2ae 100644
--- a/pym/portage/emaint/__init__.py
+++ b/pym/portage/emaint/__init__.py
@@ -1,7 +1,5 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""The emaint program provides checks and maintenance
-on a gentoo system.
+"""System health checks and maintenance utilities.
 """
-
diff --git a/pym/portage/emaint/modules/__init__.py b/pym/portage/emaint/modules/__init__.py
index 593c1bafb..f67197d9f 100644
--- a/pym/portage/emaint/modules/__init__.py
+++ b/pym/portage/emaint/modules/__init__.py
@@ -1,7 +1,5 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""The emaint program  plug-in module provides an automatic method
-of adding/removing modules to perform checks and maintenance
-on a gentoo system.
+"""Plug-in modules for system health checks and maintenance.
 """
diff --git a/pym/portage/emaint/modules/binhost/__init__.py b/pym/portage/emaint/modules/binhost/__init__.py
index 7708dceef..c60e8bcb4 100644
--- a/pym/portage/emaint/modules/binhost/__init__.py
+++ b/pym/portage/emaint/modules/binhost/__init__.py
@@ -1,20 +1,18 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""The emaint program module provides checks and maintenancefor:
-  Scanning, checking and fixing problems in the world file.
+"""Scan and generate metadata indexes for binary packages.
 """
 
 
 module_spec = {
 	'name': 'binhost',
-	'description': "Provides functions to scan, check and " + \
-		"Generate a metadata index for binary packages",
+	'description': __doc__,
 	'provides':{
 		'module1': {
 			'name': "binhost",
 			'class': "BinhostHandler",
-			'description':  "Generate a metadata index for binary packages",
+			'description': __doc__,
 			'functions': ['check', 'fix'],
 			'func_desc': {}
 			}
diff --git a/pym/portage/emaint/modules/config/__init__.py b/pym/portage/emaint/modules/config/__init__.py
index 426df33f4..f0585b39a 100644
--- a/pym/portage/emaint/modules/config/__init__.py
+++ b/pym/portage/emaint/modules/config/__init__.py
@@ -1,20 +1,18 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""This emaint module provides checks and maintenance for:
-Cleaning the emerge config tracker list
+"""Check and clean the config tracker list for uninstalled packages.
 """
 
 
 module_spec = {
 	'name': 'config',
-	'description': "Provides functions to scan, check for and fix no " +\
-		"longer installed config files in emerge's tracker file",
+	'description': __doc__,
 	'provides':{
 		'module1': {
 			'name': "cleanconfmem",
 			'class': "CleanConfig",
-			'description':  "Discard no longer installed config tracker entries",
+			'description': __doc__,
 			'functions': ['check', 'fix'],
 			'func_desc': {}
 			}
diff --git a/pym/portage/emaint/modules/logs/__init__.py b/pym/portage/emaint/modules/logs/__init__.py
index fb52888eb..6f62d0362 100644
--- a/pym/portage/emaint/modules/logs/__init__.py
+++ b/pym/portage/emaint/modules/logs/__init__.py
@@ -1,20 +1,18 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""This emaint module provides checks and maintenance for:
-Cleaning the PORT_LOGDIR logs
+"""Check and clean old logs in the PORT_LOGDIR.
 """
 
 
 module_spec = {
 	'name': 'logs',
-	'description': "Provides functions to scan, check and clean old logs " +\
-		"in the PORT_LOGDIR",
+	'description': __doc__,
 	'provides':{
 		'module1': {
 			'name': "logs",
 			'class': "CleanLogs",
-			'description':  "Clean out old logs from the PORT_LOGDIR",
+			'description': __doc__,
 			'functions': ['check','clean'],
 			'func_desc': {
 				'clean': {
diff --git a/pym/portage/emaint/modules/move/__init__.py b/pym/portage/emaint/modules/move/__init__.py
index 0b5386ff3..d31d7b346 100644
--- a/pym/portage/emaint/modules/move/__init__.py
+++ b/pym/portage/emaint/modules/move/__init__.py
@@ -1,21 +1,18 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""This emaint module provides checks and maintenance for:
-  1) "Performing package move updates for installed packages",
-  2)"Perform package move updates for binary packages"
+"""Perform package move updates for installed and binary packages.
 """
 
 
 module_spec = {
 	'name': 'move',
-	'description': "Provides functions to check for and move packages " +\
-		"either installed or binary packages stored on this system",
+	'description': __doc__,
 	'provides':{
 		'module1': {
 			'name': "moveinst",
 			'class': "MoveInstalled",
-			'description': "Perform package move updates for installed packages",
+			'description': __doc__,
 			'options': ['check', 'fix'],
 			'functions': ['check', 'fix'],
 			'func_desc': {
diff --git a/pym/portage/emaint/modules/resume/__init__.py b/pym/portage/emaint/modules/resume/__init__.py
index 2c6ca87c8..965e8f945 100644
--- a/pym/portage/emaint/modules/resume/__init__.py
+++ b/pym/portage/emaint/modules/resume/__init__.py
@@ -1,15 +1,13 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""This emaint module provides checks and maintenance for:
-Cleaning the "emerge --resume" lists
+"""Check and fix problems in the resume and/or resume_backup files.
 """
 
 
 module_spec = {
 	'name': 'resume',
-	'description': "Provides functions to scan, check and fix problems " +\
-		"in the resume and/or resume_backup files",
+	'description': __doc__,
 	'provides':{
 		'module1': {
 			'name': "cleanresume",
diff --git a/pym/portage/emaint/modules/world/__init__.py b/pym/portage/emaint/modules/world/__init__.py
index 757664048..3f62270ee 100644
--- a/pym/portage/emaint/modules/world/__init__.py
+++ b/pym/portage/emaint/modules/world/__init__.py
@@ -1,20 +1,18 @@
 # Copyright 2005-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-"""This emaint module provides checks and maintenance for:
-Fixing problems with the "world" file.
+"""Check and fix problems in the world file.
 """
 
 
 module_spec = {
 	'name': 'world',
-	'description': "Provides functions to scan, " +
-		"check and fix problems in the world file",
+	'description': __doc__,
 	'provides':{
 		'module1':{
 			'name': "world",
 			'class': "WorldHandler",
-			'description':  "Fix problems in the world file",
+			'description': __doc__,
 			'functions': ['check', 'fix'],
 			'func_desc': {}
 			}