diff --git a/docs/source/index.rst b/docs/source/index.rst index 8029b7c8b..048b7095d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ -Extreme Cluster/Cloud Administration Toolkit -============================================ +Extreme Cloud Administration Toolkit +==================================== -xCAT stands for E\ **x**\ treme **C**\ loud/\ **C**\ luster **A**\ dministration **T**\ oolkit. +xCAT stands for E\ **x**\ treme **C**\ loud **A**\ dministration **T**\ oolkit. xCAT offers complete management of clouds, clusters, HPC, grids, datacenters, renderfarms, online gaming infrastructure, and whatever tomorrows next buzzword may be. diff --git a/perl-xCAT/README b/perl-xCAT/README index 9db70042f..04b56cd36 100644 --- a/perl-xCAT/README +++ b/perl-xCAT/README @@ -1,5 +1,3 @@ -xCAT - Extreme Cluster/Cloud Administration Toolkit - xCAT is a toolkit for the deployment and administration of clusters. xCAT documentation is available at: http://xcat-docs.readthedocs.org/ diff --git a/xCAT-OpenStack-baremetal/xpod2man b/xCAT-OpenStack-baremetal/xpod2man index 4b04c3809..ea8aea2c6 100755 --- a/xCAT-OpenStack-baremetal/xpod2man +++ b/xCAT-OpenStack-baremetal/xpod2man @@ -22,9 +22,6 @@ my @pods = getPodList($poddir); #foreach (@pods) { print "$_\n"; } exit; -# Build the cmd overview page. -#writesummarypage("$poddir/man1/xcat.1.pod", @pods); - # Build the man page for each pod. #mkdir($mandir) or die "Error: could not create $mandir.\n"; print "Converting PODs to man pages...\n"; @@ -134,71 +131,6 @@ sub getPodList { } -# Create the xcat man page that gives a summary description of each xcat cmd. -# Not used -sub writesummarypage { - my $file = shift; # relative path file name of the man page - # the rest of @_ contains the pod files that describe each cmd - - open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; - - print FILE <<'EOS1'; -=head1 NAME - -B - Extreme Cluster/Cloud Administration Toolkit. - -=head1 DESCRIPTION - -Extreme Cluster/Cloud Administration Toolkit (xCAT). xCAT is a scalable distributed computing management -and provisioning tool that provides a unified interface for hardware control, discovery, and -OS diskful/diskfree deployment. - - -=head1 XCAT DATABASE - -All of the cluster configuration information is in the xCAT database. See L for -descriptions of every table in the database. - -=head1 XCAT COMMANDS - -What follows is a short description of each xCAT command. To get more information about a particular -command, see its man page. Note that the commands are listed in alphabetical order B, -i.e. all the commands in section 1, then the commands in section 3, etc. - -=over 12 -EOS1 - - # extract the summary for each cmd from its man page - foreach my $manpage (@_) { - my ($sectionnum) = $manpage =~ /\.(\d+)\.pod$/; - - # Suck in the whole file, then we will parse it. - open(MANPAGE, "$manpage") or die "Error: could not open $manpage for reading.\n"; - my @contents = ; - my $wholemanpage = join('', @contents); - close(MANPAGE); - - # This regex matches: optional space, =head1, space, title, space, cmd, space, description, newline - my ($cmd, $description) = $wholemanpage =~ /^\s*=head1\s+\S+\s+(\S+)\s+(.+?)\n/si; - if (!defined($cmd)) { print "Warning: $manpage is not in a recognized structure. It will be ignored.\n"; next; } - if (!defined($description)) { print "Warning: $manpage does not have a description for $cmd. It will be ignored.\n"; next; } - $cmd =~ s/^.<(.+)>$/$1/; # if the cmd name has pod formatting around it, strip it off - $description =~ s/^-\s*//; # if the description has a leading hypen, strip it off - 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\n\nRun automated xCAT test cases.\n"; - - print FILE <<"EOS3"; - -=back -EOS3 - - close FILE; -} - - # Create the html page for one pod. sub convertpod2html { my ($podfile, $htmlfile, $poddir, $htmldir) = @_; diff --git a/xCAT-SoftLayer/xpod2man b/xCAT-SoftLayer/xpod2man index ae0d34adb..6d3da3475 100755 --- a/xCAT-SoftLayer/xpod2man +++ b/xCAT-SoftLayer/xpod2man @@ -23,9 +23,6 @@ my @pods = getPodList($poddir); #foreach (@pods) { print "$_\n"; } exit; -# Build the cmd overview page. -#writesummarypage("$poddir/man1/xcat.1.pod", @pods); - # Build the man page for each pod. #mkdir($mandir) or die "Error: could not create $mandir.\n"; print "Converting PODs to man pages...\n"; @@ -134,72 +131,6 @@ sub getPodList { return sort @files; } - -# Create the xcat man page that gives a summary description of each xcat cmd. -# Not used. -sub writesummarypage { - my $file = shift; # relative path file name of the man page - # the rest of @_ contains the pod files that describe each cmd - - open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; - - print FILE <<'EOS1'; -=head1 NAME - -B - Extreme Cluster/Cloud Administration Toolkit. - -=head1 DESCRIPTION - -Extreme Cluster/Cloud Administration Toolkit (xCAT). xCAT is a scalable distributed computing management -and provisioning tool that provides a unified interface for hardware control, discovery, and -OS diskful/diskfree deployment. - - -=head1 XCAT DATABASE - -All of the cluster configuration information is in the xCAT database. See L for -descriptions of every table in the database. - -=head1 XCAT COMMANDS - -What follows is a short description of each xCAT command. To get more information about a particular -command, see its man page. Note that the commands are listed in alphabetical order B, -i.e. all the commands in section 1, then the commands in section 3, etc. - -=over 12 -EOS1 - - # extract the summary for each cmd from its man page - foreach my $manpage (@_) { - my ($sectionnum) = $manpage =~ /\.(\d+)\.pod$/; - - # Suck in the whole file, then we will parse it. - open(MANPAGE, "$manpage") or die "Error: could not open $manpage for reading.\n"; - my @contents = ; - my $wholemanpage = join('', @contents); - close(MANPAGE); - - # This regex matches: optional space, =head1, space, title, space, cmd, space, description, newline - my ($cmd, $description) = $wholemanpage =~ /^\s*=head1\s+\S+\s+(\S+)\s+(.+?)\n/si; - if (!defined($cmd)) { print "Warning: $manpage is not in a recognized structure. It will be ignored.\n"; next; } - if (!defined($description)) { print "Warning: $manpage does not have a description for $cmd. It will be ignored.\n"; next; } - $cmd =~ s/^.<(.+)>$/$1/; # if the cmd name has pod formatting around it, strip it off - $description =~ s/^-\s*//; # if the description has a leading hypen, strip it off - 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\n\nRun automated xCAT test cases.\n"; - - print FILE <<"EOS3"; - -=back -EOS3 - - close FILE; -} - - # Create the html page for one pod. sub convertpod2html { my ($podfile, $htmlfile, $poddir, $htmldir) = @_; diff --git a/xCAT-UI/debian/control b/xCAT-UI/debian/control index a0fba1d3f..d0020859d 100644 --- a/xCAT-UI/debian/control +++ b/xCAT-UI/debian/control @@ -9,4 +9,4 @@ Package: xcat-ui Architecture: all Depends: ${perl:Depends}, python (>= 2.3), apache2, libapache2-mod-php Description: Provides a browser-based interface for xCAT - Provides a browser-based interface for xCAT (Extreme Cluster/Cloud Administration Toolkit). + Provides a browser-based interface for xCAT. diff --git a/xCAT-UI/lib/ui.php b/xCAT-UI/lib/ui.php index 1df070c3f..f7f96f3a1 100644 --- a/xCAT-UI/lib/ui.php +++ b/xCAT-UI/lib/ui.php @@ -72,7 +72,7 @@ function login() {
- + diff --git a/xCAT-UI/service.php b/xCAT-UI/service.php index f2f65b984..ed9cc89bd 100644 --- a/xCAT-UI/service.php +++ b/xCAT-UI/service.php @@ -57,7 +57,7 @@ if (!isAuthenticated()) {
Extreme Cluster/Cloud Administration Toolkit
xCAT
- + diff --git a/xCAT-UI/xCAT-UI.spec b/xCAT-UI/xCAT-UI.spec index b2d63a1ce..a39fb564c 100644 --- a/xCAT-UI/xCAT-UI.spec +++ b/xCAT-UI/xCAT-UI.spec @@ -31,7 +31,7 @@ Requires: httpd %endif %description -Provides a browser-based interface for xCAT (Extreme Cluster/Cloud Administration Toolkit). +Provides a browser-based interface for xCAT. %prep %setup -q -n xCAT-UI diff --git a/xCAT-client/xpod2man b/xCAT-client/xpod2man index e9b15db46..2a8508142 100755 --- a/xCAT-client/xpod2man +++ b/xCAT-client/xpod2man @@ -149,11 +149,11 @@ sub writesummarypage { print FILE <<'EOS1'; =head1 NAME -B - Extreme Cluster/Cloud Administration Toolkit. +B - Extreme Cloud Administration Toolkit. =head1 DESCRIPTION -Extreme Cluster/Cloud Administration Toolkit (xCAT). xCAT is a scalable distributed computing management +Extreme Cloud Administration Toolkit (xCAT). xCAT is a scalable distributed computing management and provisioning tool that provides a unified interface for hardware control, discovery, and OS diskful/diskfree deployment. diff --git a/xCAT-confluent/xpod2man b/xCAT-confluent/xpod2man index 01c421784..1af6dd370 100755 --- a/xCAT-confluent/xpod2man +++ b/xCAT-confluent/xpod2man @@ -22,9 +22,6 @@ my @pods = getPodList($poddir); #foreach (@pods) { print "$_\n"; } exit; -# Build the cmd overview page. -#writesummarypage("$poddir/man1/xcat.1.pod", @pods); - # Build the man page for each pod. #mkdir($mandir) or die "Error: could not create $mandir.\n"; print "Converting PODs to man pages...\n"; @@ -133,71 +130,6 @@ sub getPodList { return sort @files; } - -# Create the xcat man page that gives a summary description of each xcat cmd. -sub writesummarypage { - my $file = shift; # relative path file name of the man page - # the rest of @_ contains the pod files that describe each cmd - - open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; - - print FILE <<'EOS1'; -=head1 NAME - -B - Extreme Cluster/Cloud Administration Toolkit. - -=head1 DESCRIPTION - -Extreme Cluster/Cloud Administration Toolkit (xCAT). xCAT is a scalable distributed computing management -and provisioning tool that provides a unified interface for hardware control, discovery, and -OS diskful/diskfree deployment. - - -=head1 XCAT DATABASE - -All of the cluster configuration information is in the xCAT database. See L for -descriptions of every table in the database. - -=head1 XCAT COMMANDS - -What follows is a short description of each xCAT command. To get more information about a particular -command, see its man page. Note that the commands are listed in alphabetical order B, -i.e. all the commands in section 1, then the commands in section 3, etc. - -=over 12 -EOS1 - - # extract the summary for each cmd from its man page - foreach my $manpage (@_) { - my ($sectionnum) = $manpage =~ /\.(\d+)\.pod$/; - - # Suck in the whole file, then we will parse it. - open(MANPAGE, "$manpage") or die "Error: could not open $manpage for reading.\n"; - my @contents = ; - my $wholemanpage = join('', @contents); - close(MANPAGE); - - # This regex matches: optional space, =head1, space, title, space, cmd, space, description, newline - my ($cmd, $description) = $wholemanpage =~ /^\s*=head1\s+\S+\s+(\S+)\s+(.+?)\n/si; - if (!defined($cmd)) { print "Warning: $manpage is not in a recognized structure. It will be ignored.\n"; next; } - if (!defined($description)) { print "Warning: $manpage does not have a description for $cmd. It will be ignored.\n"; next; } - $cmd =~ s/^.<(.+)>$/$1/; # if the cmd name has pod formatting around it, strip it off - $description =~ s/^-\s*//; # if the description has a leading hypen, strip it off - 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\n\nRun automated xCAT test cases.\n"; - - print FILE <<"EOS3"; - -=back -EOS3 - - close FILE; -} - - # Create the html page for one pod. sub convertpod2html { my ($podfile, $htmlfile, $poddir, $htmldir) = @_; diff --git a/xCAT-server/share/xcat/tools/go-xcat b/xCAT-server/share/xcat/tools/go-xcat index ac576207f..1f6c7ca98 100755 --- a/xCAT-server/share/xcat/tools/go-xcat +++ b/xCAT-server/share/xcat/tools/go-xcat @@ -63,7 +63,7 @@ function usage() ${script} --xcat-core=http://xcat.org/path/to/xcat-core.tar.bz2 \\ --xcat-dep=http://xcat.org/path/to/xcat-dep.tar.bz2 install - xCAT (Extreme Cluster/Cloud Administration Toolkit): + xCAT: Full documentation at: EOF } diff --git a/xCAT-vlan/xpod2man b/xCAT-vlan/xpod2man index 1c08d8943..6d3da3475 100755 --- a/xCAT-vlan/xpod2man +++ b/xCAT-vlan/xpod2man @@ -23,9 +23,6 @@ my @pods = getPodList($poddir); #foreach (@pods) { print "$_\n"; } exit; -# Build the cmd overview page. -#writesummarypage("$poddir/man1/xcat.1.pod", @pods); - # Build the man page for each pod. #mkdir($mandir) or die "Error: could not create $mandir.\n"; print "Converting PODs to man pages...\n"; @@ -134,71 +131,6 @@ sub getPodList { return sort @files; } - -# Create the xcat man page that gives a summary description of each xcat cmd. -sub writesummarypage { - my $file = shift; # relative path file name of the man page - # the rest of @_ contains the pod files that describe each cmd - - open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; - - print FILE <<'EOS1'; -=head1 NAME - -B - Extreme Cluster/Cloud Administration Toolkit. - -=head1 DESCRIPTION - -Extreme Cluster/Cloud Administration Toolkit (xCAT). xCAT is a scalable distributed computing management -and provisioning tool that provides a unified interface for hardware control, discovery, and -OS diskful/diskfree deployment. - - -=head1 XCAT DATABASE - -All of the cluster configuration information is in the xCAT database. See L for -descriptions of every table in the database. - -=head1 XCAT COMMANDS - -What follows is a short description of each xCAT command. To get more information about a particular -command, see its man page. Note that the commands are listed in alphabetical order B, -i.e. all the commands in section 1, then the commands in section 3, etc. - -=over 12 -EOS1 - - # extract the summary for each cmd from its man page - foreach my $manpage (@_) { - my ($sectionnum) = $manpage =~ /\.(\d+)\.pod$/; - - # Suck in the whole file, then we will parse it. - open(MANPAGE, "$manpage") or die "Error: could not open $manpage for reading.\n"; - my @contents = ; - my $wholemanpage = join('', @contents); - close(MANPAGE); - - # This regex matches: optional space, =head1, space, title, space, cmd, space, description, newline - my ($cmd, $description) = $wholemanpage =~ /^\s*=head1\s+\S+\s+(\S+)\s+(.+?)\n/si; - if (!defined($cmd)) { print "Warning: $manpage is not in a recognized structure. It will be ignored.\n"; next; } - if (!defined($description)) { print "Warning: $manpage does not have a description for $cmd. It will be ignored.\n"; next; } - $cmd =~ s/^.<(.+)>$/$1/; # if the cmd name has pod formatting around it, strip it off - $description =~ s/^-\s*//; # if the description has a leading hypen, strip it off - 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\n\nRun automated xCAT test cases.\n"; - - print FILE <<"EOS3"; - -=back -EOS3 - - close FILE; -} - - # Create the html page for one pod. sub convertpod2html { my ($podfile, $htmlfile, $poddir, $htmldir) = @_;
Extreme Cluster/Cloud Administration Toolkit
xCAT