mirror of
https://github.com/webmin/webmin.git
synced 2026-02-27 16:02:56 +00:00
109 lines
2.2 KiB
Perl
109 lines
2.2 KiB
Perl
#!/usr/local/bin/perl
|
|
# Convert Webmin function comments to POD format
|
|
|
|
# Parse command line
|
|
@ARGV || die "usage: webmin-to-pod.pl --svn 'comment' <file> ...";
|
|
while(@ARGV) {
|
|
$a = shift(@ARGV);
|
|
if ($a eq "--svn") {
|
|
$svn = shift(@ARGV);
|
|
$svn || die "--svn must be followed by a commit comment";
|
|
}
|
|
else {
|
|
push(@files, $a);
|
|
}
|
|
}
|
|
|
|
$tempdir = "/tmp/pod";
|
|
mkdir($tempdir, 0755);
|
|
|
|
foreach $f (@files) {
|
|
# Read in the file
|
|
if (!open(SRC, $f)) {
|
|
print STDERR "Failed to open $f : $!";
|
|
next;
|
|
}
|
|
chomp(@lines = <SRC>);
|
|
close(SRC);
|
|
|
|
# Scan line by line, looking for top-level subs with comments before
|
|
# them.
|
|
print "Processing $f :\n";
|
|
$i = 0;
|
|
@out = ( );
|
|
@cmts = ( );
|
|
$count = 0;
|
|
while($i<@lines) {
|
|
if ($lines[$i] =~ /^sub\s+(\S+)\s*$/) {
|
|
# Start of a function .. backtrack to get comments
|
|
$name = $1;
|
|
$args = undef;
|
|
if ($cmts[0] =~ /^\#+\s*(\Q$name\E)\s*(\((.*))/) {
|
|
# Found args in comments .. maybe multi-line
|
|
$args = $2;
|
|
shift(@cmts);
|
|
while($args !~ /\)\s*$/ && @cmts) {
|
|
$cont = $cmts[0];
|
|
shift(@cmts);
|
|
$cont =~ s/^\s*#+\s*//;
|
|
$args .= " ".$cont;
|
|
}
|
|
$args = undef if ($args =~ /^\(\s*\)$/);
|
|
}
|
|
if (@cmts || $args) {
|
|
push(@out, "=head2 $name$args");
|
|
push(@out, "");
|
|
if (!@cmts) {
|
|
@cmts = ( "MISSING DOCUMENTATION" );
|
|
}
|
|
foreach $c (@cmts) {
|
|
$c =~ s/^\s*#+\s*//;
|
|
push(@out, $c);
|
|
}
|
|
push(@out, "");
|
|
push(@out, "=cut");
|
|
}
|
|
push(@out, $lines[$i]);
|
|
@cmts = ( );
|
|
$count++;
|
|
}
|
|
elsif ($lines[$i] =~ /^\#/) {
|
|
# Comments - add to temporary list
|
|
push(@cmts, $lines[$i]);
|
|
}
|
|
else {
|
|
# Some other line - write out, and flush comments
|
|
push(@out, @cmts, $lines[$i]);
|
|
@cmts = ( );
|
|
}
|
|
$i++;
|
|
}
|
|
print " Fixed $count functions\n";
|
|
|
|
# Write out the file to a temp location
|
|
$basef = $f;
|
|
$basef =~ s/^.*\///;
|
|
$temp = "$tempdir/$basef";
|
|
print " Writing to $temp\n";
|
|
open(TEMP, ">$temp");
|
|
foreach $o (@out) {
|
|
print TEMP $o,"\n";
|
|
}
|
|
close(TEMP);
|
|
|
|
# Use perl -c to verify syntax
|
|
$err = `perl -c $temp 2>&1`;
|
|
if ($?) {
|
|
print " Perl verification FAILED\n";
|
|
next;
|
|
}
|
|
print " Perl verification OK\n";
|
|
|
|
# Show diff if asked
|
|
# XXX
|
|
|
|
# Copy over original file (with cat)
|
|
# XXX
|
|
}
|
|
|