arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Make html man page references to xcattest and db tables work

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@7718 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
bp-sawyers 2010-09-29 13:39:25 +00:00
parent f4a1daf346
commit ae0ab6be52
3 changed files with 45 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
xCAT-client/pods/man1/clonevm.1.pod
View File

@ -63,7 +63,7 @@ I<clonevm vm1-vm30 -b appserver>
=head1 SEE ALSO
L<chvm(1)|chvm.1>, L<lsvm(1)|lsvm.1>, L<rmvm(1)|rmvm.1>, L<mkvm(1)|mkvm.1>, vmmaster(5)
L<chvm(1)|chvm.1>, L<lsvm(1)|lsvm.1>, L<rmvm(1)|rmvm.1>, L<mkvm(1)|mkvm.1>, L<vmmaster(5)|vmmaster.5>

49
xCAT-client/xpod2man
View File

@ -38,12 +38,7 @@ foreach my $podfile (@pods) {
convertpod2man($podfile, $manfile, $section);
}
#TODO: to enable linking between the cmd man pages and the db man pages, need to:
# grep thru the cmd pods searching for references (L<>) to any section 5 man page
# if that pod does not exist, create a minimal one that will satisfy pod2html
# keep track of all dummy pods created
# convert all original pod pages
# remove the dummy pods
my @dummyPods = createDummyPods($poddir, \@pods);
# Build the html page for each pod.
#mkdir($htmldir) or die "Error: could not create $htmldir.\n";
@ -61,9 +56,48 @@ foreach my $podfile (@pods) {
convertpod2html($podfile, $htmlfile, $poddir, $htmldir);
}
# Remove the dummy pods
unlink @dummyPods;
exit;
# To enable linking between the cmd man pages and the db man pages, need to:
# grep thru the cmd pods searching for references (L<>) to any section 5 man page
# if that pod does not exist, create an empty one that will satisfy pod2html
# keep track of all dummy pods created, so they can be removed later
sub createDummyPods {
my ($poddir, $pods) = @_;
my $cmd = "grep -r -E 'L<.+\\(5\\)\\|.+\\.5>' " . $poddir;
#print "Running cmd: ", $cmd, "\n";
my @lines = `$cmd`;
if ($?) { print "Error running: $cmd\n"; print join('', @lines); }
#my @lines;
#system($cmd);
my @dummyPods;
foreach my $l (@lines) {
#print "$l\n";
my @matches = $l =~ /L<([^\(]+)\(5\)\|\1\.5>/g; # get all the matches in the line
foreach my $m (@matches) {
my $filename = "$poddir/man5/$m.5.pod";
#print "$filename\n";
if (!(grep /^$filename$/, @$pods)) { push @dummyPods, $filename; }
}
}
# Also add xcattest.1.pod, because the xcat.1.pod summary page refers to it
push @dummyPods, "$poddir/man1/xcattest.1.pod";
# Create these empty files
print "Creating empty linked-to files: ", join(', ', @dummyPods), "\n";
foreach my $d (@dummyPods) {
if (!open(TMP, ">>$d")) { warn "Could not creaate dummy pod file $d ($!)\n"; }
else { close TMP; }
}
return @dummyPods;
}
# Recursively get the list of pod man page files.
sub getPodList {
my $poddir = shift;
@ -137,6 +171,9 @@ foreach my $manpage (@_) {
print FILE "\n=item L<$cmd($sectionnum)|$cmd.$sectionnum>\n\n".$description."\n";
}
# Artificially add the xcattest cmd, because the xCAT-test rpm will add this
print FILE "\n=item L<xcattest(1)|xcattest.1>\n\nRun automated xCAT test cases.\n";
print FILE <<"EOS3";
=back

2
xCAT-test/pods/man1/xcattest.1.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<xcattest> - Run xCAT test cases.
B<xcattest> - Run automated xCAT test cases.
=head1 SYNOPSIS