emaint: Clean and standardize package docstrings and module descriptions

diff --git a/bin/emaint b/bin/emaint
index f3ef409439f2459d0f1eb22602f0823f7c6f8425..f0e497822c066166500b53ae8b6de1dc3bd8d887 100755 (executable)
--- 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 28169171fda5b4e29481669c8c7483e69fe9c991..48bc6e2ae4157ea8b5b2be113f73b0567eb3da21 100644 (file)
--- 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 593c1bafb2cf214616e34f0f394d10a17b5c97cf..f67197d9f8e7b375554b194788cb0d83661492e0 100644 (file)
--- 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 7708dceef150408058714666fe277b59712b0cdb..c60e8bcb4fa376f3db5dd034b23e02eb503b760a 100644 (file)
--- 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 426df33f49fe64d6725f7672480671ec0c158dd2..f0585b39a764f1ed3609bd0aaeff711de582993d 100644 (file)
--- 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 fb52888ebf44eb1e8fd5116807027c0e69bf82b9..6f62d03629de56ef1e701dd5e6a5cf0cb13c406c 100644 (file)
--- 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 0b5386ff317106a9ca83d9c939c31933741d56e8..d31d7b346763f3b0085dc7b49ea6d171ba2e70a9 100644 (file)
--- 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 2c6ca87c80de6b259e3385e3eb415cb3a1d21423..965e8f9450d4e23377d42305746612fc3c9c1eab 100644 (file)
--- 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 757664048fe5bc98402a7e7a94adb05efc02c3b6..3f62270eed24e16e867dd493d4fdf0bf06d155dc 100644 (file)
--- 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': {}
                        }