FNF: fix comments.

remove FML::Merge::Utils, which is not used.

5 files changed, 151 insertions, 73 deletions

diff --git a/fml/lib/FML/Merge.pm b/fml/lib/FML/Merge.pm
index 98635e3e..28812702 100644
--- a/fml/lib/FML/Merge.pm
+++ b/fml/lib/FML/Merge.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: Merge.pm,v 1.6 2004/03/17 12:55:03 fukachan Exp $
+# $FML: Merge.pm,v 1.7 2004/03/17 14:20:47 fukachan Exp $
 #
 
 package FML::Merge;
@@ -12,9 +12,6 @@ use strict;
 use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
 use Carp;
 
-use FML::Merge::Utils;
-push(@INC, qw(FML::Merge::Utils));
-
 
 =head1 NAME
 
@@ -24,8 +21,9 @@ FML::Merge - merge other system configurations to fml8 ones.
 
 =head1 DESCRIPTION
 
-=cut
+=head2 new($curproc, $params)
 
+=cut
 
 
 # Descriptions: constructor.
@@ -36,7 +34,7 @@ sub new
 {
     my ($self, $curproc, $params) = @_;
     my ($type) = ref($self) || $self;
-    my $me     = { 
+    my $me     = {
 	_curproc => $curproc,
 	_params  => $params,
     };
@@ -67,6 +65,13 @@ sub new
 }
 
 
+=head2 set_target_system($system)
+
+specify target system.
+
+=cut
+
+
 # Descriptions: specify target system.
 #    Arguments: OBJ($self) STR($system)
 # Side Effects: none
@@ -81,6 +86,10 @@ sub set_target_system
 
 =head1 BACK UP CONFIGURATION FILES
 
+=head2 backup_old_config_files()
+
+back up old configuration files.
+
 =cut
 
 
@@ -162,9 +171,21 @@ For example, the value of NetBSD follows.
               that a mailer (e.g.) could not create a connection,
               and the request should be reattempted later.
 
+=head2 disable_old_include_files()
+
+rewrite include* files.
+
+=head2 enable_old_include_files()
+
+not yet implementd.
+
 =cut
 
 
+# Descriptions: rewrite include* files to disable them.
+#    Arguments: OBJ($self)
+# Side Effects: rewrite include* files.
+# Return Value: none
 sub disable_old_include_files
 {
     my ($self) = @_;
@@ -194,6 +215,10 @@ sub disable_old_include_files
 }
 
 
+# Descriptions: rewrite include* files (dummy).
+#    Arguments: OBJ($self)
+# Side Effects: rewrite include* files.
+# Return Value: none
 sub enable_old_include_files
 {
     my ($self) = @_;
@@ -210,11 +235,20 @@ sub enable_old_include_files
 }
 
 
-=head1
+=head1 CONVERT USER LIST FILES.
+
+=head2 convert_list_files()
+
+convert fml4 list files to fml8 style ones.
 
 =cut
 
 
+# Descriptions: convert fml4 list files to fml8 style ones.
+#    Arguments: OBJ($self)
+# Side Effects: old fml4 files moved to .fml4rc/,
+#               fml8 files created if needed.
+# Return Value: none
 sub convert_list_files
 {
     my ($self)  = @_;
@@ -227,11 +261,19 @@ sub convert_list_files
 }
 
 
-=head1
+=head1 MERGE
+
+=head2 merge_into_config_cf()
+
+merge fml4 config.ph into fm8 config.cf file.
 
 =cut
 
 
+# Descriptions: merge fml4 config.ph into fm8 config.cf file.
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: none
 sub merge_into_config_cf
 {
     my ($self)  = @_;
@@ -244,12 +286,16 @@ sub merge_into_config_cf
 
     use FML::Merge::FML4::config_ph;
     my $config_ph = new FML::Merge::FML4::config_ph;
-    $config_ph->set_default_config_ph("/tmp/default_config.ph"); 
+    $config_ph->set_default_config_ph("/tmp/default_config.ph");
     my $diff      = $config_ph->diff($old_config_ph);
     $self->_inject_into_config_cf($diff);
 }
 
 
+# Descriptions: inject config.ph summary to config.cf file.
+#    Arguments: OBJ($self) HASH_REF($diff)
+# Side Effects: rewrite config.cf.
+# Return Value: none
 sub _inject_into_config_cf
 {
     my ($self, $diff) = @_;
@@ -281,6 +327,10 @@ sub _inject_into_config_cf
 }
 
 
+# Descriptions: inject config.ph summary to config.cf file.
+#    Arguments: OBJ($self) HANDLE($wh) HASH_REF($diff)
+# Side Effects: rewrite config.cf.
+# Return Value: none
 sub _inject_diff_into_config_cf
 {
     my ($self, $wh, $diff) = @_;
@@ -310,6 +360,10 @@ sub _inject_diff_into_config_cf
 }
 
 
+# Descriptions: tune sort order: postpone PROC__* and *_HOOK variables.
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: NUM
 sub _sort_order
 {
     my $x = $a;
@@ -329,6 +383,10 @@ sub _sort_order
 =cut
 
 
+# Descriptions: return file path at the source dir.
+#    Arguments: OBJ($self) STR($file)
+# Side Effects: none
+# Return Value: STR
 sub old_file_path
 {
     my ($self, $file) = @_;
@@ -339,6 +397,10 @@ sub old_file_path
 }
 
 
+# Descriptions: return file path at $ml_home_dir.
+#    Arguments: OBJ($self) STR($file)
+# Side Effects: none
+# Return Value: STR
 sub new_file_path
 {
     my ($self, $file) = @_;
@@ -349,6 +411,10 @@ sub new_file_path
 }
 
 
+# Descriptions: return file path at backup-ed dir e.g. $ml_home_dir/.fml4rc.
+#    Arguments: OBJ($self) STR($file)
+# Side Effects: none
+# Return Value: STR
 sub backup_file_path
 {
     my ($self, $file) = @_;
diff --git a/fml/lib/FML/Merge/FML4/Config.pm b/fml/lib/FML/Merge/FML4/Config.pm
index ff70aefd..cceb5373 100644
--- a/fml/lib/FML/Merge/FML4/Config.pm
+++ b/fml/lib/FML/Merge/FML4/Config.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: Config.pm,v 1.2 2004/03/17 12:55:03 fukachan Exp $
+# $FML: Config.pm,v 1.3 2004/03/17 13:30:42 fukachan Exp $
 #
 
 package FML::Merge::FML4::Config;
@@ -265,6 +265,10 @@ sub get_continuous_use_files
 }
 
 
+# Descriptions: return backup mode.
+#    Arguments: OBJ($self) STR($file)
+# Side Effects: none
+# Return Value: STR
 sub backup_mode
 {
     my ($self, $file) = @_;
diff --git a/fml/lib/FML/Merge/FML4/List.pm b/fml/lib/FML/Merge/FML4/List.pm
index e0b311b3..23a39917 100644
--- a/fml/lib/FML/Merge/FML4/List.pm
+++ b/fml/lib/FML/Merge/FML4/List.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: List.pm,v 1.2 2004/03/17 04:08:35 fukachan Exp $
+# $FML: List.pm,v 1.3 2004/03/17 04:30:20 fukachan Exp $
 #
 
 package FML::Merge::FML4::List;
@@ -27,6 +27,10 @@ FML::Merge::FML4::List - convert member list files.
 =cut
 
 
+# Descriptions: constructor.
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params)
+# Side Effects: none
+# Return Value: OBJ
 sub new
 {
     my ($self, $curproc, $params) = @_;
@@ -40,6 +44,10 @@ sub new
 }
 
 
+# Descriptions: convert list files from fml4 to fml8 format.
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: none
 sub convert
 {
     my ($self)  = @_;
@@ -68,6 +76,10 @@ sub convert
 }
 
 
+# Descriptions: convert fml4 actives to fml8 recipients.
+#    Arguments: OBJ($self) OBJ($merge)
+# Side Effects: create fml8 file.
+# Return Value: none
 sub _convert_actives
 {
     my ($self, $merge) = @_;
@@ -78,6 +90,10 @@ sub _convert_actives
 } 
 
 
+# Descriptions: convert fml4 members to fml8 members.
+#    Arguments: OBJ($self) OBJ($merge)
+# Side Effects: create fml8 file.
+# Return Value: none
 sub _convert_members
 {
     my ($self, $merge) = @_;
@@ -88,6 +104,10 @@ sub _convert_members
 } 
 
 
+# Descriptions: convert fml4 members-admin to fml8 {recipients,members}-admin.
+#    Arguments: OBJ($self) OBJ($merge)
+# Side Effects: create fml8 file.
+# Return Value: none
 sub _convert_members_admin
 {
     my ($self, $merge) = @_;
@@ -101,6 +121,10 @@ sub _convert_members_admin
 } 
 
 
+# Descriptions: convert fml4 moderators to fml8 {recipients,members}-moderator.
+#    Arguments: OBJ($self) OBJ($merge)
+# Side Effects: create fml8 file.
+# Return Value: none
 sub _convert_moderators
 {
     my ($self, $merge) = @_;
@@ -114,6 +138,10 @@ sub _convert_moderators
 } 
 
 
+# Descriptions: convert fml4 etc/passwd to fml8 etc/passwd-admin.
+#    Arguments: OBJ($self) OBJ($merge)
+# Side Effects: create fml8 file.
+# Return Value: none
 sub _convert_etc_passwd
 {
     my ($self, $merge) = @_;
@@ -124,6 +152,10 @@ sub _convert_etc_passwd
 } 
 
 
+# Descriptions: filter output by removing comment line.
+#    Arguments: OBJ($self) STR($src) STR($dst)
+# Side Effects: create $dst file.
+# Return Value: none
 sub _write_without_comment
 {
     my ($self, $src, $dst) = @_;
diff --git a/fml/lib/FML/Merge/FML4/config_ph.pm b/fml/lib/FML/Merge/FML4/config_ph.pm
index fecf62cc..73041f2e 100644
--- a/fml/lib/FML/Merge/FML4/config_ph.pm
+++ b/fml/lib/FML/Merge/FML4/config_ph.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: config_ph.pm,v 1.3 2004/03/17 12:33:12 fukachan Exp $
+# $FML: config_ph.pm,v 1.4 2004/03/17 12:53:16 fukachan Exp $
 #
 
 package FML::Merge::FML4::config_ph;
@@ -29,6 +29,10 @@ FML::Merge::FML4::config_ph - handle fml4's config.ph file.
 =cut
 
 
+# Descriptions: constructor.
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: OBJ
 sub new
 {
     my ($self) = @_;
@@ -38,6 +42,10 @@ sub new
 }
 
 
+# Descriptions: set default_config.ph path.
+#    Arguments: OBJ($self) STR($file)
+# Side Effects: none
+# Return Value: STR
 sub set_default_config_ph
 {
     my ($self, $file) = @_;
@@ -46,6 +54,10 @@ sub set_default_config_ph
 }
 
 
+# Descriptions: diff config.ph and return it as HASH_REF.
+#    Arguments: OBJ($self) STR($file)
+# Side Effects: none
+# Return Value: HASH_REF
 sub diff
 {
     my ($self, $file) = @_;
@@ -64,6 +76,10 @@ sub diff
 }
 
 
+# Descriptions: load default_config.ph into "default" name space.
+#    Arguments: none
+# Side Effects: default name space filled up by default_config.ph content.
+# Return Value: none
 sub _load_default_config_ph
 {
     package default;
@@ -98,6 +114,10 @@ sub _load_default_config_ph
 }
 
 
+# Descriptions: generate string to evaluate to load config.ph.
+#    Arguments: OBJ($self) STR($f)
+# Side Effects: none
+# Return Value: STR
 sub _gen_eval_string
 {
     my ($self, $f) = @_;
@@ -122,6 +142,11 @@ sub _gen_eval_string
 }
 
 
+# Descriptions: generate diff config.ph against defualt_config.ph and
+#               save it at %result (global variabl).
+#    Arguments: STR($package) HASH_REF($stab)
+# Side Effects: none
+# Return Value: none
 sub var_dump
 {
     my ($package, $stab) = @_;
@@ -154,6 +179,10 @@ sub var_dump
 }
 
 
+# Descriptions: generate macro definitions used in fml4 config.
+#    Arguments: none
+# Side Effects: none
+# Return Value: STR
 sub gen_dummy_macros
 {
     my $s = '';
@@ -276,9 +305,17 @@ sub gen_dummy_macros
 
 =head1 TRANSLATION FROM 4 TO 8 
 
+=head2 translate($key, $value)
+
+translate fml4 config {$key => $value } to fml8 one if could.
+
 =cut
 
 
+# Descriptions: translate fml4 config {$key => $value } to fml8 one if could.
+#    Arguments: OBJ($self) STR($key) STR($value)
+# Side Effects: none
+# Return Value: STR
 sub translate
 {
     my ($self, $key, $value) = @_;
diff --git a/fml/lib/FML/Merge/Utils.pm b/fml/lib/FML/Merge/Utils.pm
deleted file mode 100644
index 4c887a43..00000000
--- a/fml/lib/FML/Merge/Utils.pm
+++ /dev/null
@@ -1,61 +0,0 @@
-#-*- perl -*-
-#
-#  Copyright (C) 2004 Ken'ichi Fukamachi
-#   All rights reserved. This program is free software; you can
-#   redistribute it and/or modify it under the same terms as Perl itself.
-#
-# $FML: @template.pm,v 1.8 2004/01/01 07:29:27 fukachan Exp $
-#
-
-package FML::Merge::Utils;
-use strict;
-use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
-use Carp;
-
-=head1 NAME
-
-FML::Merge::Utils - what is this
-
-=head1 SYNOPSIS
-
-=head1 DESCRIPTION
-
-=head1 METHODS
-
-=head2 C<new()>
-
-=cut
-
-sub new
-{
-    my ($self) = @_;
-    my ($type) = ref($self) || $self;
-    my $me     = {};
-    return bless $me, $type;
-}
-
-
-=head1 CODING STYLE
-
-See C<http://www.fml.org/software/FNF/> on fml coding style guide.
-
-=head1 AUTHOR
-
-Ken'ichi Fukamachi
-
-=head1 COPYRIGHT
-
-Copyright (C) 2004 Ken'ichi Fukamachi
-
-All rights reserved. This program is free software; you can
-redistribute it and/or modify it under the same terms as Perl itself.
-
-=head1 HISTORY
-
-FML::Merge::Utils appeared in fml8 mailing list driver package.
-See C<http://www.fml.org/> for more details.
-
-=cut
-
-
-1;