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

Change plain text table man page references to hyperlinks and support links to definitions too

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@7727 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
bp-sawyers 2010-09-29 18:33:32 +00:00
parent 8f19be2f03
commit 51ee90563e
8 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -47,7 +47,7 @@ Print version.
=head1 B<Files>
B<nodehm> table -
xCAT node hardware management table. See B<nodehm(5)> for
xCAT node hardware management table. See L<nodehm(5)|nodehm.5> for
further details. This is used to determine the console access
method.

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

@ -13,7 +13,7 @@ B<rmigrate> requests that a guest VM be moved from the current entity hosting it
=head1 B<Files>
B<vm> table -
Table governing VM paramaters. See B<vm(5)> for further details.
Table governing VM paramaters. See L<vm(5)|vm.5> for further details.
This is used to determine the current host to migrate from.
=head1 B<Examples>

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

@ -45,4 +45,4 @@ Reset the service processor that controls node5:
=head1 B<SEE ALSO>
L<rpower(1)|rpower.1>, nodehm(5)
L<rpower(1)|rpower.1>, L<nodehm(5)|nodehm.5>

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

@ -48,7 +48,7 @@ specified).
=head1 B<Files>
B<nodehm> table -
xCAT node hardware management table. See B<nodehm(5)> for further details. This is used to determine the console access
xCAT node hardware management table. See L<nodehm(5)|nodehm.5> for further details. This is used to determine the console access
method.
=head1 B<Examples>

2
xCAT-client/pods/man8/copycds.8.pod
View File

@ -61,4 +61,4 @@ B<copycds -n rhels5.3 -a x86_64 dvd.iso>
=head1 SEE ALSO
L<nodeset(8)|nodeset.8>, site(5), nodetype(5)
L<nodeset(8)|nodeset.8>, L<site(5)|site.5>, L<nodetype(5)|nodetype.5>

2
xCAT-client/pods/man8/makehosts.8.pod
View File

@ -56,4 +56,4 @@ IP addresses of 1.2.3.1, 1.2.3.2, etc.
=head1 SEE ALSO
hosts(5), L<makedns(8)|makedns.8>
L<hosts(5)|hosts.5>, L<makedns(8)|makedns.8>

12
xCAT-client/pods/man8/nodeset.8.pod
View File

@ -19,7 +19,7 @@ take next.
B<nodeset> will maniputale the boot configuration files of yaboot and pxelinux.0.
Assume that /tftpboot is the root for tftpd (set in B<site(5)>).
Assume that /tftpboot is the root for tftpd (set in L<site(5)|site.5>).
B<nodeset> for pxe makes changes to /tftpboot/pxelinux.cfg/{node hex ip}
@ -87,16 +87,16 @@ Print version.
=head1 B<Files>
B<noderes> table -
xCAT node resources file. See B<noderes(5)> for further
xCAT node resources file. See L<noderes(5)|noderes.5> for further
details.
B<nodetype> table -
xCAT node installation type file. See B<nodetype(5)> for fur-
xCAT node installation type file. See L<nodetype(5)|nodetype.5> for fur-
ther details. This is used to determine the node installation
image type.
B<site> table -
xCAT main configuration file. See B<site(5)> for further
xCAT main configuration file. See L<site(5)|site.5> for further
details. This is used to determine the location of the TFTP
root directory and the TFTP xCAT subdirectory. /tftpboot and
/tftpboot/xcat is the default.
@ -113,5 +113,5 @@ resource group.
=head1 B<See> B<Also>
L<noderange(3)|noderange.3>, L<nodels(1)|nodels.1>, L<nodestat(1)|nodestat.1>, L<rinstall(8)|rinstall.8>,
L<makedhcp(8)|makedhcp.8>
L<noderange(3)|noderange.3>, L<nodels(1)|nodels.1>, L<nodestat(1)|nodestat.1>, L<rinstall(8)|rinstall.8>,
L<makedhcp(8)|makedhcp.8>, L<osimage(7)|osimage.7>

23
xCAT-client/xpod2man
View File

@ -58,6 +58,7 @@ foreach my $podfile (@pods) {
# Remove the dummy pods
unlink @dummyPods;
rmdir "$poddir/man7";
exit;
@ -68,7 +69,7 @@ exit;
# 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;
my $cmd = "grep -r -E 'L<.+\\([57]\\)\\|.+\\.[57]>' " . $poddir;
#print "Running cmd: ", $cmd, "\n";
my @lines = `$cmd`;
if ($?) { print "Error running: $cmd\n"; print join('', @lines); }
@ -77,11 +78,16 @@ sub createDummyPods {
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";
my @matches = $l =~ /L<([^\(]+)\(([57])\)\|\1\.[57]>/g; # get all the matches in the line
# The above line should create the array with every other entry being the man page name
# and every other entry is the section # (5 or 7)
my $cmd;
while ($cmd=shift @matches) {
#foreach my $m (@matches) {
my $section = shift @matches;
my $filename = "$poddir/man$section/$cmd.$section.pod";
#print "$filename\n";
if (!(grep /^$filename$/, @$pods)) { push @dummyPods, $filename; }
if (!(grep /^$filename$/, @$pods) && !(grep /^$filename$/, @dummyPods)) { push @dummyPods, $filename; }
}
}
@ -90,8 +96,9 @@ sub createDummyPods {
# Create these empty files
print "Creating empty linked-to files: ", join(', ', @dummyPods), "\n";
mkdir "$poddir/man7";
foreach my $d (@dummyPods) {
if (!open(TMP, ">>$d")) { warn "Could not creaate dummy pod file $d ($!)\n"; }
if (!open(TMP, ">>$d")) { warn "Could not create dummy pod file $d ($!)\n"; }
else { close TMP; }
}
@ -142,7 +149,7 @@ OS diskful/diskfree deployment.
=head1 XCAT DATABASE
All of the cluster configuration information is in the xCAT database. See B<xcatdb(5)> for
All of the cluster configuration information is in the xCAT database. See L<xcatdb(5)|xcatdb.5> for
descriptions of every table in the database.
=head1 XCAT COMMANDS
@ -190,7 +197,7 @@ sub convertpod2html {
#TODO: use --css=<stylesheet> and --title=<pagetitle> to make the pages look better
pod2html($podfile,
"--outfile=$htmlfile",
"--podpath=man1:man3:man5:man8",
"--podpath=man1:man3:man5:man7:man8",
"--podroot=$poddir",
"--htmldir=$htmldir",
"--recurse",