Merge pull request #7217 from gurevichmark/mkvm_manpage

Fix mkvm man page formatting
xcat2 · Jul 14, 2022 · 522b767 · 522b767
2 parents ecb0232 + 071c6f1
commit 522b767
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 28 deletions.
diff --git a/docs/source/guides/admin-guides/references/man1/mkvm.1.rst b/docs/source/guides/admin-guides/references/man1/mkvm.1.rst
@@ -81,7 +81,7 @@ For PPC (with HMC) specific:
 ============================
 
 
-The first form of \ **mkvm**\  command creates new partition(s) with the same profile/resources as the partition specified by \ *singlenode*\ . The -i and \ *noderange*\  specify the starting numeric partition number and the \ *noderange*\  for the newly created partitions, respectively. The LHEA port numbers and the HCA index numbers will be automatically increased if they are defined in the source partition.
+The first form of \ **mkvm**\  command creates new partition(s) with the same profile/resources as the partition specified by \ *singlenode*\ . The \ **-i**\  and \ *noderange*\  specify the starting numeric partition number and the \ *noderange*\  for the newly created partitions, respectively. The LHEA port numbers and the HCA index numbers will be automatically increased if they are defined in the source partition.
 
 The second form of this command duplicates all the partitions from the source specified by \ *profile*\  to the destination specified by \ *destcec*\ . The source and destination CECs can be managed by different HMCs.
 
@@ -94,9 +94,9 @@ For PPC (using Direct FSP Management) specific:
 ===============================================
 
 
-With option \ *full*\ , a partition using all the resources on a normal power machine will be created.
+With option \ **-**\ **-full**\ , a partition using all the resources on a normal power machine will be created.
 
-If no option is specified, a partition using the parameters specified with attributes such as 'vmcpus', 'vmmemory', 'vmphyslots', 'vmothersetting', 'vmnics', 'vmstorage' will be created. Those attributes can either be specified with '\*def' commands running before or be specified with this command.
+If no option is specified, a partition using the parameters specified with attributes such as \ **vmcpus**\ , \ **vmmemory**\ , \ **vmphyslots**\ , \ **vmothersetting**\ , \ **vmnics**\ , \ **vmstorage**\  will be created. Those attributes can either be specified with '\*def' commands running before or be specified with this command.
 
 
 For KVM and VMware:
@@ -148,9 +148,9 @@ OPTIONS
 
 \ **vmcpus=**\  \ *value*\  \ **vmmemory=**\  \ *value*\  \ **vmphyslots=**\  \ *value*\  \ **vmothersetting=**\  \ *value*\  \ **vmnics=**\  \ *value*\  \ **vmstorage=**\  \ *value*\  [\ **-**\ **-vios**\ ]
 
- To specify the parameters which are used to create a partition. The \ *vmcpus*\ , \ *vmmemory*\  are necessary, and the value specified with this command have a more high priority. If the value of any of the three options is not specified, the corresponding value specified for the node object will be used. If any of the three attributes is neither specified with this command nor specified with the node object, error information will be returned. To reference to lsvm(1)|lsvm.1 for more information about 'drc_index' for \ *vmphyslots*\ .
+ To specify the parameters which are used to create a partition. The \ **vmcpus**\ , \ **vmmemory**\  are necessary, and the value specified with this command have a more high priority. If the value of any of the three options is not specified, the corresponding value specified for the node object will be used. If any of the three attributes is neither specified with this command nor specified with the node object, error information will be returned. To reference to lsvm(1)|lsvm.1 for more information about 'drc_index' for \ *vmphyslots*\ .
 
- The option \ *vios*\  is used to specify the partition that will be created is a VIOS partition. If specified, the value for \ *vmstorage*\  shall be number which indicate the number of vSCSI server adapter will be created, and if no value specified for \ *vmphyslots*\ , all the physical slot of the power machine will be assigned to VIOS partition. If not specified, it shall be in form of \ *vios_name:server_slotid*\  to specify the vios and the virtual slot id of the vSCSI server adapter that will be connected from the Logical partition.
+ The option \ **vios**\  is used to specify the partition that will be created is a VIOS partition. If specified, the value for \ **vmstorage**\  shall be number which indicate the number of vSCSI server adapter will be created, and if no value specified for \ **vmphyslots**\ , all the physical slot of the power machine will be assigned to VIOS partition. If not specified, it shall be in form of \ **vios_name:server_slotid**\  to specify the vios and the virtual slot id of the vSCSI server adapter that will be connected from the Logical partition.
 
 
 

