Browse Source

Updated distribution information

Paul Trost 11 years ago
parent
commit
19dbf32684
4 changed files with 40 additions and 119 deletions
  1. 39 0
      INSTALL
  2. 1 2
      MANIFEST
  3. 0 61
      README
  4. 0 56
      t/boilerplate.t

+ 39 - 0
INSTALL

@@ -0,0 +1,39 @@
+Disk-SMART
+
+This module requires that smartctl be accessed as root. If you do not wish to install the module as root then you will need to make smartctl SETUID as root with "chmod u+s <path/to/smartctl>"
+
+To install this module, run the following commands:
+
+	perl Makefile.PL
+	make
+	sudo make test
+	sudo make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+    perldoc Disk::SMART
+
+You can also look for information at:
+
+    RT, CPAN's request tracker (report bugs here)
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Disk-SMART
+
+    AnnoCPAN, Annotated CPAN documentation
+        http://annocpan.org/dist/Disk-SMART
+
+    CPAN Ratings
+        http://cpanratings.perl.org/d/Disk-SMART
+
+    Search CPAN
+        http://search.cpan.org/dist/Disk-SMART/
+
+
+LICENSE AND COPYRIGHT
+
+Copyright 2014 Paul Trost
+This script is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License v2, or at your option any later version.
+<http://gnu.org/licenses/gpl.html>
+

+ 1 - 2
MANIFEST

@@ -3,10 +3,9 @@ lib/Disk/SMART.pm
 Makefile.PL
 MANIFEST			This list of files
 INSTALL
-README.md
 t/00-load.t
 t/01-instantiation.t
-t/02_get_functions.t
+t/02-get_functions.t
 t/manifest.t
 t/pod-coverage.t
 t/pod.t

+ 0 - 61
README

@@ -1,61 +0,0 @@
-Disk::SMART(3)        User Contributed Perl Documentation       Disk::SMART(3)
-
-
-
-NNAAMMEE
-       Disk::SMART - Provides an interface to smartctl
-
-VVEERRSSIIOONN
-       Version 0.01
-
-SSYYNNOOPPSSIISS
-       Disk::SMART is an object ooriented module that provides an interface to
-       get SMART disk info from a device as well as initiate testing.
-
-           use Disk::SMART;
-
-           my $smart = Disk::SMART->new('/dev/sda');
-
-MMEETTHHOODDSS
-   nneeww ((DDEEVVIICCEE))
-       Instantiates the Disk::SMART object
-
-       "DEVICE" - Device identifier of SSD / Hard Drive
-
-           my $smart = Disk::SMART->new( 'dev/sda', '/dev/sdb' );
-
-GGeettttiinngg iinnffoorrmmaattiioonn ffrroomm ssmmaarrttccttll
-   ggeett__ddiisskk__tteemmpp ((DDEEVVIICCEE))
-       Returns an array with the temperature of the device in Celsius and
-       Farenheit, or N/A.
-
-       "DEVICE" - Device identifier of SSD / Hard Drive
-
-           my ($temp_c, $temp_f) = $smart->get_disk_temp('/dev/sda');
-
-   ggeett__ddiisskk__hheeaalltthh ((DDEEVVIICCEE))
-       Returns the health of the disk. Output is "PASSED", "FAILED", or "N/A".
-
-       "DEVICE" - Device identifier of SSD / Hard Drive
-
-           my $disk_health = $smart->get_disk_health('/dev/sda');
-
-   ggeett__ddiisskk__mmooddeell ((DDEEVVIICCEE))
-       Returns the model of the device. Output is "<device>: <model>" or
-       "N/A". eg. "/dev/sda: ST3250410AS"
-
-       "DEVICE" - Device identifier of SSD / Hard Drive
-
-           my $disk_model = $smart->get_disk_model('/dev/sda');
-
-AAUUTTHHOORR
-        Paul Trost <paul.trost@trostfamily.org>
-
-LLIICCEENNSSEE AANNDD CCOOPPYYRRIIGGHHTT
-        Copyright 2014.
-        This script is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License v2, or at your option any later version.
-        <http://gnu.org/licenses/gpl.html>
-
-
-
-perl v5.14.2                      2014-10-03                    Disk::SMART(3)

+ 0 - 56
t/boilerplate.t

@@ -1,56 +0,0 @@
-#!perl -T
-
-use 5.006;
-use strict;
-use warnings;
-use Test::More tests => 3;
-
-sub not_in_file_ok {
-    my ($filename, %regex) = @_;
-    open( my $fh, '<', $filename )
-        or die "couldn't open $filename for reading: $!";
-
-    my %violated;
-
-    while (my $line = <$fh>) {
-        while (my ($desc, $regex) = each %regex) {
-            if ($line =~ $regex) {
-                push @{$violated{$desc}||=[]}, $.;
-            }
-        }
-    }
-
-    if (%violated) {
-        fail("$filename contains boilerplate text");
-        diag "$_ appears on lines @{$violated{$_}}" for keys %violated;
-    } else {
-        pass("$filename contains no boilerplate text");
-    }
-}
-
-sub module_boilerplate_ok {
-    my ($module) = @_;
-    not_in_file_ok($module =>
-        'the great new $MODULENAME'   => qr/ - The great new /,
-        'boilerplate description'     => qr/Quick summary of what the module/,
-        'stub function definition'    => qr/function[12]/,
-    );
-}
-
-TODO: {
-  local $TODO = "Need to replace the boilerplate text";
-
-  not_in_file_ok(README =>
-    "The README is used..."       => qr/The README is used/,
-    "'version information here'"  => qr/to provide version information/,
-  );
-
-  not_in_file_ok(Changes =>
-    "placeholder date/time"       => qr(Date/time)
-  );
-
-  module_boilerplate_ok('lib/Disk/SMART.pm');
-
-
-}
-