[pve-devel] [PATCH qemu-server/container/docs 0/4] overrule-shutdown: documentation fixes

[pve-devel] [PATCH qemu-server/container/docs 0/4] overrule-shutdown: documentation fixes

[Friedrich Weber]

All patches are optional:

- 1/4 fixes spacing and punctuation in the qmshutdown/qmstop descriptions
- 2/4 rewords the overrule-shutdown description for VMs
- 3/4 is the same change for containers
- 4/4 adds a usage example for qm stop -overrule-shutdown to the docs

qemu-server:

Friedrich Weber (2):
  api: fix spacing and punctuation in shutdown and stop descriptions
  api: stop: reword overrule-shutdown parameter description

 PVE/API2/Qemu.pm | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)


container:

Friedrich Weber (1):
  api: stop: reword overrule-shutdown parameter description

 src/PVE/API2/LXC/Status.pm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


docs:

Friedrich Weber (1):
  qm: add overrule-shutdown to CLI usage examples

 qm.adoc | 7 +++++++
 1 file changed, 7 insertions(+)


Summary over all repositories:
  3 files changed, 14 insertions(+), 0 deletions(-)

-- 
Generated by git-murpp 0.5.0


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH qemu-server 1/4] api: fix spacing and punctuation in shutdown and stop descriptions

[Friedrich Weber]

Add missing spaces and full-stops and wrap strings according to Perl
style guide.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
---
 PVE/API2/Qemu.pm | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/PVE/API2/Qemu.pm b/PVE/API2/Qemu.pm
index 6c9e883..00cd907 100644
--- a/PVE/API2/Qemu.pm
+++ b/PVE/API2/Qemu.pm
@@ -3017,8 +3017,8 @@ __PACKAGE__->register_method({
     method => 'POST',
     protected => 1,
     proxyto => 'node',
-    description => "Stop virtual machine. The qemu process will exit immediately. This" .
-	"is akin to pulling the power plug of a running computer and may damage the VM data",
+    description => "Stop virtual machine. The qemu process will exit immediately. This"
+	." is akin to pulling the power plug of a running computer and may damage the VM data.",
     permissions => {
 	check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
     },
@@ -3173,8 +3173,9 @@ __PACKAGE__->register_method({
     method => 'POST',
     protected => 1,
     proxyto => 'node',
-    description => "Shutdown virtual machine. This is similar to pressing the power button on a physical machine." .
-	"This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.",
+    description => "Shutdown virtual machine. This is similar to pressing the power button on a"
+	." physical machine. This will send an ACPI event for the guest OS, which should then"
+	." proceed to a clean shutdown.",
     permissions => {
 	check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
     },
-- 
2.39.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH qemu-server 2/4] api: stop: reword overrule-shutdown parameter description

[Friedrich Weber]

The previous wording made it sound like all "visible" tasks were
aborted, which is not the case: A user with Sys.Audit but without
Sys.Modify may see a task that was started by a different user, but
overrule-shutdown would not abort the task.

Change wording to better reflect that not all visible tasks may be
aborted.

Also, add a full-stop that was previously missing.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
---
 PVE/API2/Qemu.pm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/PVE/API2/Qemu.pm b/PVE/API2/Qemu.pm
index 00cd907..2a349c8 100644
--- a/PVE/API2/Qemu.pm
+++ b/PVE/API2/Qemu.pm
@@ -3043,7 +3043,7 @@ __PACKAGE__->register_method({
 		default => 0,
 	    },
 	    'overrule-shutdown' => {
-		description => "Abort any active and visible 'qmshutdown' tasks before stopping",
+		description => "Try to abort active 'qmshutdown' tasks before stopping.",
 		optional => 1,
 		type => 'boolean',
 		default => 0,
-- 
2.39.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH container 3/4] api: stop: reword overrule-shutdown parameter description

[Friedrich Weber]

The previous wording made it sound like all "visible" tasks were
aborted, which is not the case: A user with Sys.Audit but without
Sys.Modify may see a task that was started by a different user, but
overrule-shutdown would not abort the task.

Change wording to better reflect that not all visible tasks may be
aborted.

Also, add a full-stop that was previously missing.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
---
 src/PVE/API2/LXC/Status.pm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/PVE/API2/LXC/Status.pm b/src/PVE/API2/LXC/Status.pm
index 08e23b6..2eeecdf 100644
--- a/src/PVE/API2/LXC/Status.pm
+++ b/src/PVE/API2/LXC/Status.pm
@@ -221,7 +221,7 @@ __PACKAGE__->register_method({
 	    vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid_running }),
 	    skiplock => get_standard_option('skiplock'),
 	    'overrule-shutdown' => {
-		description => "Abort any active and visible 'vzshutdown' tasks before stopping",
+		description => "Try to abort active 'vzshutdown' tasks before stopping.",
 		optional => 1,
 		type => 'boolean',
 		default => 0,
-- 
2.39.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] [PATCH docs 4/4] qm: add overrule-shutdown to CLI usage examples

[Friedrich Weber]

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
---
 qm.adoc | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/qm.adoc b/qm.adoc
index 45e3a57..42c26db 100644
--- a/qm.adoc
+++ b/qm.adoc
@@ -1839,6 +1839,13 @@ Same as above, but only wait for 40 seconds.
 # qm shutdown 300 && qm wait 300 -timeout 40
 ----
 
+If the VM does not shut down, force-stop it and overrule any running shutdown
+tasks. As stopping VMs may incur data loss, use it with caution.
+
+----
+# qm stop 300 -overrule-shutdown 1
+----
+
 Destroying a VM always removes it from Access Control Lists and it always
 removes the firewall configuration of the VM. You have to activate
 '--purge', if you want to additionally remove the VM from replication jobs,
-- 
2.39.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

[pve-devel] applied-series: [PATCH qemu-server/container/docs 0/4] overrule-shutdown: documentation fixes

[Thomas Lamprecht]

Am 18/04/2024 um 15:46 schrieb Friedrich Weber:
> All patches are optional:
> 
> - 1/4 fixes spacing and punctuation in the qmshutdown/qmstop descriptions
> - 2/4 rewords the overrule-shutdown description for VMs
> - 3/4 is the same change for containers
> - 4/4 adds a usage example for qm stop -overrule-shutdown to the docs
> 
> qemu-server:
> 
> Friedrich Weber (2):
>   api: fix spacing and punctuation in shutdown and stop descriptions
>   api: stop: reword overrule-shutdown parameter description
> 
>  PVE/API2/Qemu.pm | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> 
> container:
> 
> Friedrich Weber (1):
>   api: stop: reword overrule-shutdown parameter description
> 
>  src/PVE/API2/LXC/Status.pm | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> 
> docs:
> 
> Friedrich Weber (1):
>   qm: add overrule-shutdown to CLI usage examples
> 
>  qm.adoc | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> 
> Summary over all repositories:
>   3 files changed, 14 insertions(+), 0 deletions(-)
> 


applied series, thanks!


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel