diff options
author | Bryn M. Reeves <bmr@redhat.com> | 2014-09-14 20:05:55 +0100 |
---|---|---|
committer | Bryn M. Reeves <bmr@redhat.com> | 2014-09-16 11:06:24 +0100 |
commit | 9bfe802436f5707b38bfbcf83795ee0629939542 (patch) | |
tree | 72cb75ea6419a93bf9ab8365c16dd9220487d063 | |
parent | 48a34502b6392c429982d36ccc57569fd175f607 (diff) | |
download | sos-9bfe802436f5707b38bfbcf83795ee0629939542.tar.gz |
[plugins] improve plugin class docstrings
Plugin class docstrings should be a brief (42 characters or less)
description of the component the plugin supports. This is needed
since the class docstring is displayed in the table of enabled
plugins when running 'sosreport --list-plugins'.
Class docstrings should not describe the distribution a particular
class runs on; this is redundant since only plugins tagges with a
class matching the running policy will be displayed.
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
152 files changed, 161 insertions, 311 deletions
diff --git a/sos/plugins/abrt.py b/sos/plugins/abrt.py index 76d528d8..a021051d 100644 --- a/sos/plugins/abrt.py +++ b/sos/plugins/abrt.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Abrt(Plugin, RedHatPlugin): - """ABRT log dump + """Automatic Bug Reporting Tool """ plugin_name = "abrt" diff --git a/sos/plugins/acpid.py b/sos/plugins/acpid.py index 1371c84d..83374cb0 100644 --- a/sos/plugins/acpid.py +++ b/sos/plugins/acpid.py @@ -16,13 +16,12 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Acpid(Plugin): + """ACPI daemon information""" plugin_name = "acpid" profiles = ('hardware',) class RedHatAcpid(Acpid, RedHatPlugin): - """acpid related information - """ def setup(self): self.add_copy_specs([ "/var/log/acpid*", @@ -30,8 +29,6 @@ class RedHatAcpid(Acpid, RedHatPlugin): class DebianAcpid(Acpid, DebianPlugin, UbuntuPlugin): - """acpid related information for Debian and Ubuntu - """ def setup(self): self.add_copy_specs([ "/etc/acpi/events/powerbtn*"]) diff --git a/sos/plugins/activemq.py b/sos/plugins/activemq.py index 8fb68bc0..adc9f31f 100644 --- a/sos/plugins/activemq.py +++ b/sos/plugins/activemq.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class ActiveMq(Plugin, RedHatPlugin, DebianPlugin): - """ActiveMQ related information + """ActiveMQ message broker """ plugin_name = 'activemq' @@ -30,9 +30,6 @@ class ActiveMq(Plugin, RedHatPlugin, DebianPlugin): class UbuntuActiveMq(ActiveMq, UbuntuPlugin): - """ Ubuntu ActiveMQ information - """ - def setup(self): super(UbuntuActiveMq, self).setup() self.add_copy_specs([ diff --git a/sos/plugins/anaconda.py b/sos/plugins/anaconda.py index 24e0a1ec..e582845c 100644 --- a/sos/plugins/anaconda.py +++ b/sos/plugins/anaconda.py @@ -17,7 +17,7 @@ import os class Anaconda(Plugin, RedHatPlugin): - """Anaconda / Installation information + """Anaconda installer """ plugin_name = 'anaconda' diff --git a/sos/plugins/anacron.py b/sos/plugins/anacron.py index 4d79c990..92ae1c58 100644 --- a/sos/plugins/anacron.py +++ b/sos/plugins/anacron.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Anacron(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ capture scheduled jobs information """ + """Anacron job scheduling service""" plugin_name = 'anacron' profiles = ('system',) diff --git a/sos/plugins/apache.py b/sos/plugins/apache.py index 84f0cb58..aea98965 100644 --- a/sos/plugins/apache.py +++ b/sos/plugins/apache.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Apache(Plugin): - """Apache related information + """Apache http daemon """ plugin_name = "apache" profiles = ('webserver', 'openshift') @@ -27,8 +27,6 @@ class Apache(Plugin): class RedHatApache(Apache, RedHatPlugin): - """Apache related information for Red Hat distributions - """ files = ('/etc/httpd/conf/httpd.conf',) def setup(self): @@ -51,8 +49,6 @@ class RedHatApache(Apache, RedHatPlugin): class DebianApache(Apache, DebianPlugin, UbuntuPlugin): - """Apache related information for Debian distributions - """ files = ('/etc/apache2/apache2.conf',) def setup(self): diff --git a/sos/plugins/apparmor.py b/sos/plugins/apparmor.py index d7150223..c9f08459 100644 --- a/sos/plugins/apparmor.py +++ b/sos/plugins/apparmor.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, UbuntuPlugin class Apparmor(Plugin, UbuntuPlugin): - """Apparmor related information + """Apparmor mandatory access control """ plugin_name = 'apparmor' diff --git a/sos/plugins/apport.py b/sos/plugins/apport.py index dacf6ce2..6756c78f 100644 --- a/sos/plugins/apport.py +++ b/sos/plugins/apport.py @@ -17,11 +17,11 @@ from sos.plugins import Plugin, DebianPlugin, UbuntuPlugin class Apport(Plugin, DebianPlugin, UbuntuPlugin): - """apport information + """Apport crash reporting tool """ plugin_name = 'apport' - profiles = () + profiles = ('debug',) def setup(self): self.add_copy_spec("/etc/apport/*") diff --git a/sos/plugins/apt.py b/sos/plugins/apt.py index 2d459356..6063bf9d 100644 --- a/sos/plugins/apt.py +++ b/sos/plugins/apt.py @@ -18,11 +18,11 @@ from sos.plugins import Plugin, UbuntuPlugin, DebianPlugin class Apt(Plugin, DebianPlugin, UbuntuPlugin): - """ Apt Plugin + """ APT - advanced packaging tool """ plugin_name = 'apt' - profiles = ('system', 'packagemanager') + profiles = ('system', 'sysmgmt', 'packagemanager') def setup(self): self.add_copy_specs([ diff --git a/sos/plugins/ata.py b/sos/plugins/ata.py index 3465b4d2..170f97b4 100644 --- a/sos/plugins/ata.py +++ b/sos/plugins/ata.py @@ -17,7 +17,7 @@ import os class Ata(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """ ATA and IDE related information (including PATA and SATA) + """ ATA and IDE information """ plugin_name = "ata" diff --git a/sos/plugins/auditd.py b/sos/plugins/auditd.py index b433a46d..76729cbf 100644 --- a/sos/plugins/auditd.py +++ b/sos/plugins/auditd.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Auditd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Auditd related information + """Audit daemon information """ plugin_name = 'auditd' diff --git a/sos/plugins/autofs.py b/sos/plugins/autofs.py index 21c1e111..3b678671 100644 --- a/sos/plugins/autofs.py +++ b/sos/plugins/autofs.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Autofs(Plugin): - """autofs server-related information + """Autofs on-demand automounter """ plugin_name = "autofs" @@ -55,7 +55,6 @@ class Autofs(Plugin): class RedHatAutofs(Autofs, RedHatPlugin): - """autofs server-related on RedHat based distributions""" def setup(self): super(RedHatAutofs, self).setup() @@ -64,7 +63,6 @@ class RedHatAutofs(Autofs, RedHatPlugin): class DebianAutofs(Autofs, DebianPlugin, UbuntuPlugin): - """autofs server-related on Debian based distributions""" def setup(self): super(DebianAutofs, self).setup() diff --git a/sos/plugins/azure.py b/sos/plugins/azure.py index 367401cb..52fe2e61 100644 --- a/sos/plugins/azure.py +++ b/sos/plugins/azure.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, UbuntuPlugin class Azure(Plugin, UbuntuPlugin): - """ Microsoft Azure Client Plugin + """ Microsoft Azure client """ plugin_name = 'azure' diff --git a/sos/plugins/block.py b/sos/plugins/block.py index 0a26dc2a..466782b2 100644 --- a/sos/plugins/block.py +++ b/sos/plugins/block.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Block(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Block device related information + """Block device information """ plugin_name = 'block' diff --git a/sos/plugins/ceph.py b/sos/plugins/ceph.py index 188151e7..39b8b0ba 100644 --- a/sos/plugins/ceph.py +++ b/sos/plugins/ceph.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Ceph(Plugin, RedHatPlugin, UbuntuPlugin): - """information on CEPH + """CEPH distributed storage """ plugin_name = 'ceph' diff --git a/sos/plugins/cgroups.py b/sos/plugins/cgroups.py index 670bf017..f271cb77 100644 --- a/sos/plugins/cgroups.py +++ b/sos/plugins/cgroups.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cgroups(Plugin, DebianPlugin, UbuntuPlugin): - """cgroup subsystem information + """Control groups subsystem """ plugin_name = "cgroups" @@ -32,8 +32,6 @@ class Cgroups(Plugin, DebianPlugin, UbuntuPlugin): class RedHatCgroups(Cgroups, RedHatPlugin): - """Red Hat specific cgroup subsystem information - """ def setup(self): super(RedHatCgroups, self).setup() diff --git a/sos/plugins/cluster.py b/sos/plugins/cluster.py index da598edd..4cc5b16e 100644 --- a/sos/plugins/cluster.py +++ b/sos/plugins/cluster.py @@ -19,7 +19,7 @@ from datetime import datetime, timedelta class Cluster(Plugin, RedHatPlugin): - """cluster suite and GFS related information + """Red Hat Cluster Suite and GFS """ plugin_name = 'cluster' diff --git a/sos/plugins/cobbler.py b/sos/plugins/cobbler.py index 2a9731d8..fdeebdb4 100644 --- a/sos/plugins/cobbler.py +++ b/sos/plugins/cobbler.py @@ -20,7 +20,7 @@ class Cobbler(Plugin): class RedHatCobbler(Cobbler, RedHatPlugin): - """cobbler related information + """Cobbler installation server """ packages = ('cobbler',) @@ -36,8 +36,6 @@ class RedHatCobbler(Cobbler, RedHatPlugin): class DebianCobbler(Cobbler, DebianPlugin, UbuntuPlugin): - """cobbler related information for Debian and Ubuntu - """ packages = ('cobbler',) diff --git a/sos/plugins/corosync.py b/sos/plugins/corosync.py index 349351bf..0692d088 100644 --- a/sos/plugins/corosync.py +++ b/sos/plugins/corosync.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Corosync(Plugin): - """ corosync information + """ Corosync cluster engine """ plugin_name = "corosync" @@ -42,16 +42,12 @@ class Corosync(Plugin): class RedHatCorosync(Corosync, RedHatPlugin): - """ corosync information for RedHat based distribution - """ def setup(self): super(RedHatCorosync, self).setup() class DebianCorosync(Corosync, DebianPlugin, UbuntuPlugin): - """ corosync information for Debian and Ubuntu distributions - """ def setup(self): super(DebianCorosync, self).setup() diff --git a/sos/plugins/cron.py b/sos/plugins/cron.py index 5af2024e..26497dfe 100644 --- a/sos/plugins/cron.py +++ b/sos/plugins/cron.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cron(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Crontab information + """Cron job scheduler """ plugin_name = "cron" diff --git a/sos/plugins/cs.py b/sos/plugins/cs.py index 434dc6b0..37f1c1df 100644 --- a/sos/plugins/cs.py +++ b/sos/plugins/cs.py @@ -22,7 +22,7 @@ from glob import glob class CertificateSystem(Plugin, RedHatPlugin): - """Red Hat Certificate System 7.1, 7.3, 8.0 and dogtag related information + """Certificate System and Dogtag """ plugin_name = 'certificatesystem' diff --git a/sos/plugins/ctdb.py b/sos/plugins/ctdb.py index 67e3701c..c68ce872 100644 --- a/sos/plugins/ctdb.py +++ b/sos/plugins/ctdb.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ctdb(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Samba CTDB related information + """Samba Clustered TDB """ packages = ('ctdb',) profiles = ('cluster', 'storage') diff --git a/sos/plugins/cups.py b/sos/plugins/cups.py index 6f2ec3ca..21756ee4 100644 --- a/sos/plugins/cups.py +++ b/sos/plugins/cups.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Cups(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """printing related information (cups) + """CUPS IPP print service """ plugin_name = 'cups' diff --git a/sos/plugins/dbus.py b/sos/plugins/dbus.py index 889300e2..5957152a 100644 --- a/sos/plugins/dbus.py +++ b/sos/plugins/dbus.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Dbus(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """dbus information""" + """D-Bus message bus""" plugin_name = "dbus" profiles = ('system',) diff --git a/sos/plugins/devicemapper.py b/sos/plugins/devicemapper.py index 57951d61..002ea371 100644 --- a/sos/plugins/devicemapper.py +++ b/sos/plugins/devicemapper.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class DeviceMapper(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """device-mapper related information + """device-mapper framework """ plugin_name = 'devicemapper' diff --git a/sos/plugins/dhcp.py b/sos/plugins/dhcp.py index 34cb8985..085e0088 100644 --- a/sos/plugins/dhcp.py +++ b/sos/plugins/dhcp.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Dhcp(Plugin): - """DHCP related information + """DHCP daemon """ plugin_name = "dhcp" @@ -24,7 +24,6 @@ class Dhcp(Plugin): class RedHatDhcp(Dhcp, RedHatPlugin): - """DHCP related information for Red Hat based distributions""" files = ('/etc/rc.d/init.d/dhcpd',) packages = ('dhcp',) @@ -38,7 +37,6 @@ class RedHatDhcp(Dhcp, RedHatPlugin): class UbuntuDhcp(Dhcp, UbuntuPlugin): - """DHCP related information for Debian based distributions""" files = ('/etc/init.d/udhcpd',) packages = ('udhcpd',) diff --git a/sos/plugins/dmraid.py b/sos/plugins/dmraid.py index 4b879494..b7e2d0d2 100644 --- a/sos/plugins/dmraid.py +++ b/sos/plugins/dmraid.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Dmraid(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """dmraid related information + """dmraid software RAID """ plugin_name = 'dmraid' diff --git a/sos/plugins/docker.py b/sos/plugins/docker.py index 0f67a244..0a023736 100644 --- a/sos/plugins/docker.py +++ b/sos/plugins/docker.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Docker(Plugin): - """Docker information + """Docker containers """ plugin_name = 'docker' @@ -59,8 +59,6 @@ class RedHatDocker(Docker, RedHatPlugin): class UbuntuDocker(Docker, UbuntuPlugin): - """ Docker information on Ubuntu - """ packages = ('docker.io',) diff --git a/sos/plugins/dovecot.py b/sos/plugins/dovecot.py index d88cba9c..b7e97720 100644 --- a/sos/plugins/dovecot.py +++ b/sos/plugins/dovecot.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Dovecot(Plugin): - """dovecot server related information + """Dovecot IMAP and POP3 """ plugin_name = "dovecot" @@ -28,7 +28,7 @@ class Dovecot(Plugin): class RedHatDovecot(Dovecot, RedHatPlugin): - """dovecot server related information for RedHat based distribution + """dovecot server related information """ def setup(self): super(RedHatDovecot, self).setup() diff --git a/sos/plugins/dpkg.py b/sos/plugins/dpkg.py index 314aef48..50c733e0 100644 --- a/sos/plugins/dpkg.py +++ b/sos/plugins/dpkg.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, DebianPlugin, UbuntuPlugin class Dpkg(Plugin, DebianPlugin, UbuntuPlugin): - """dpkg information + """Debian Package Management """ plugin_name = 'dpkg' diff --git a/sos/plugins/ds.py b/sos/plugins/ds.py index 2ca2d824..186abe4f 100644 --- a/sos/plugins/ds.py +++ b/sos/plugins/ds.py @@ -20,7 +20,7 @@ import os class DirectoryServer(Plugin, RedHatPlugin): - """Directory Server information + """Directory Server """ plugin_name = 'directoryserver' diff --git a/sos/plugins/emc.py b/sos/plugins/emc.py index 03574b61..ef14738d 100644 --- a/sos/plugins/emc.py +++ b/sos/plugins/emc.py @@ -22,8 +22,7 @@ from six.moves import input class Emc(Plugin, RedHatPlugin): - """ EMC related information (PowerPath, Solutions Enabler - CLI and Navisphere CLI) + """ EMC related information """ plugin_name = 'emc' diff --git a/sos/plugins/fcoe.py b/sos/plugins/fcoe.py index 63519fff..3db05fc4 100644 --- a/sos/plugins/fcoe.py +++ b/sos/plugins/fcoe.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class fcoe(Plugin, RedHatPlugin): - """fcoe related information + """Fibre Channel over Ethernet """ plugin_name = 'fcoe' diff --git a/sos/plugins/filesys.py b/sos/plugins/filesys.py index 639cb11a..c8f07499 100644 --- a/sos/plugins/filesys.py +++ b/sos/plugins/filesys.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Filesys(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """information on filesystems + """Local file systems """ plugin_name = 'filesys' diff --git a/sos/plugins/firewalld.py b/sos/plugins/firewalld.py index c3ea60b2..eb641966 100644 --- a/sos/plugins/firewalld.py +++ b/sos/plugins/firewalld.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class FirewallD(Plugin, RedHatPlugin): - """FirewallD information + """Firewall daemon """ plugin_name = 'firewalld' diff --git a/sos/plugins/foreman.py b/sos/plugins/foreman.py index baad329a..896add17 100644 --- a/sos/plugins/foreman.py +++ b/sos/plugins/foreman.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Foreman(Plugin, RedHatPlugin): - """Foreman project related information + """Foreman systems management """ plugin_name = 'foreman' diff --git a/sos/plugins/gdm.py b/sos/plugins/gdm.py index 6af8fb49..e182907c 100644 --- a/sos/plugins/gdm.py +++ b/sos/plugins/gdm.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Gdm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """gdm related information + """GNOME display manager """ plugin_name = 'gdm' diff --git a/sos/plugins/general.py b/sos/plugins/general.py index 116c4855..a7a341c3 100644 --- a/sos/plugins/general.py +++ b/sos/plugins/general.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin class General(Plugin): - """basic system information""" + """general system information""" plugin_name = "general" profiles = ('system', 'sysmgmt') @@ -38,7 +38,6 @@ class General(Plugin): class RedHatGeneral(General, RedHatPlugin): - """Basic system information for RedHat based distributions""" def setup(self): super(RedHatGeneral, self).setup() @@ -55,7 +54,6 @@ class RedHatGeneral(General, RedHatPlugin): class DebianGeneral(General, DebianPlugin): - """Basic system information for Debian based distributions""" def setup(self): super(DebianGeneral, self).setup() diff --git a/sos/plugins/gluster.py b/sos/plugins/gluster.py index a4b2f49d..3772cc47 100644 --- a/sos/plugins/gluster.py +++ b/sos/plugins/gluster.py @@ -20,7 +20,7 @@ from sos.plugins import Plugin, RedHatPlugin class Gluster(Plugin, RedHatPlugin): - '''gluster related information''' + """GlusterFS storage""" plugin_name = 'gluster' profiles = ('storage', 'virt') diff --git a/sos/plugins/grub.py b/sos/plugins/grub.py index 0e3878ce..65b6a7dd 100644 --- a/sos/plugins/grub.py +++ b/sos/plugins/grub.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Grub(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Grub information + """GRUB bootloader """ plugin_name = 'grub' diff --git a/sos/plugins/grub2.py b/sos/plugins/grub2.py index 9b64316e..b919d780 100644 --- a/sos/plugins/grub2.py +++ b/sos/plugins/grub2.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Grub2(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Bootloader information + """GRUB2 bootloader """ plugin_name = 'grub2' diff --git a/sos/plugins/haproxy.py b/sos/plugins/haproxy.py index b1944f13..48c03b1c 100644 --- a/sos/plugins/haproxy.py +++ b/sos/plugins/haproxy.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin class HAProxy(Plugin, RedHatPlugin): - """HAProxy information + """HAProxy load balancer """ plugin_name = 'haproxy' diff --git a/sos/plugins/hardware.py b/sos/plugins/hardware.py index 5bf7b27f..f2eb624f 100644 --- a/sos/plugins/hardware.py +++ b/sos/plugins/hardware.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Hardware(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """hardware related information + """General hardware information """ plugin_name = "hardware" diff --git a/sos/plugins/hpasm.py b/sos/plugins/hpasm.py index ec85197c..157a57e5 100644 --- a/sos/plugins/hpasm.py +++ b/sos/plugins/hpasm.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Hpasm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """HP ASM (hp Server Management Drivers and Agent) information + """HP Advanced Server Management """ plugin_name = 'hpasm' diff --git a/sos/plugins/hts.py b/sos/plugins/hts.py index 8c4fb640..4f5d626f 100644 --- a/sos/plugins/hts.py +++ b/sos/plugins/hts.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class HardwareTestSuite(Plugin, RedHatPlugin): - """Red Hat Hardware Test Suite related information + """Red Hat Hardware Test Suite """ plugin_name = 'hardwaretestsuite' diff --git a/sos/plugins/i18n.py b/sos/plugins/i18n.py index 1f91428f..cf8dd44c 100644 --- a/sos/plugins/i18n.py +++ b/sos/plugins/i18n.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class I18n(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Internationalization related information + """Internationalization """ plugin_name = 'i18n' diff --git a/sos/plugins/infiniband.py b/sos/plugins/infiniband.py index 4bbd08a6..1ca0b853 100644 --- a/sos/plugins/infiniband.py +++ b/sos/plugins/infiniband.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Infiniband(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Infiniband related information + """Infiniband data """ plugin_name = 'infiniband' diff --git a/sos/plugins/ipa.py b/sos/plugins/ipa.py index 87b0a735..3b6b4178 100644 --- a/sos/plugins/ipa.py +++ b/sos/plugins/ipa.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Ipa(Plugin, RedHatPlugin): - """IPA diagnostic information + """ Identity, policy, audit """ plugin_name = 'ipa' diff --git a/sos/plugins/ipsec.py b/sos/plugins/ipsec.py index 87fc60ca..10a23bbc 100644 --- a/sos/plugins/ipsec.py +++ b/sos/plugins/ipsec.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class IPSec(Plugin): - """ipsec related information + """Internet protocol security """ plugin_name = "ipsec" @@ -27,8 +27,6 @@ class IPSec(Plugin): class RedHatIpsec(IPSec, RedHatPlugin): - """ipsec related information for Red Hat distributions - """ files = ('/etc/racoon/racoon.conf',) @@ -37,8 +35,6 @@ class RedHatIpsec(IPSec, RedHatPlugin): class DebianIPSec(IPSec, DebianPlugin, UbuntuPlugin): - """ipsec related information for Debian distributions - """ files = ('/etc/ipsec-tools.conf',) diff --git a/sos/plugins/ipvs.py b/sos/plugins/ipvs.py index ff0ca54d..690b2d52 100644 --- a/sos/plugins/ipvs.py +++ b/sos/plugins/ipvs.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin class Ipvs(Plugin, RedHatPlugin, DebianPlugin): - """Ipvs information + """Linux IP virtual server """ plugin_name = 'ipvs' diff --git a/sos/plugins/iscsi.py b/sos/plugins/iscsi.py index 213dca45..2dcb9e07 100644 --- a/sos/plugins/iscsi.py +++ b/sos/plugins/iscsi.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin class Iscsi(Plugin): - """iscsi-initiator related information + """iSCSI initiator """ plugin_name = "iscsi" @@ -25,8 +25,6 @@ class Iscsi(Plugin): class RedHatIscsi(Iscsi, RedHatPlugin): - """iscsi-initiator related information Red Hat based distributions - """ packages = ('iscsi-initiator-utils',) diff --git a/sos/plugins/iscsitarget.py b/sos/plugins/iscsitarget.py index c4366874..43794a9e 100644 --- a/sos/plugins/iscsitarget.py +++ b/sos/plugins/iscsitarget.py @@ -19,7 +19,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class IscsiTarget(Plugin): - """iscsi-target related information + """iSCSI target """ plugin_name = "iscsitarget" @@ -27,8 +27,6 @@ class IscsiTarget(Plugin): class RedHatIscsiTarget(IscsiTarget, RedHatPlugin): - """iscsi-target related information for Red Hat distributions - """ packages = ('scsi-target-utils',) @@ -39,8 +37,6 @@ class RedHatIscsiTarget(IscsiTarget, RedHatPlugin): class DebianIscsiTarget(IscsiTarget, DebianPlugin, UbuntuPlugin): - """iscsi-target related information for Debian based distributions - """ packages = ('iscsitarget',) diff --git a/sos/plugins/java.py b/sos/plugins/java.py index 0c62a987..fe45d94a 100644 --- a/sos/plugins/java.py +++ b/sos/plugins/java.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Java(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """basic java information""" + """Java runtime""" plugin_name = "java" profiles = ('webserver', 'java') diff --git a/sos/plugins/juju.py b/sos/plugins/juju.py index fa5fa61d..57927963 100644 --- a/sos/plugins/juju.py +++ b/sos/plugins/juju.py @@ -37,7 +37,7 @@ def ensure_service_is_running(service): class Juju(Plugin, UbuntuPlugin): - """ Juju Plugin + """ Juju orchestration tool """ plugin_name = 'juju' diff --git a/sos/plugins/katello.py b/sos/plugins/katello.py index b0023dc3..795c07e9 100644 --- a/sos/plugins/katello.py +++ b/sos/plugins/katello.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Katello(Plugin, RedHatPlugin): - """Katello project related information + """Katello systems management """ plugin_name = 'katello' diff --git a/sos/plugins/kdump.py b/sos/plugins/kdump.py index 673d49cd..fdadc932 100644 --- a/sos/plugins/kdump.py +++ b/sos/plugins/kdump.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class KDump(Plugin): - """Kdump related information + """Kdump crash dumps """ plugin_name = "kdump" @@ -29,8 +29,6 @@ class KDump(Plugin): class RedHatKDump(KDump, RedHatPlugin): - """Kdump related information for Red Hat distributions - """ files = ('/etc/kdump.conf',) packages = ('kexec-tools',) @@ -44,8 +42,6 @@ class RedHatKDump(KDump, RedHatPlugin): class DebianKDump(KDump, DebianPlugin, UbuntuPlugin): - """Kdump related information for Debian distributions - """ files = ('/etc/default/kdump-tools',) packages = ('kdump-tools',) diff --git a/sos/plugins/keepalived.py b/sos/plugins/keepalived.py index fa4e3c14..69307c69 100644 --- a/sos/plugins/keepalived.py +++ b/sos/plugins/keepalived.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin class Keepalived(Plugin, RedHatPlugin): - """Keepalived information + """Keepalived routing server """ plugin_name = 'keepalived' diff --git a/sos/plugins/kernel.py b/sos/plugins/kernel.py index 1074cb4f..f22f2dae 100644 --- a/sos/plugins/kernel.py +++ b/sos/plugins/kernel.py @@ -17,7 +17,7 @@ import os class Kernel(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """kernel related information + """Linux kernel """ plugin_name = 'kernel' diff --git a/sos/plugins/kernelrt.py b/sos/plugins/kernelrt.py index 55793c62..4a5cf88d 100644 --- a/sos/plugins/kernelrt.py +++ b/sos/plugins/kernelrt.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class KernelRT(Plugin, RedHatPlugin): - '''Information specific to the realtime kernel + '''Realtime kernel variant ''' plugin_name = 'kernelrt' diff --git a/sos/plugins/krb5.py b/sos/plugins/krb5.py index 04e28d21..d9c0c238 100644 --- a/sos/plugins/krb5.py +++ b/sos/plugins/krb5.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Krb5(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Kerberos related information + """Kerberos authentication """ plugin_name = 'krb5' profiles = ('identity', 'system') diff --git a/sos/plugins/kvm.py b/sos/plugins/kvm.py index bedbe3fa..bde969d3 100644 --- a/sos/plugins/kvm.py +++ b/sos/plugins/kvm.py @@ -20,7 +20,7 @@ import os class Kvm(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """KVM related information + """Kernel virtual machine """ plugin_name = 'kvm' diff --git a/sos/plugins/landscape.py b/sos/plugins/landscape.py index ff6cd443..3b90f96f 100644 --- a/sos/plugins/landscape.py +++ b/sos/plugins/landscape.py @@ -16,8 +16,7 @@ from sos.plugins import Plugin, UbuntuPlugin class Landscape(Plugin, UbuntuPlugin): - """ - landscape client related information + """Ubuntu Landscape client """ plugin_name = 'landscape' diff --git a/sos/plugins/ldap.py b/sos/plugins/ldap.py index d7908574..1b07d123 100644 --- a/sos/plugins/ldap.py +++ b/sos/plugins/ldap.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ldap(Plugin): - """LDAP related information + """LDAP configuration """ plugin_name = "ldap" @@ -32,8 +32,6 @@ class Ldap(Plugin): class RedHatLdap(Ldap, RedHatPlugin): - """LDAP related information for RedHat based distribution - """ packages = ('openldap', 'nss-pam-ldapd') files = ('/etc/ldap.conf', '/etc/pam_ldap.conf') @@ -69,8 +67,6 @@ class RedHatLdap(Ldap, RedHatPlugin): class DebianLdap(Ldap, DebianPlugin, UbuntuPlugin): - """LDAP related information for Debian based distribution - """ ldap_conf = "/etc/ldap/ldap.conf" packages = ('slapd', 'ldap-utils') diff --git a/sos/plugins/libraries.py b/sos/plugins/libraries.py index 109d298a..ff358ce7 100644 --- a/sos/plugins/libraries.py +++ b/sos/plugins/libraries.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Libraries(Plugin, RedHatPlugin, UbuntuPlugin): - """information on shared libraries + """Dynamic shared libraries """ plugin_name = 'libraries' diff --git a/sos/plugins/libvirt.py b/sos/plugins/libvirt.py index 02cefcec..50b7b3f1 100644 --- a/sos/plugins/libvirt.py +++ b/sos/plugins/libvirt.py @@ -18,7 +18,7 @@ import os class Libvirt(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """libvirt-related information + """libvirt virtualization API """ plugin_name = 'libvirt' diff --git a/sos/plugins/lilo.py b/sos/plugins/lilo.py index f7be4d69..3c4e37c9 100644 --- a/sos/plugins/lilo.py +++ b/sos/plugins/lilo.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin class Lilo(Plugin, RedHatPlugin, UbuntuPlugin): - """Lilo information + """Lilo bootloader """ plugin_name = 'lilo' diff --git a/sos/plugins/logrotate.py b/sos/plugins/logrotate.py index b3558383..e0f91a17 100644 --- a/sos/plugins/logrotate.py +++ b/sos/plugins/logrotate.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class LogRotate(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """logrotate configuration files and debug info + """LogRotate service """ plugin_name = 'logrotate' diff --git a/sos/plugins/logs.py b/sos/plugins/logs.py index 4bace230..eed1e3a4 100644 --- a/sos/plugins/logs.py +++ b/sos/plugins/logs.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Logs(Plugin): - """log data """ + """System logs""" plugin_name = "logs" profiles = ('system', 'hardware') @@ -47,7 +47,6 @@ class Logs(Plugin): class RedHatLogs(Logs, RedHatPlugin): - """Basic system information for RedHat based distributions""" def setup(self): super(RedHatLogs, self).setup() @@ -56,7 +55,6 @@ class RedHatLogs(Logs, RedHatPlugin): class DebianLogs(Logs, DebianPlugin, UbuntuPlugin): - """Basic system information for Debian and Ubuntu based distributions""" def setup(self): super(DebianLogs, self).setup() diff --git a/sos/plugins/lsbrelease.py b/sos/plugins/lsbrelease.py index 047c2707..3f3bf40e 100644 --- a/sos/plugins/lsbrelease.py +++ b/sos/plugins/lsbrelease.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class LsbRelease(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Linux Standard Base information + """Linux standard base """ plugin_name = 'lsbrelease' diff --git a/sos/plugins/lvm2.py b/sos/plugins/lvm2.py index 653366c1..d6b5d877 100644 --- a/sos/plugins/lvm2.py +++ b/sos/plugins/lvm2.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Lvm2(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """lvm2 related information + """LVM2 volume manager """ plugin_name = 'lvm2' diff --git a/sos/plugins/maas.py b/sos/plugins/maas.py index bd46a3bf..8a02a163 100644 --- a/sos/plugins/maas.py +++ b/sos/plugins/maas.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, UbuntuPlugin class Maas(Plugin, UbuntuPlugin): - """MAAS Plugin + """Ubuntu Metal-as-a-Service """ plugin_name = 'maas' diff --git a/sos/plugins/md.py b/sos/plugins/md.py index 28bf1b4f..3e10a56a 100644 --- a/sos/plugins/md.py +++ b/sos/plugins/md.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Md(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """MD subsystem information + """MD RAID subsystem """ plugin_name = 'md' diff --git a/sos/plugins/megacli.py b/sos/plugins/megacli.py index 80df2459..5edaded4 100644 --- a/sos/plugins/megacli.py +++ b/sos/plugins/megacli.py @@ -21,7 +21,7 @@ from sos.plugins import Plugin, RedHatPlugin class MegaCLI(Plugin, RedHatPlugin): - """Information for devices which use the MegaRAID Unified device driver + """LSI MegaRAID devices """ plugin_name = 'megacli' diff --git a/sos/plugins/memory.py b/sos/plugins/memory.py index 28c2c61c..d02fdb6d 100644 --- a/sos/plugins/memory.py +++ b/sos/plugins/memory.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Memory(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """memory usage information + """Memory configuration and use """ plugin_name = 'memory' diff --git a/sos/plugins/mongodb.py b/sos/plugins/mongodb.py index 3ee5efb4..030231bb 100644 --- a/sos/plugins/mongodb.py +++ b/sos/plugins/mongodb.py @@ -18,11 +18,11 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class MongoDb(Plugin, DebianPlugin, UbuntuPlugin): - """MongoDB related information + """MongoDB document database """ plugin_name = 'mongodb' - profiles = () + profiles = ('services',) packages = ('mongodb-server',) files = ('/etc/mongodb.conf',) @@ -42,8 +42,7 @@ class MongoDb(Plugin, DebianPlugin, UbuntuPlugin): class RedHatMongoDb(MongoDb, RedHatPlugin): - """ MongoDB related information for Red Hat distributions - """ + def setup(self): super(RedHatMongoDb, self).setup() self.add_copy_spec("/etc/sysconfig/mongodb") diff --git a/sos/plugins/mrggrid.py b/sos/plugins/mrggrid.py index 5cff9a74..cbc6fd45 100644 --- a/sos/plugins/mrggrid.py +++ b/sos/plugins/mrggrid.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class MrgGrid(Plugin, RedHatPlugin): - """MRG GRID related information + """MRG GRID engine """ plugin_name = 'mrggrid' diff --git a/sos/plugins/mrgmessg.py b/sos/plugins/mrgmessg.py index 50512c04..948e605c 100644 --- a/sos/plugins/mrgmessg.py +++ b/sos/plugins/mrgmessg.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class MrgMessg(Plugin, RedHatPlugin): - """MRG Messaging related information + """MRG Messaging subsystem """ plugin_name = 'mrgmessg' diff --git a/sos/plugins/multipath.py b/sos/plugins/multipath.py index 0ce85696..d3e1fd7f 100644 --- a/sos/plugins/multipath.py +++ b/sos/plugins/multipath.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Multipath(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """device-mapper multipath information + """Device-mapper multipath tools """ plugin_name = 'multipath' diff --git a/sos/plugins/mysql.py b/sos/plugins/mysql.py index d5702d6a..937b87a4 100644 --- a/sos/plugins/mysql.py +++ b/sos/plugins/mysql.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Mysql(Plugin): - """MySQL and MariaDB related information + """MySQL and MariaDB RDBMS """ plugin_name = "mysql" @@ -50,8 +50,6 @@ class Mysql(Plugin): class RedHatMysql(Mysql, RedHatPlugin): - """MySQL and MariaDB information for Red Hat based distributions - """ packages = ( 'mysql-server', @@ -70,8 +68,6 @@ class RedHatMysql(Mysql, RedHatPlugin): class DebianMysql(Mysql, DebianPlugin, UbuntuPlugin): - """MySQL and MariaDB information for Debian based distributions - """ packages = ( 'mysql-server', diff --git a/sos/plugins/named.py b/sos/plugins/named.py index fe11862b..f4bbc883 100644 --- a/sos/plugins/named.py +++ b/sos/plugins/named.py @@ -17,7 +17,7 @@ from os.path import exists, join, normpath class Named(Plugin): - """named related information + """BIND named server """ plugin_name = "named" @@ -54,8 +54,6 @@ class Named(Plugin): class RedHatNamed(Named, RedHatPlugin): - """named related information for RedHat based distribution - """ named_conf = "/etc/named.conf" config_files = ("/etc/named.conf", @@ -73,8 +71,6 @@ class RedHatNamed(Named, RedHatPlugin): class DebianNamed(Named, DebianPlugin, UbuntuPlugin): - """named related information for Debian based distribution - """ files = ('/etc/bind/named.conf') packages = ('bind9',) diff --git a/sos/plugins/networking.py b/sos/plugins/networking.py index abb22280..3a8f25b8 100644 --- a/sos/plugins/networking.py +++ b/sos/plugins/networking.py @@ -18,7 +18,7 @@ import re class Networking(Plugin): - """network related information + """network and device configuration """ plugin_name = "networking" profiles = ('network', 'hardware', 'system') @@ -160,8 +160,6 @@ class Networking(Plugin): class RedHatNetworking(Networking, RedHatPlugin): - """network related information for RedHat based distribution - """ trace_host = "rhn.redhat.com" def setup(self): @@ -169,8 +167,6 @@ class RedHatNetworking(Networking, RedHatPlugin): class UbuntuNetworking(Networking, UbuntuPlugin): - """network related information for Ubuntu based distribution - """ trace_host = "archive.ubuntu.com" def setup(self): diff --git a/sos/plugins/nfs.py b/sos/plugins/nfs.py index 5e395eba..0b816304 100644 --- a/sos/plugins/nfs.py +++ b/sos/plugins/nfs.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nfs(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """NFS related information + """Network file system information """ plugin_name = 'nfs' profiles = ('storage', 'network', 'nfs') diff --git a/sos/plugins/nfsserver.py b/sos/plugins/nfsserver.py index 203638c8..7ce9a4aa 100644 --- a/sos/plugins/nfsserver.py +++ b/sos/plugins/nfsserver.py @@ -20,7 +20,7 @@ from stat import ST_SIZE class NfsServer(Plugin, RedHatPlugin): - """NFS server-related information + """NFS server information """ plugin_name = 'nfsserver' diff --git a/sos/plugins/nis.py b/sos/plugins/nis.py index e4c80e59..fd892222 100644 --- a/sos/plugins/nis.py +++ b/sos/plugins/nis.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nis(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """NIS related information + """Network information service """ plugin_name = 'nis' diff --git a/sos/plugins/nscd.py b/sos/plugins/nscd.py index 7d0d3ce2..e35d372f 100644 --- a/sos/plugins/nscd.py +++ b/sos/plugins/nscd.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Nscd(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """NSCD related information + """Name service caching daemon """ plugin_name = 'nscd' diff --git a/sos/plugins/ntp.py b/sos/plugins/ntp.py index b2a529e0..760ecea9 100644 --- a/sos/plugins/ntp.py +++ b/sos/plugins/ntp.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ntp(Plugin): - """NTP related information + """Network time protocol """ plugin_name = "ntp" @@ -34,8 +34,6 @@ class Ntp(Plugin): class RedHatNtp(Ntp, RedHatPlugin): - """NTP related information for RedHat based distributions - """ def setup(self): super(RedHatNtp, self).setup() @@ -44,8 +42,6 @@ class RedHatNtp(Ntp, RedHatPlugin): class DebianNtp(Ntp, DebianPlugin, UbuntuPlugin): - """NTP related information for Debian based distributions - """ def setup(self): super(DebianNtp, self).setup() diff --git a/sos/plugins/oddjob.py b/sos/plugins/oddjob.py index fec661bb..bb796165 100644 --- a/sos/plugins/oddjob.py +++ b/sos/plugins/oddjob.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Oddjob(Plugin, RedHatPlugin): - """oddjob related information + """OddJob task scheduler """ plugin_name = 'oddjob' diff --git a/sos/plugins/openhpi.py b/sos/plugins/openhpi.py index 9f30513c..c6228b0e 100644 --- a/sos/plugins/openhpi.py +++ b/sos/plugins/openhpi.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class OpenHPI(Plugin, RedHatPlugin): - """OpenHPI related information + """Open Hardware Platform Interface """ plugin_name = 'openhpi' diff --git a/sos/plugins/openshift.py b/sos/plugins/openshift.py index 44eb8091..d34ab5cd 100644 --- a/sos/plugins/openshift.py +++ b/sos/plugins/openshift.py @@ -17,7 +17,7 @@ import os.path class Openshift(Plugin, RedHatPlugin): - '''Openshift related information''' + '''Openshift node and broker''' plugin_name = "openshift" profiles = ('virt', 'openshift') diff --git a/sos/plugins/openssl.py b/sos/plugins/openssl.py index 4cfa952d..30bf3a5a 100644 --- a/sos/plugins/openssl.py +++ b/sos/plugins/openssl.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenSSL(Plugin): - """openssl related information + """OpenSSL configuration """ plugin_name = "openssl" @@ -42,7 +42,7 @@ class OpenSSL(Plugin): class RedHatOpenSSL(OpenSSL, RedHatPlugin): - """openssl related information for Red Hat distributions + """openssl related information """ files = ('/etc/pki/tls/openssl.cnf',) diff --git a/sos/plugins/openstack_ceilometer.py b/sos/plugins/openstack_ceilometer.py index b6236ddd..f5f0a9d8 100644 --- a/sos/plugins/openstack_ceilometer.py +++ b/sos/plugins/openstack_ceilometer.py @@ -22,7 +22,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackCeilometer(Plugin): - """Openstack Ceilometer related information.""" + """Openstack Ceilometer""" plugin_name = "openstack_ceilometer" profiles = ('openstack',) @@ -38,8 +38,6 @@ class OpenStackCeilometer(Plugin): class DebianOpenStackCeilometer(OpenStackCeilometer, DebianPlugin, UbuntuPlugin): - """OpenStackCeilometer related information for Debian based distributions. - """ packages = ( 'ceilometer-api', @@ -53,7 +51,6 @@ class DebianOpenStackCeilometer(OpenStackCeilometer, DebianPlugin, class RedHatOpenStackCeilometer(OpenStackCeilometer, RedHatPlugin): - """OpenStackCeilometer related information for Red Hat distributions.""" packages = ( 'openstack-ceilometer', diff --git a/sos/plugins/openstack_cinder.py b/sos/plugins/openstack_cinder.py index ed2fce37..5e438cce 100644 --- a/sos/plugins/openstack_cinder.py +++ b/sos/plugins/openstack_cinder.py @@ -22,7 +22,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackCinder(Plugin): - """openstack cinder related information + """OpenStack cinder """ plugin_name = "openstack_cinder" profiles = ('openstack',) @@ -44,8 +44,6 @@ class OpenStackCinder(Plugin): class DebianOpenStackCinder(OpenStackCinder, DebianPlugin, UbuntuPlugin): - """OpenStack Cinder related information for Debian based distributions - """ cinder = False packages = ( @@ -67,8 +65,6 @@ class DebianOpenStackCinder(OpenStackCinder, DebianPlugin, UbuntuPlugin): class RedHatOpenStackCinder(OpenStackCinder, RedHatPlugin): - """OpenStack related information for Red Hat distributions - """ cinder = False packages = ('openstack-cinder', diff --git a/sos/plugins/openstack_glance.py b/sos/plugins/openstack_glance.py index 9b68c038..c26d979b 100644 --- a/sos/plugins/openstack_glance.py +++ b/sos/plugins/openstack_glance.py @@ -21,7 +21,7 @@ from sos import plugins class OpenStackGlance(plugins.Plugin): - """OpenstackGlance related information.""" + """OpenStack Glance""" plugin_name = "openstack_glance" profiles = ('openstack',) @@ -42,7 +42,6 @@ class OpenStackGlance(plugins.Plugin): class DebianOpenStackGlance(OpenStackGlance, plugins.DebianPlugin, plugins.UbuntuPlugin): - """OpenStackGlance related information for Debian based distributions.""" packages = ( 'glance', @@ -55,7 +54,6 @@ class DebianOpenStackGlance(OpenStackGlance, class RedHatOpenStackGlance(OpenStackGlance, plugins.RedHatPlugin): - """OpenStackGlance related information for Red Hat distributions.""" packages = ( 'openstack-glance', diff --git a/sos/plugins/openstack_heat.py b/sos/plugins/openstack_heat.py index 2b14cf4d..39c47272 100644 --- a/sos/plugins/openstack_heat.py +++ b/sos/plugins/openstack_heat.py @@ -18,7 +18,7 @@ from sos import plugins class OpenStackHeat(plugins.Plugin): - """openstack related information + """OpenStack Heat """ plugin_name = "openstack_heat" profiles = ('openstack',) @@ -40,7 +40,6 @@ class OpenStackHeat(plugins.Plugin): class DebianOpenStack(OpenStackHeat, plugins.DebianPlugin, plugins.UbuntuPlugin): - """OpenStackHeat related information for Debian based distributions.""" packages = ( 'heat-api', @@ -54,7 +53,6 @@ class DebianOpenStack(OpenStackHeat, class RedHatOpenStack(OpenStackHeat, plugins.RedHatPlugin): - """OpenStackHeat related information for Red Hat distributions.""" packages = ( 'openstack-heat-api', diff --git a/sos/plugins/openstack_horizon.py b/sos/plugins/openstack_horizon.py index 4ddc4a49..46f0031f 100644 --- a/sos/plugins/openstack_horizon.py +++ b/sos/plugins/openstack_horizon.py @@ -21,7 +21,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackHorizon(Plugin): - """openstack horizon related information + """OpenStack Horizon """ plugin_name = "openstack_horizon" @@ -35,8 +35,6 @@ class OpenStackHorizon(Plugin): class DebianOpenStackHorizon(OpenStackHorizon, DebianPlugin): - """OpenStack Horizon related information for Debian based distributions - """ packages = ( 'python-django-horizon', @@ -50,8 +48,6 @@ class DebianOpenStackHorizon(OpenStackHorizon, DebianPlugin): class UbuntuOpenStackHorizon(OpenStackHorizon, UbuntuPlugin): - """OpenStack Horizon related information for Ubuntu based distributions - """ packages = ( 'python-django-horizon', @@ -65,8 +61,6 @@ class UbuntuOpenStackHorizon(OpenStackHorizon, UbuntuPlugin): class RedHatOpenStackHorizon(OpenStackHorizon, RedHatPlugin): - """OpenStack Horizon related information for Red Hat distributions - """ packages = ( 'python-django-horizon', diff --git a/sos/plugins/openstack_keystone.py b/sos/plugins/openstack_keystone.py index 3f539f3e..41f52f8d 100644 --- a/sos/plugins/openstack_keystone.py +++ b/sos/plugins/openstack_keystone.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackKeystone(Plugin): - """openstack keystone related information + """OpenStack Keystone """ plugin_name = "openstack_keystone" profiles = ('openstack',) @@ -56,8 +56,6 @@ class OpenStackKeystone(Plugin): class DebianOpenStackKeystone(OpenStackKeystone, DebianPlugin, UbuntuPlugin): - """OpenStack Keystone related information for Debian based distributions - """ packages = ( 'keystone', @@ -67,8 +65,6 @@ class DebianOpenStackKeystone(OpenStackKeystone, DebianPlugin, UbuntuPlugin): class RedHatOpenStackKeystone(OpenStackKeystone, RedHatPlugin): - """OpenStack Keystone related information for Red Hat distributions - """ packages = ( 'openstack-keystone', diff --git a/sos/plugins/openstack_neutron.py b/sos/plugins/openstack_neutron.py index e2975adc..8b8c03d6 100644 --- a/sos/plugins/openstack_neutron.py +++ b/sos/plugins/openstack_neutron.py @@ -28,7 +28,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Neutron(Plugin): - """OpenStack Networking (quantum/neutron) related information + """OpenStack Networking """ plugin_name = "neutron" profiles = ('openstack',) @@ -120,8 +120,6 @@ class Neutron(Plugin): class DebianNeutron(Neutron, DebianPlugin, UbuntuPlugin): - """OpenStack Neutron related information for Debian based distributions - """ package_list_template = [ '%(comp)s-common', '%(comp)s-plugin-cisco', @@ -146,8 +144,6 @@ class DebianNeutron(Neutron, DebianPlugin, UbuntuPlugin): class RedHatNeutron(Neutron, RedHatPlugin): - """OpenStack Neutron related information for Red Hat distributions - """ package_list_template = [ 'openstack-%(comp)s', diff --git a/sos/plugins/openstack_nova.py b/sos/plugins/openstack_nova.py index 08f93a88..fec5225f 100644 --- a/sos/plugins/openstack_nova.py +++ b/sos/plugins/openstack_nova.py @@ -21,7 +21,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackNova(Plugin): - """openstack nova related information + """OpenStack Nova """ plugin_name = "openstack_nova" profiles = ('openstack',) @@ -76,8 +76,6 @@ class OpenStackNova(Plugin): class DebianOpenStackNova(OpenStackNova, DebianPlugin, UbuntuPlugin): - """OpenStack nova related information for Debian based distributions - """ nova = False packages = ( @@ -114,8 +112,6 @@ class DebianOpenStackNova(OpenStackNova, DebianPlugin, UbuntuPlugin): class RedHatOpenStackNova(OpenStackNova, RedHatPlugin): - """OpenStack nova related information for Red Hat distributions - """ nova = False packages = ( diff --git a/sos/plugins/openstack_swift.py b/sos/plugins/openstack_swift.py index c42dabee..81727e0e 100644 --- a/sos/plugins/openstack_swift.py +++ b/sos/plugins/openstack_swift.py @@ -21,7 +21,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenStackSwift(Plugin): - """OpenstackSwift related information.""" + """OpenStack Swift""" plugin_name = "openstack_swift" profiles = ('openstack',) @@ -33,7 +33,6 @@ class OpenStackSwift(Plugin): class DebianOpenStackSwift(OpenStackSwift, DebianPlugin, UbuntuPlugin): - """OpenStackSwift related information for Debian based distributions.""" packages = ( 'swift', @@ -48,7 +47,6 @@ class DebianOpenStackSwift(OpenStackSwift, DebianPlugin, UbuntuPlugin): class RedHatOpenStackSwift(OpenStackSwift, RedHatPlugin): - """OpenStackSwift related information for Red Hat distributions.""" packages = ( 'openstack-swift', diff --git a/sos/plugins/openswan.py b/sos/plugins/openswan.py index f26744b1..039ab2d7 100644 --- a/sos/plugins/openswan.py +++ b/sos/plugins/openswan.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Openswan(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ipsec related information + """Openswan IPsec """ plugin_name = 'openswan' diff --git a/sos/plugins/openvswitch.py b/sos/plugins/openvswitch.py index 5469f85f..3611671c 100644 --- a/sos/plugins/openvswitch.py +++ b/sos/plugins/openvswitch.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class OpenVSwitch(Plugin): - """ OpenVSwitch related information + """ OpenVSwitch networking """ plugin_name = "openvswitch" profiles = ('network', 'virt') @@ -34,14 +34,12 @@ class OpenVSwitch(Plugin): class RedHatOpenVSwitch(OpenVSwitch, RedHatPlugin): - """ OpenVSwitch on Ubuntu/Debian related information - """ + packages = ('openvswitch',) class DebianOpenVSwitch(OpenVSwitch, DebianPlugin, UbuntuPlugin): - """ OpenVSwitch on Ubuntu/Debian related information - """ + packages = ('openvswitch-switch',) diff --git a/sos/plugins/ovirt.py b/sos/plugins/ovirt.py index f9a7cb1d..24c1cfa0 100644 --- a/sos/plugins/ovirt.py +++ b/sos/plugins/ovirt.py @@ -26,7 +26,7 @@ from sos.plugins import Plugin, RedHatPlugin # Class name must be the same as file name and method names must not change class Ovirt(Plugin, RedHatPlugin): - """oVirt Engine related information""" + """oVirt Engine""" plugin_name = "ovirt" profiles = ('virt',) diff --git a/sos/plugins/ovirt_hosted_engine.py b/sos/plugins/ovirt_hosted_engine.py index d28a95ea..9e404afe 100644 --- a/sos/plugins/ovirt_hosted_engine.py +++ b/sos/plugins/ovirt_hosted_engine.py @@ -22,7 +22,7 @@ from sos.plugins import Plugin, RedHatPlugin class OvirtHostedEngine(Plugin, RedHatPlugin): - """oVirt Hosted Engine related information""" + """oVirt Hosted Engine""" packages = ( 'ovirt-hosted-engine-setup', diff --git a/sos/plugins/pam.py b/sos/plugins/pam.py index 9064caab..bb174dac 100644 --- a/sos/plugins/pam.py +++ b/sos/plugins/pam.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Pam(Plugin): - """PAM related information + """Pluggable Authentication Modules """ plugin_name = "pam" @@ -36,8 +36,6 @@ class Pam(Plugin): class RedHatPam(Pam, RedHatPlugin): - """PAM related information for RedHat based distribution - """ security_libs = "/lib*/security" def setup(self): @@ -45,8 +43,6 @@ class RedHatPam(Pam, RedHatPlugin): class DebianPam(Pam, DebianPlugin, UbuntuPlugin): - """PAM related information for Debian based distribution - """ security_libs = "/lib/x86_64-linux-gnu/security" def setup(self): diff --git a/sos/plugins/pci.py b/sos/plugins/pci.py index bd5ec927..964a1c4b 100644 --- a/sos/plugins/pci.py +++ b/sos/plugins/pci.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Pci(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """PCI device related information + """PCI devices """ plugin_name = "pci" diff --git a/sos/plugins/pcp.py b/sos/plugins/pcp.py index d715bd3e..7ca1a995 100644 --- a/sos/plugins/pcp.py +++ b/sos/plugins/pcp.py @@ -21,7 +21,7 @@ from socket import gethostname class Pcp(Plugin, RedHatPlugin, DebianPlugin): - """ Collect Performance Co-Pilot data + """Performance Co-Pilot data """ plugin_name = 'pcp' diff --git a/sos/plugins/postfix.py b/sos/plugins/postfix.py index 89ee97db..f6248ef8 100644 --- a/sos/plugins/postfix.py +++ b/sos/plugins/postfix.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Postfix(Plugin): - """mail server related information + """Postfix smtp server """ plugin_name = "postfix" profiles = ('mail', 'services') @@ -32,8 +32,6 @@ class Postfix(Plugin): class RedHatPostfix(Postfix, RedHatPlugin): - """mail server related information for RedHat based distributions - """ files = ('/etc/rc.d/init.d/postfix',) packages = ('postfix',) @@ -44,8 +42,6 @@ class RedHatPostfix(Postfix, RedHatPlugin): class DebianPostfix(Postfix, DebianPlugin, UbuntuPlugin): - """mail server related information for Debian based Distribution - """ packages = ('postfix',) diff --git a/sos/plugins/postgresql.py b/sos/plugins/postgresql.py index ec94cd76..8cac0947 100644 --- a/sos/plugins/postgresql.py +++ b/sos/plugins/postgresql.py @@ -25,7 +25,7 @@ from sos.utilities import find class PostgreSQL(Plugin): - """PostgreSQL related information""" + """PostgreSQL RDBMS""" plugin_name = "postgresql" profiles = ('services',) @@ -113,7 +113,6 @@ class PostgreSQL(Plugin): class RedHatPostgreSQL(PostgreSQL, RedHatPlugin): - """PostgreSQL related information for Red Hat distributions""" def setup(self): super(RedHatPostgreSQL, self).setup() @@ -142,7 +141,6 @@ class RedHatPostgreSQL(PostgreSQL, RedHatPlugin): class DebianPostgreSQL(PostgreSQL, DebianPlugin, UbuntuPlugin): - """PostgreSQL related information for Debian/Ubuntu distributions""" def setup(self): super(DebianPostgreSQL, self).setup() diff --git a/sos/plugins/powerpc.py b/sos/plugins/powerpc.py index e95a3e8d..48899936 100644 --- a/sos/plugins/powerpc.py +++ b/sos/plugins/powerpc.py @@ -20,7 +20,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class PowerPC(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """IBM Power System related information + """IBM Power systems """ plugin_name = 'powerpc' diff --git a/sos/plugins/ppp.py b/sos/plugins/ppp.py index fa190b47..8631e803 100644 --- a/sos/plugins/ppp.py +++ b/sos/plugins/ppp.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ppp(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ppp, wvdial and rp-pppoe related information + """Point-to-point protocol """ plugin_name = 'ppp' diff --git a/sos/plugins/procenv.py b/sos/plugins/procenv.py index 84c7680f..57f45a6d 100644 --- a/sos/plugins/procenv.py +++ b/sos/plugins/procenv.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, DebianPlugin, UbuntuPlugin class Procenv(Plugin, DebianPlugin, UbuntuPlugin): - """Process environment. + """Process environment """ plugin_name = 'procenv' diff --git a/sos/plugins/psacct.py b/sos/plugins/psacct.py index 8e1011ba..63bcebdc 100644 --- a/sos/plugins/psacct.py +++ b/sos/plugins/psacct.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Psacct(Plugin): - """Process accounting related information + """Process accounting information """ plugin_name = "psacct" profiles = ('system',) @@ -28,8 +28,6 @@ class Psacct(Plugin): class RedHatPsacct(Psacct, RedHatPlugin): - """Process accounting related information for RedHat based distributions - """ packages = ["psacct"] @@ -41,8 +39,6 @@ class RedHatPsacct(Psacct, RedHatPlugin): class DebianPsacct(Psacct, DebianPlugin, UbuntuPlugin): - """Process accounting related information for Debian based distributions - """ plugin_name = "acct" packages = ["acct"] diff --git a/sos/plugins/pxe.py b/sos/plugins/pxe.py index ba66722f..08227d65 100644 --- a/sos/plugins/pxe.py +++ b/sos/plugins/pxe.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Pxe(Plugin): - """PXE related information + """PXE service """ plugin_name = "pxe" profiles = ('sysmgmt', 'network') @@ -25,8 +25,6 @@ class Pxe(Plugin): class RedHatPxe(Pxe, RedHatPlugin): - """PXE related information for RedHat based distributions - """ files = ('/usr/sbin/pxeos',) packages = ('system-config-netboot-cmd',) @@ -40,8 +38,6 @@ class RedHatPxe(Pxe, RedHatPlugin): class DebianPxe(Pxe, DebianPlugin, UbuntuPlugin): - """PXE related information for Ubuntu based distributions - """ packages = ('tftpd-hpa',) diff --git a/sos/plugins/python.py b/sos/plugins/python.py index 27cf5957..e143d1ef 100644 --- a/sos/plugins/python.py +++ b/sos/plugins/python.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Python(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Python_Version information. + """Python runtime """ plugin_name = 'python' diff --git a/sos/plugins/qpid.py b/sos/plugins/qpid.py index 72234f3d..86eaf7c7 100644 --- a/sos/plugins/qpid.py +++ b/sos/plugins/qpid.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class Qpid(Plugin, RedHatPlugin): - """Messaging related information + """Qpid messaging """ plugin_name = 'qpid' diff --git a/sos/plugins/quagga.py b/sos/plugins/quagga.py index 1b26a214..9ed00cd0 100644 --- a/sos/plugins/quagga.py +++ b/sos/plugins/quagga.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Quagga(Plugin, RedHatPlugin): - """quagga related information + """Quagga routing service """ plugin_name = 'quagga' diff --git a/sos/plugins/rabbitmq.py b/sos/plugins/rabbitmq.py index 3d19e7d0..ee09fa3d 100644 --- a/sos/plugins/rabbitmq.py +++ b/sos/plugins/rabbitmq.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class RabbitMQ(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """rabbitmq related information + """RabbitMQ messaging service """ plugin_name = 'rabbitmq' profiles = ('services',) diff --git a/sos/plugins/radius.py b/sos/plugins/radius.py index aadab513..22a9fceb 100644 --- a/sos/plugins/radius.py +++ b/sos/plugins/radius.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Radius(Plugin): - """radius related information + """RADIUS service information """ plugin_name = "radius" @@ -27,8 +27,6 @@ class Radius(Plugin): class RedHatRadius(Radius, RedHatPlugin): - """radius related information on Red Hat distributions - """ files = ('/etc/raddb',) @@ -46,8 +44,6 @@ class RedHatRadius(Radius, RedHatPlugin): class DebianRadius(Radius, DebianPlugin, UbuntuPlugin): - """radius related information on Debian distributions - """ files = ('/etc/freeradius',) diff --git a/sos/plugins/rhui.py b/sos/plugins/rhui.py index 7b619a45..c8ae0b7c 100644 --- a/sos/plugins/rhui.py +++ b/sos/plugins/rhui.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class Rhui(Plugin, RedHatPlugin): - """Red Hat Update Infrastructure for Cloud Providers data + """Red Hat Update Infrastructure """ plugin_name = 'rhui' diff --git a/sos/plugins/rpm.py b/sos/plugins/rpm.py index 112a3b53..ee9d4d5d 100644 --- a/sos/plugins/rpm.py +++ b/sos/plugins/rpm.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class Rpm(Plugin, RedHatPlugin): - """RPM information + """RPM Package Manager """ plugin_name = 'rpm' diff --git a/sos/plugins/s390.py b/sos/plugins/s390.py index 6a4da995..5de8b53f 100644 --- a/sos/plugins/s390.py +++ b/sos/plugins/s390.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class S390(Plugin, RedHatPlugin): - """s390 related information + """IBM S/390 """ plugin_name = 's390' diff --git a/sos/plugins/samba.py b/sos/plugins/samba.py index 0325b954..f4e071ea 100644 --- a/sos/plugins/samba.py +++ b/sos/plugins/samba.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Samba(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Samba related information + """Samba Windows interoperability """ packages = ('samba-common',) plugin_name = "samba" diff --git a/sos/plugins/sanlock.py b/sos/plugins/sanlock.py index 52a9d1cf..3a58bc90 100644 --- a/sos/plugins/sanlock.py +++ b/sos/plugins/sanlock.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class SANLock(Plugin): - """sanlock-related information + """SANlock daemon """ plugin_name = "sanlock" profiles = ('cluster', 'virt') diff --git a/sos/plugins/sar.py b/sos/plugins/sar.py index 34ea0b89..16cafe57 100644 --- a/sos/plugins/sar.py +++ b/sos/plugins/sar.py @@ -17,7 +17,7 @@ import os class Sar(Plugin,): - """ Collect system activity reporter data + """System Activity Reporter """ plugin_name = 'sar' @@ -75,15 +75,11 @@ class Sar(Plugin,): class RedHatSar(Sar, RedHatPlugin): - """ Collect system activity reporter data - """ sa_path = '/var/log/sa' class DebianSar(Sar, DebianPlugin, UbuntuPlugin): - """ Collect system activity reporter data - """ sa_path = '/var/log/sysstat' diff --git a/sos/plugins/satellite.py b/sos/plugins/satellite.py index 67b83cd0..9637d55c 100644 --- a/sos/plugins/satellite.py +++ b/sos/plugins/satellite.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class Satellite(Plugin, RedHatPlugin): - """RHN Satellite and Spacewalk related information + """RHN Satellite and Spacewalk """ plugin_name = 'satellite' diff --git a/sos/plugins/scsi.py b/sos/plugins/scsi.py index a4b23aa2..e8aad08c 100644 --- a/sos/plugins/scsi.py +++ b/sos/plugins/scsi.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Scsi(Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin): - """hardware related information + """SCSI devices """ plugin_name = 'scsi' diff --git a/sos/plugins/selinux.py b/sos/plugins/selinux.py index 22ac2522..d59c1404 100644 --- a/sos/plugins/selinux.py +++ b/sos/plugins/selinux.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class SELinux(Plugin, RedHatPlugin): - """selinux related information + """SELinux access control """ plugin_name = 'selinux' diff --git a/sos/plugins/sendmail.py b/sos/plugins/sendmail.py index 16f246b8..432f1704 100644 --- a/sos/plugins/sendmail.py +++ b/sos/plugins/sendmail.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Sendmail(Plugin): - """sendmail information + """sendmail service """ plugin_name = "sendmail" @@ -28,8 +28,6 @@ class Sendmail(Plugin): class RedHatSendmail(Sendmail, RedHatPlugin): - """sendmail information for RedHat based distributions - """ files = ('/etc/rc.d/init.d/sendmail',) packages = ('sendmail',) @@ -43,8 +41,6 @@ class RedHatSendmail(Sendmail, RedHatPlugin): class DebianSendmail(Sendmail, DebianPlugin, UbuntuPlugin): - """sendmail information for Debian based distributions - """ files = ('/etc/init.d/sendmail',) packages = ('sendmail',) diff --git a/sos/plugins/smartcard.py b/sos/plugins/smartcard.py index 65341c28..3c5ce885 100644 --- a/sos/plugins/smartcard.py +++ b/sos/plugins/smartcard.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Smartcard(Plugin, RedHatPlugin): - """Smart Card related information + """PKCS#11 smart cards """ plugin_name = 'smartcard' diff --git a/sos/plugins/snmp.py b/sos/plugins/snmp.py index 22b0050d..5d470b5f 100644 --- a/sos/plugins/snmp.py +++ b/sos/plugins/snmp.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Snmp(Plugin): - """snmp related information + """Simple network management protocol """ plugin_name = "snmp" profiles = ('system', 'sysmgmt') @@ -30,8 +30,6 @@ class Snmp(Plugin): class RedHatSnmp(Snmp, RedHatPlugin): - """snmp related information for RedHat based distributions - """ packages = ('net-snmp',) @@ -40,8 +38,6 @@ class RedHatSnmp(Snmp, RedHatPlugin): class DebianSnmp(Snmp, DebianPlugin, UbuntuPlugin): - """snmp related information for Debian based distributions - """ packages = ('snmp',) diff --git a/sos/plugins/soundcard.py b/sos/plugins/soundcard.py index 18b2d711..0686ae6e 100644 --- a/sos/plugins/soundcard.py +++ b/sos/plugins/soundcard.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Soundcard(Plugin): - """ Sound card information + """ Sound devices """ plugin_name = "soundcard" @@ -35,8 +35,6 @@ class Soundcard(Plugin): class RedHatSoundcard(Soundcard, RedHatPlugin): - """ Sound card information for RedHat distros - """ def setup(self): super(RedHatSoundcard, self).setup() @@ -48,8 +46,6 @@ class RedHatSoundcard(Soundcard, RedHatPlugin): class DebianSoundcard(Soundcard, DebianPlugin, UbuntuPlugin): - """ Sound card information for Debian/Ubuntu distros - """ def setup(self): super(DebianSoundcard, self).setup() diff --git a/sos/plugins/squid.py b/sos/plugins/squid.py index 7e9b0705..b046a08b 100644 --- a/sos/plugins/squid.py +++ b/sos/plugins/squid.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Squid(Plugin): - """squid related information + """Squid caching proxy """ plugin_name = 'squid' @@ -24,8 +24,6 @@ class Squid(Plugin): class RedHatSquid(Squid, RedHatPlugin): - """squid Red Hat related information - """ files = ('/etc/squid/squid.conf',) packages = ('squid',) @@ -36,8 +34,6 @@ class RedHatSquid(Squid, RedHatPlugin): class DebianSquid(Squid, DebianPlugin, UbuntuPlugin): - """squid related information for Debian and Ubuntu - """ plugin_name = 'squid' files = ('/etc/squid3/squid.conf',) diff --git a/sos/plugins/ssh.py b/sos/plugins/ssh.py index 0e6a8d9e..f8f772ba 100644 --- a/sos/plugins/ssh.py +++ b/sos/plugins/ssh.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Ssh(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ssh-related information + """Secure shell service """ plugin_name = 'ssh' diff --git a/sos/plugins/sssd.py b/sos/plugins/sssd.py index 55bdcb5f..8888c5cf 100644 --- a/sos/plugins/sssd.py +++ b/sos/plugins/sssd.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Sssd(Plugin): - """sssd-related Diagnostic Information + """System security service daemon """ plugin_name = "sssd" @@ -38,16 +38,12 @@ class Sssd(Plugin): class RedHatSssd(Sssd, RedHatPlugin): - """sssd-related Diagnostic Information on Red Hat based distributions - """ def setup(self): super(RedHatSssd, self).setup() class DebianSssd(Sssd, DebianPlugin, UbuntuPlugin): - """sssd-related Diagnostic Information on Debian based distributions - """ def setup(self): super(DebianSssd, self).setup() diff --git a/sos/plugins/startup.py b/sos/plugins/startup.py index 64f2f15a..afa0c9ed 100644 --- a/sos/plugins/startup.py +++ b/sos/plugins/startup.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Startup(Plugin): - """startup information + """System startup """ plugin_name = "startup" @@ -36,8 +36,6 @@ class Startup(Plugin): class RedHatStartup(Startup, RedHatPlugin): - """startup information for RedHat based distributions - """ def setup(self): super(RedHatStartup, self).setup() @@ -45,8 +43,6 @@ class RedHatStartup(Startup, RedHatPlugin): class DebianStartup(Startup, DebianPlugin, UbuntuPlugin): - """startup information - """ def setup(self): super(DebianStartup, self).setup() diff --git a/sos/plugins/sunrpc.py b/sos/plugins/sunrpc.py index d2bccd27..6c97fabc 100644 --- a/sos/plugins/sunrpc.py +++ b/sos/plugins/sunrpc.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class SunRPC(Plugin): - """Sun RPC related information + """Sun RPC service """ plugin_name = "sunrpc" @@ -37,15 +37,13 @@ class SunRPC(Plugin): class RedHatSunRPC(SunRPC, RedHatPlugin): - """Sun RPC related information for Red Hat systems - """ service = 'rpcbind' # FIXME: depends on addition of runlevel_by_service (or similar) # in Debian/Ubuntu policy classes # class DebianSunRPC(SunRPC, DebianPlugin, UbuntuPlugin): -# """Sun RPC related information for Red Hat systems +# """Sun RPC related information # """ # # service = 'rpcbind-boot' diff --git a/sos/plugins/system.py b/sos/plugins/system.py index 261f7d2c..e25aed7c 100644 --- a/sos/plugins/system.py +++ b/sos/plugins/system.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class System(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """core system related information + """core system information """ plugin_name = "system" diff --git a/sos/plugins/systemd.py b/sos/plugins/systemd.py index ec758cf0..2ca8f21e 100644 --- a/sos/plugins/systemd.py +++ b/sos/plugins/systemd.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Systemd(Plugin, RedHatPlugin): - """ Information on systemd and related subsystems + """ System management daemon """ plugin_name = "systemd" diff --git a/sos/plugins/systemtap.py b/sos/plugins/systemtap.py index 0936bcb9..3e0c8f65 100644 --- a/sos/plugins/systemtap.py +++ b/sos/plugins/systemtap.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class SystemTap(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """SystemTap information + """SystemTap dynamic instrumentation """ plugin_name = 'systemtap' diff --git a/sos/plugins/sysvipc.py b/sos/plugins/sysvipc.py index 35f5ff1d..fe989429 100644 --- a/sos/plugins/sysvipc.py +++ b/sos/plugins/sysvipc.py @@ -17,7 +17,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class SysVIPC(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """SysV IPC related information + """SysV IPC """ plugin_name = "sysvipc" diff --git a/sos/plugins/tftpserver.py b/sos/plugins/tftpserver.py index 75078de7..9c98447a 100644 --- a/sos/plugins/tftpserver.py +++ b/sos/plugins/tftpserver.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class TftpServer(Plugin, RedHatPlugin): - """tftpserver related information + """TFTP server """ plugin_name = 'tftpserver' diff --git a/sos/plugins/tomcat.py b/sos/plugins/tomcat.py index efc86ea0..e048aae9 100644 --- a/sos/plugins/tomcat.py +++ b/sos/plugins/tomcat.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class Tomcat(Plugin, RedHatPlugin): - """Tomcat related information + """Apache Tomcat server """ plugin_name = 'tomcat' diff --git a/sos/plugins/tuned.py b/sos/plugins/tuned.py index 9400515a..27c2ba78 100644 --- a/sos/plugins/tuned.py +++ b/sos/plugins/tuned.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin class Tuned(Plugin, RedHatPlugin): - """Tuned related information + """Tuned system tuning daemon """ packages = ('tuned',) profiles = ('system', 'performance') diff --git a/sos/plugins/udev.py b/sos/plugins/udev.py index c965cc93..62cdb27f 100644 --- a/sos/plugins/udev.py +++ b/sos/plugins/udev.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Udev(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """Udev related information + """udev dynamic device management """ plugin_name = 'udev' diff --git a/sos/plugins/upstart.py b/sos/plugins/upstart.py index e15d248f..d8e9f51a 100644 --- a/sos/plugins/upstart.py +++ b/sos/plugins/upstart.py @@ -18,7 +18,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class Upstart(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """ Information on Upstart, the event-based init system. + """Upstart init system """ plugin_name = 'upstart' diff --git a/sos/plugins/usb.py b/sos/plugins/usb.py index 1df0cf44..b3da2aea 100644 --- a/sos/plugins/usb.py +++ b/sos/plugins/usb.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, UbuntuPlugin, DebianPlugin class Usb(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """USB device related information + """USB devices """ plugin_name = "usb" diff --git a/sos/plugins/veritas.py b/sos/plugins/veritas.py index f78a65fd..5bbb7230 100644 --- a/sos/plugins/veritas.py +++ b/sos/plugins/veritas.py @@ -17,7 +17,7 @@ import os class Veritas(Plugin, RedHatPlugin): - """Veritas related information + """Veritas software """ plugin_name = 'veritas' diff --git a/sos/plugins/vmware.py b/sos/plugins/vmware.py index c470701b..6932ff7e 100644 --- a/sos/plugins/vmware.py +++ b/sos/plugins/vmware.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class VMWare(Plugin, RedHatPlugin): - """VMWare related information + """VMWare client information """ plugin_name = 'vmware' diff --git a/sos/plugins/vsftpd.py b/sos/plugins/vsftpd.py index f4214778..09760bf5 100644 --- a/sos/plugins/vsftpd.py +++ b/sos/plugins/vsftpd.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin class Vsftpd(Plugin, RedHatPlugin): - """FTP server related information + """Vsftpd server """ plugin_name = 'vsftpd' diff --git a/sos/plugins/x11.py b/sos/plugins/x11.py index bbc92561..bbf2970e 100644 --- a/sos/plugins/x11.py +++ b/sos/plugins/x11.py @@ -16,7 +16,7 @@ from sos.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin class X11(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """X related information + """X windowing system """ plugin_name = 'x11' diff --git a/sos/plugins/xen.py b/sos/plugins/xen.py index 57e92c07..702ed0e2 100644 --- a/sos/plugins/xen.py +++ b/sos/plugins/xen.py @@ -19,7 +19,7 @@ from stat import * class Xen(Plugin, RedHatPlugin): - """Xen related information + """Xen virtualization """ plugin_name = 'xen' diff --git a/sos/plugins/xfs.py b/sos/plugins/xfs.py index 8b5f7ec3..4e61e2bf 100644 --- a/sos/plugins/xfs.py +++ b/sos/plugins/xfs.py @@ -17,7 +17,7 @@ from six.moves import zip class Xfs(Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin): - """information on the XFS filesystem + """XFS filesystem """ plugin_name = 'xfs' |