diff --git a/github_action_xcat_test.pl b/github_action_xcat_test.pl
@@ -342,14 +342,13 @@ sub install_xcat{
         print "[install_xcat] $cmd ....[Pass]\n";
 
         print "\n------Config xcat and verify xcat is working correctly-----\n";
-        @cmds = ("sudo -s /opt/xcat/share/xcat/scripts/setup-local-client.sh -f githubaction",
-                 "sudo -s /opt/xcat/sbin/chtab priority=1.1 policy.name=githubaction policy.rule=allow",
-                 "/etc/profile.d/xcat.sh ",
-                 "sudo /opt/xcat/sbin/tabdump policy",
-                 "sudo /opt/xcat/sbin/tabdump site",
-                 "sudo /opt/xcat/bin/lsxcatd -a",
+        @cmds = ("sudo -s /opt/xcat/share/xcat/scripts/setup-local-client.sh -f runner",
+                 "sudo -s /opt/xcat/sbin/chtab priority=1.1 policy.name=runner policy.rule=allow",
+                 ". /etc/profile.d/xcat.sh && tabdump policy",
+                 ". /etc/profile.d/xcat.sh && tabdump site",
+                 ". /etc/profile.d/xcat.sh && lsxcatd -a",
                  "ls /opt/xcat/sbin",
-                 "sudo service xcatd status");
+                 "service xcatd status");
         my $ret = 0;
         foreach my $cmd (@cmds){
             print "\n[install_xcat] running $cmd.....\n";
@@ -374,7 +373,7 @@ sub install_xcat{
         }
 
         if($ret){
-            $check_result_str .= "> **INSTALL XCAT ERROR** : Please click ``Details`` label in ``Merge pull request`` box for detailed information";
+            $check_result_str .= "> **INSTALL XCAT ERROR** : Please click ``Details`` label in ``Merge pull request`` box for detailed information\n";
             print $check_result_str;
             return 1;
         }
@@ -477,7 +476,7 @@ sub run_fast_regression_test{
     @output = runcmd("cat $conf_file");
     print Dumper \@output;
 
-    $cmd = "sudo /opt/xcat/bin/xcattest -s \"ci_test\" -l";
+    $cmd = "sudo bash -c '. /etc/profile.d/xcat.sh && xcattest -s \"ci_test\" -l'";
     my  @caseslist = runcmd("$cmd");
     if($::RUNCMD_RC){
          print RED "[run_fast_regression_test] $cmd ....[Failed]\n";
@@ -496,7 +495,7 @@ sub run_fast_regression_test{
     my $failnum = 0;
     foreach my $case (@caseslist){
         ++$x;
-        $cmd = "sudo /opt/xcat/bin/xcattest -f $conf_file -t $case";
+        $cmd = "sudo bash -c '. /etc/profile.d/xcat.sh &&  xcattest -f $conf_file -t $case'";
         print "[run_fast_regression_test] run $x: $cmd\n";
         @output = runcmd("$cmd");
         #print Dumper \@output;
@@ -515,11 +514,11 @@ sub run_fast_regression_test{
 
     if($failnum){
         my $log_str = join (",", @failcase );
-        $check_result_str .= "> **FAST REGRESSION TEST Failed**: Totalcase $casenum Passed $passnum Failed $failnum FailedCases: $log_str.  Please click ``Details`` label in ``Merge pull request`` box for detailed information";
+        $check_result_str .= "> **FAST REGRESSION TEST Failed**: Totalcase $casenum Passed $passnum Failed $failnum FailedCases: $log_str.  Please click ``Details`` label in ``Merge pull request`` box for detailed information\n";
         print $check_result_str;
         return 1;
     }else{
-        $check_result_str .= "> **FAST REGRESSION TEST Successful**: Totalcase $casenum Passed $passnum Failed $failnum";
+        $check_result_str .= "> **FAST REGRESSION TEST Successful**: Totalcase $casenum Passed $passnum Failed $failnum\n";
         print $check_result_str;
     }
 

diff --git a/xCAT-client/pods/man1/mkvm.1.pod b/xCAT-client/pods/man1/mkvm.1.pod
@@ -42,7 +42,7 @@ B<mkvm> I<noderange> [I<source_virtual_machine>] [B<pool=> I<disk_pool>]
 
 =head2 For PPC (with HMC) specific:
 
-The first form of B<mkvm> command creates new partition(s) with the same profile/resources as the partition specified by I<singlenode>. The -i and I<noderange> specify the starting numeric partition number and the I<noderange> for the newly created partitions, respectively. The LHEA port numbers and the HCA index numbers will be automatically increased if they are defined in the source partition.
+The first form of B<mkvm> command creates new partition(s) with the same profile/resources as the partition specified by I<singlenode>. The B<-i> and I<noderange> specify the starting numeric partition number and the I<noderange> for the newly created partitions, respectively. The LHEA port numbers and the HCA index numbers will be automatically increased if they are defined in the source partition.
 
 The second form of this command duplicates all the partitions from the source specified by I<profile> to the destination specified by I<destcec>. The source and destination CECs can be managed by different HMCs.
 
@@ -52,9 +52,9 @@ Note that the B<mkvm> command currently only supports creating standard LPARs, n
 
 =head2 For PPC (using Direct FSP Management) specific:
 
-With option I<full>, a partition using all the resources on a normal power machine will be created.
+With option B<--full>, a partition using all the resources on a normal power machine will be created.
 
-If no option is specified, a partition using the parameters specified with attributes such as 'vmcpus', 'vmmemory', 'vmphyslots', 'vmothersetting', 'vmnics', 'vmstorage' will be created. Those attributes can either be specified with '*def' commands running before or be specified with this command.
+If no option is specified, a partition using the parameters specified with attributes such as B<vmcpus>, B<vmmemory>, B<vmphyslots>, B<vmothersetting>, B<vmnics>, B<vmstorage> will be created. Those attributes can either be specified with '*def' commands running before or be specified with this command.
 
 =head2 For KVM and VMware:
 
@@ -88,9 +88,9 @@ Request to create a new full system partition for each CEC.
 
 =item B<vmcpus=> I<value> B<vmmemory=> I<value> B<vmphyslots=> I<value> B<vmothersetting=> I<value> B<vmnics=> I<value> B<vmstorage=> I<value> [B<--vios>]
 
-To specify the parameters which are used to create a partition. The I<vmcpus>, I<vmmemory> are necessary, and the value specified with this command have a more high priority. If the value of any of the three options is not specified, the corresponding value specified for the node object will be used. If any of the three attributes is neither specified with this command nor specified with the node object, error information will be returned. To reference to L<lsvm(1)|lsvm.1> for more information about 'drc_index' for I<vmphyslots>.
+To specify the parameters which are used to create a partition. The B<vmcpus>, B<vmmemory> are necessary, and the value specified with this command have a more high priority. If the value of any of the three options is not specified, the corresponding value specified for the node object will be used. If any of the three attributes is neither specified with this command nor specified with the node object, error information will be returned. To reference to L<lsvm(1)|lsvm.1> for more information about 'drc_index' for I<vmphyslots>.
 
-The option I<vios> is used to specify the partition that will be created is a VIOS partition. If specified, the value for I<vmstorage> shall be number which indicate the number of vSCSI server adapter will be created, and if no value specified for I<vmphyslots>, all the physical slot of the power machine will be assigned to VIOS partition. If not specified, it shall be in form of I<vios_name:server_slotid> to specify the vios and the virtual slot id of the vSCSI server adapter that will be connected from the Logical partition.
+The option B<vios> is used to specify the partition that will be created is a VIOS partition. If specified, the value for B<vmstorage> shall be number which indicate the number of vSCSI server adapter will be created, and if no value specified for B<vmphyslots>, all the physical slot of the power machine will be assigned to VIOS partition. If not specified, it shall be in form of B<vios_name:server_slotid> to specify the vios and the virtual slot id of the vSCSI server adapter that will be connected from the Logical partition.
 
 =item B<-f|--force>
 

diff --git a/xCAT-test/xcattest b/xCAT-test/xcattest
@@ -178,7 +178,7 @@ if($search_expression){
         print "------The total labels are:---------\n";
         print Dumper \@total_label_set;
         print "------The case and its labels:-------\n";
-        print Dumper \%case_label_map
+        print Dumper \%case_label_map;
     }
 }
 
@@ -258,7 +258,7 @@ if (defined $list) {
             print "------The total labels are:---------\n";
             print Dumper \@total_label_set;
             print "------The case and its labels:-------\n";
-            print Dumper \%case_label_map
+            print Dumper \%case_label_map;
         }
         my %label_conut;
         my %case_label_str_map;
@@ -1567,7 +1567,7 @@ sub setup_env_by_configure_file {
         log_this($running_log_fd, "$cmd");
         &runcmd($cmd);
         if ($::RUNCMD_RC != 0) {
-            $$error_ref = "Fail to run $cmd";
+            $$error_ref = "Failed to run $cmd";
             return 1;
         }
     }
@@ -1582,7 +1582,7 @@ sub setup_env_by_configure_file {
                 log_this($running_log_fd, "$cmd");
                 runcmd($cmd);
                 if ($::RUNCMD_RC != 0) {
-                    $$error_ref = "Fail to run $cmd";
+                    $$error_ref = "Failed to run $cmd";
                     return 1;
                 }
             }
@@ -1601,7 +1601,7 @@ sub setup_env_by_configure_file {
                 log_this($running_log_fd, "$cmd");
                 &runcmd($cmd);
                 if ($::RUNCMD_RC != 0) {
-                    $$error_ref = "Fail to run $cmd";
+                    $$error_ref = "Failed to run $cmd";
                     return 1;
                 }
             }
@@ -2116,7 +2116,7 @@ sub scan_existed_labels {
 
             my @labels = ();
             if ($line =~ /^start\s*:\s*(.*)/) {
-                $current_case_name                                     = $1;
+                $current_case_name = $1;
                 if ($cmd_cases_belong_to){
                     $case_label_map_ref->{$current_case_name}->{labels} = [$cmd_cases_belong_to];
                     push @$total_label_set_ref, $cmd_cases_belong_to unless(inarray($total_label_set_ref, $cmd_cases_belong_to));