summaryrefslogtreecommitdiff
path: root/fml/lib/File/Rotate.pm
diff options
context:
space:
mode:
authorfukachan <fukachan>2001-02-24 13:30:34 +0000
committerfukachan <fukachan>2001-02-24 13:30:34 +0000
commit0b3515d47ca3e6ed0b420d045fa244ab5781858f (patch)
tree14bf02793667f169ebc3a982b41f6ad62342f645 /fml/lib/File/Rotate.pm
parent6ad24bdb38d5892b5d37b3e171d6cf009873bc84 (diff)
downloadfml8-0b3515d47ca3e6ed0b420d045fa244ab5781858f.tar.gz
fml8-0b3515d47ca3e6ed0b420d045fa244ab5781858f.tar.bz2
fml8-0b3515d47ca3e6ed0b420d045fa244ab5781858f.zip
clean up documents on File::
Diffstat (limited to 'fml/lib/File/Rotate.pm')
-rw-r--r--fml/lib/File/Rotate.pm16
1 files changed, 16 insertions, 0 deletions
diff --git a/fml/lib/File/Rotate.pm b/fml/lib/File/Rotate.pm
index 6d5ef440..4c146414 100644
--- a/fml/lib/File/Rotate.pm
+++ b/fml/lib/File/Rotate.pm
@@ -65,6 +65,10 @@ sub new
}
+# Descriptions: determine the time to rotate comes
+# Arguments: $self
+# Side Effects: none
+# Return Value: 1 (time comes!) or 0
sub is_time_to_rotate
{
my ($self) = @_;
@@ -78,6 +82,12 @@ sub is_time_to_rotate
}
+
+# Descriptions: rotate filenames
+# Arguments: $self
+# Side Effects: filename rotations
+# unlink the oldest file
+# Return Value: none
sub rotate
{
my ($self) = @_;
@@ -98,6 +108,10 @@ sub rotate
}
+# Descriptions: extract parameters in $self
+# Arguments: $self
+# Side Effects: none
+# Return Value: a set of (file, max_size, num_backlog)
sub _get_param
{
my ($self) = @_;
@@ -122,6 +136,7 @@ sub error
Ken'ichi Fukamachi
+
=head1 COPYRIGHT
Copyright (C) 2001 Ken'ichi Fukamachi
@@ -136,4 +151,5 @@ See C<http://www.fml.org/> for more details.
=cut
+
1;