From 7e5632ace6ba13a24b51b86f858c3653393bf572 Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Fri, 15 Jul 2022 10:27:14 -0400 Subject: [PATCH] Fix rmvm man page formatting --- .../admin-guides/references/man1/rmvm.1.rst | 47 +++++++++++++++---- xCAT-client/pods/man1/rmvm.1.pod | 35 ++++++++++---- 2 files changed, 62 insertions(+), 20 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/rmvm.1.rst b/docs/source/guides/admin-guides/references/man1/rmvm.1.rst index 304d32dc0..f0ff04598 100644 --- a/docs/source/guides/admin-guides/references/man1/rmvm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmvm.1.rst @@ -47,7 +47,7 @@ DESCRIPTION The \ **rmvm**\ command removes the partitions specified in \ *noderange*\ . If \ *noderange*\ is an CEC, all the partitions associated with that CEC will be removed. Note that removed partitions are automatically removed from the xCAT database. For IVM-managed systems, care must be taken to not remove the VIOS partition, or all the associated partitions will be removed as well. -For DFM-managed (short For Direct FSP Management mode) normal power machines, only partitions can be removed. No options is needed. +For DFM-managed (short For Direct FSP Management mode) normal Power machines, only partitions can be removed. No options are needed. ******* @@ -55,23 +55,50 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ Command Version. +\ **-h|-**\ **-help**\ + + Display usage message. + -\ **-V|-**\ **-verbose**\ Verbose output. -\ **-r**\ Retain the data object definitions of the nodes. +\ **-v|-**\ **-version**\ + + Command Version. + + + +\ **-V|-**\ **-verbose**\ + + Verbose output. + + + +\ **-r**\ + + Retain the data object definitions of the nodes. + + + +\ **-**\ **-service**\ + + Remove the service partitions of the specified CECs. + -\ **-**\ **-service**\ Remove the service partitions of the specified CECs. \ **-p**\ + + KVM: Purge the existence of the VM from persistent storage. This will erase all storage related to the VM in addition to removing it from the active virtualization configuration. Storage devices of "raw" or "block" type are not removed. + + PPC: Remove the specified partition on normal Power machine. + -KVM: Purge the existence of the VM from persistent storage. This will erase all storage related to the VM in addition to removing it from the active virtualization configuration. Storage devices of "raw" or "block" type are not removed. -PPC: Remove the specified partition on normal power machine. +\ **-f**\ + + Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested. + -\ **-f**\ Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested. ************ @@ -172,7 +199,7 @@ Output is similar to: gpok4: Deleting virtual server LNX4... Done -6. To remove a DFM-managed partition on normal power machine: +6. To remove a DFM-managed partition on normal Power machine: .. code-block:: perl diff --git a/xCAT-client/pods/man1/rmvm.1.pod b/xCAT-client/pods/man1/rmvm.1.pod index a649b5ac5..5b29d03e6 100644 --- a/xCAT-client/pods/man1/rmvm.1.pod +++ b/xCAT-client/pods/man1/rmvm.1.pod @@ -22,28 +22,43 @@ B I The B command removes the partitions specified in I. If I is an CEC, all the partitions associated with that CEC will be removed. Note that removed partitions are automatically removed from the xCAT database. For IVM-managed systems, care must be taken to not remove the VIOS partition, or all the associated partitions will be removed as well. -For DFM-managed (short For Direct FSP Management mode) normal power machines, only partitions can be removed. No options is needed. +For DFM-managed (short For Direct FSP Management mode) normal Power machines, only partitions can be removed. No options are needed. =head1 OPTIONS +=over 10 -B<-h|--help> Display usage message. +=item B<-h|--help> -B<-v|--version> Command Version. +Display usage message. -B<-V|--verbose> Verbose output. +=item B<-v|--version> -B<-r> Retain the data object definitions of the nodes. +Command Version. -B<--service> Remove the service partitions of the specified CECs. +=item B<-V|--verbose> -B<-p> +Verbose output. + +=item B<-r> + +Retain the data object definitions of the nodes. + +=item B<--service> + +Remove the service partitions of the specified CECs. + +=item B<-p> KVM: Purge the existence of the VM from persistent storage. This will erase all storage related to the VM in addition to removing it from the active virtualization configuration. Storage devices of "raw" or "block" type are not removed. -PPC: Remove the specified partition on normal power machine. +PPC: Remove the specified partition on normal Power machine. -B<-f> Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested. +=item B<-f> + +Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested. + +=back =head1 RETURN VALUE @@ -97,7 +112,7 @@ Output is similar to: gpok4: Deleting virtual server LNX4... Done -6. To remove a DFM-managed partition on normal power machine: +6. To remove a DFM-managed partition on normal Power machine: rmvm lpar1