[Qemu-devel] [PATCH 1/1] qga: update docs with systemd suspend support info

[Qemu-devel] [PATCH 1/1] qga: update docs with systemd suspend support info

[Daniel Henrique Barboza]

Commit 067927d62e ("qga: systemd hibernate/suspend/hybrid-sleep
support") failed to update qapi-schema.json after adding systemd
hibernate/suspend/hybrid-sleep capabilities to guest-suspend-* QGA
commands.

Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
---
 qga/qapi-schema.json | 37 ++++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 11 deletions(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index c6725b3ec8..74b1bdbc76 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -532,12 +532,16 @@
 #
 # Suspend guest to disk.
 #
-# This command tries to execute the scripts provided by the pm-utils package.
-# If it's not available, the suspend operation will be performed by manually
-# writing to a sysfs file.
+# This command attempts to suspend the guest using three strategies, in this
+# order:
 #
-# For the best results it's strongly recommended to have the pm-utils
-# package installed in the guest.
+# - systemd hibernate
+# - pm-utils (via pm-hibernate)
+# - manual write into sysfs
+#
+# If the guest does not have systemd hibernate support, the scripts in pm-utils
+# package are executed, in case pm-utils is available. Manual write in sysfs
+# is a last resort.
 #
 # This command does NOT return a response on success. There is a high chance
 # the command succeeded if the VM exits with a zero exit status or, when
@@ -560,12 +564,16 @@
 #
 # Suspend guest to ram.
 #
-# This command tries to execute the scripts provided by the pm-utils package.
-# If it's not available, the suspend operation will be performed by manually
-# writing to a sysfs file.
+# This command attempts to suspend the guest using three strategies, in this
+# order:
+#
+# - systemd suspend
+# - pm-utils (via pm-suspend)
+# - manual write into sysfs
 #
-# For the best results it's strongly recommended to have the pm-utils
-# package installed in the guest.
+# If the guest does not have systemd suspend support, the scripts in pm-utils
+# package are executed, in case pm-utils is available. Manual write in sysfs
+# is a last resort.
 #
 # IMPORTANT: guest-suspend-ram requires QEMU to support the 'system_wakeup'
 # command.  Thus, it's *required* to query QEMU for the presence of the
@@ -592,7 +600,14 @@
 #
 # Save guest state to disk and suspend to ram.
 #
-# This command requires the pm-utils package to be installed in the guest.
+# This command attempts to suspend the guest using three strategies, in this
+# order:
+#
+# - systemd hybrid-sleep
+# - pm-utils (via pm-suspend-hybrid)
+#
+# If the guest does not have systemd hybrid-sleep support, the scripts in
+# pm-utils package are executed, in case pm-utils is available.
 #
 # IMPORTANT: guest-suspend-hybrid requires QEMU to support the 'system_wakeup'
 # command.  Thus, it's *required* to query QEMU for the presence of the
-- 
2.19.1

Re: [Qemu-devel] [PATCH 1/1] qga: update docs with systemd suspend support info

[Eric Blake]

On 11/13/18 10:09 AM, Daniel Henrique Barboza wrote:
> Commit 067927d62e ("qga: systemd hibernate/suspend/hybrid-sleep
> support") failed to update qapi-schema.json after adding systemd
> hibernate/suspend/hybrid-sleep capabilities to guest-suspend-* QGA
> commands.
> 
> Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
> ---
>   qga/qapi-schema.json | 37 ++++++++++++++++++++++++++-----------
>   1 file changed, 26 insertions(+), 11 deletions(-)

> +++ b/qga/qapi-schema.json
> @@ -532,12 +532,16 @@
>   #
>   # Suspend guest to disk.
>   #
> -# This command tries to execute the scripts provided by the pm-utils package.
> -# If it's not available, the suspend operation will be performed by manually
> -# writing to a sysfs file.
> +# This command attempts to suspend the guest using three strategies, in this
> +# order:
>   #
> -# For the best results it's strongly recommended to have the pm-utils
> -# package installed in the guest.
> +# - systemd hibernate
> +# - pm-utils (via pm-hibernate)
> +# - manual write into sysfs
> +#
> +# If the guest does not have systemd hibernate support, the scripts in pm-utils
> +# package are executed, in case pm-utils is available. Manual write in sysfs
> +# is a last resort.

Does this paragraph add any information compared to the earlier list?

>   #
>   # This command does NOT return a response on success. There is a high chance
>   # the command succeeded if the VM exits with a zero exit status or, when
> @@ -560,12 +564,16 @@
>   #
>   # Suspend guest to ram.
>   #
> -# This command tries to execute the scripts provided by the pm-utils package.
> -# If it's not available, the suspend operation will be performed by manually
> -# writing to a sysfs file.
> +# This command attempts to suspend the guest using three strategies, in this
> +# order:
> +#
> +# - systemd suspend
> +# - pm-utils (via pm-suspend)
> +# - manual write into sysfs
>   #
> -# For the best results it's strongly recommended to have the pm-utils
> -# package installed in the guest.
> +# If the guest does not have systemd suspend support, the scripts in pm-utils
> +# package are executed, in case pm-utils is available. Manual write in sysfs
> +# is a last resort.

Likewise.

>   #
>   # IMPORTANT: guest-suspend-ram requires QEMU to support the 'system_wakeup'
>   # command.  Thus, it's *required* to query QEMU for the presence of the
> @@ -592,7 +600,14 @@
>   #
>   # Save guest state to disk and suspend to ram.
>   #
> -# This command requires the pm-utils package to be installed in the guest.
> +# This command attempts to suspend the guest using three strategies, in this
> +# order:
> +#
> +# - systemd hybrid-sleep
> +# - pm-utils (via pm-suspend-hybrid)
> +#
> +# If the guest does not have systemd hybrid-sleep support, the scripts in
> +# pm-utils package are executed, in case pm-utils is available.

"using three strategies" but a list of only 2 seems odd.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org

Re: [Qemu-devel] [PATCH 1/1] qga: update docs with systemd suspend support info

[Daniel Henrique Barboza]

On 11/13/18 2:32 PM, Eric Blake wrote:
> On 11/13/18 10:09 AM, Daniel Henrique Barboza wrote:
>> Commit 067927d62e ("qga: systemd hibernate/suspend/hybrid-sleep
>> support") failed to update qapi-schema.json after adding systemd
>> hibernate/suspend/hybrid-sleep capabilities to guest-suspend-* QGA
>> commands.
>>
>> Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
>> ---
>>   qga/qapi-schema.json | 37 ++++++++++++++++++++++++++-----------
>>   1 file changed, 26 insertions(+), 11 deletions(-)
>
>> +++ b/qga/qapi-schema.json
>> @@ -532,12 +532,16 @@
>>   #
>>   # Suspend guest to disk.
>>   #
>> -# This command tries to execute the scripts provided by the pm-utils 
>> package.
>> -# If it's not available, the suspend operation will be performed by 
>> manually
>> -# writing to a sysfs file.
>> +# This command attempts to suspend the guest using three strategies, 
>> in this
>> +# order:
>>   #
>> -# For the best results it's strongly recommended to have the pm-utils
>> -# package installed in the guest.
>> +# - systemd hibernate
>> +# - pm-utils (via pm-hibernate)
>> +# - manual write into sysfs
>> +#
>> +# If the guest does not have systemd hibernate support, the scripts 
>> in pm-utils
>> +# package are executed, in case pm-utils is available. Manual write 
>> in sysfs
>> +# is a last resort.
>
> Does this paragraph add any information compared to the earlier list?

Perhaps we can remove the paragraph and add "if available" remarks in 
the listing?
Like:

+# - systemd hibernate, if supported
+# - pm-utils (via pm-hibernate), if pm-utils is installed
+# - manual write into sysfs as a last resort

Same for the other 2 cases below.

>
>>   #
>>   # This command does NOT return a response on success. There is a 
>> high chance
>>   # the command succeeded if the VM exits with a zero exit status or, 
>> when
>> @@ -560,12 +564,16 @@
>>   #
>>   # Suspend guest to ram.
>>   #
>> -# This command tries to execute the scripts provided by the pm-utils 
>> package.
>> -# If it's not available, the suspend operation will be performed by 
>> manually
>> -# writing to a sysfs file.
>> +# This command attempts to suspend the guest using three strategies, 
>> in this
>> +# order:
>> +#
>> +# - systemd suspend
>> +# - pm-utils (via pm-suspend)
>> +# - manual write into sysfs
>>   #
>> -# For the best results it's strongly recommended to have the pm-utils
>> -# package installed in the guest.
>> +# If the guest does not have systemd suspend support, the scripts in 
>> pm-utils
>> +# package are executed, in case pm-utils is available. Manual write 
>> in sysfs
>> +# is a last resort.
>
> Likewise.
>
>>   #
>>   # IMPORTANT: guest-suspend-ram requires QEMU to support the 
>> 'system_wakeup'
>>   # command.  Thus, it's *required* to query QEMU for the presence of 
>> the
>> @@ -592,7 +600,14 @@
>>   #
>>   # Save guest state to disk and suspend to ram.
>>   #
>> -# This command requires the pm-utils package to be installed in the 
>> guest.
>> +# This command attempts to suspend the guest using three strategies, 
>> in this
>> +# order:
>> +#
>> +# - systemd hybrid-sleep
>> +# - pm-utils (via pm-suspend-hybrid)
>> +#
>> +# If the guest does not have systemd hybrid-sleep support, the 
>> scripts in
>> +# pm-utils package are executed, in case pm-utils is available.
>
> "using three strategies" but a list of only 2 seems odd.
>

Copy/paste busted!

Re: [Qemu-devel] [PATCH 1/1] qga: update docs with systemd suspend support info

[Daniel Henrique Barboza]

On 11/13/18 2:39 PM, Daniel Henrique Barboza wrote:
>
>
> On 11/13/18 2:32 PM, Eric Blake wrote:
>> On 11/13/18 10:09 AM, Daniel Henrique Barboza wrote:
>>> Commit 067927d62e ("qga: systemd hibernate/suspend/hybrid-sleep
>>> support") failed to update qapi-schema.json after adding systemd
>>> hibernate/suspend/hybrid-sleep capabilities to guest-suspend-* QGA
>>> commands.
>>>
>>> Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
>>> ---
>>>   qga/qapi-schema.json | 37 ++++++++++++++++++++++++++-----------
>>>   1 file changed, 26 insertions(+), 11 deletions(-)
>>
>>> +++ b/qga/qapi-schema.json
>>> @@ -532,12 +532,16 @@
>>>   #
>>>   # Suspend guest to disk.
>>>   #
>>> -# This command tries to execute the scripts provided by the 
>>> pm-utils package.
>>> -# If it's not available, the suspend operation will be performed by 
>>> manually
>>> -# writing to a sysfs file.
>>> +# This command attempts to suspend the guest using three 
>>> strategies, in this
>>> +# order:
>>>   #
>>> -# For the best results it's strongly recommended to have the pm-utils
>>> -# package installed in the guest.
>>> +# - systemd hibernate
>>> +# - pm-utils (via pm-hibernate)
>>> +# - manual write into sysfs
>>> +#
>>> +# If the guest does not have systemd hibernate support, the scripts 
>>> in pm-utils
>>> +# package are executed, in case pm-utils is available. Manual write 
>>> in sysfs
>>> +# is a last resort.
>>
>> Does this paragraph add any information compared to the earlier list?
>
> Perhaps we can remove the paragraph and add "if available" remarks in 
> the listing?
> Like:
>
> +# - systemd hibernate, if supported
> +# - pm-utils (via pm-hibernate), if pm-utils is installed
> +# - manual write into sysfs as a last resort
>
> Same for the other 2 cases below.

Actually, nevermind. Removing the extra paragraph and keeping the list as is
seems cleaner. One can easily assume that, in the lack of guest support of
systemd hibernate, the command will try the next option. Same thing
with pm-utils.

>
>>
>>>   #
>>>   # This command does NOT return a response on success. There is a 
>>> high chance
>>>   # the command succeeded if the VM exits with a zero exit status 
>>> or, when
>>> @@ -560,12 +564,16 @@
>>>   #
>>>   # Suspend guest to ram.
>>>   #
>>> -# This command tries to execute the scripts provided by the 
>>> pm-utils package.
>>> -# If it's not available, the suspend operation will be performed by 
>>> manually
>>> -# writing to a sysfs file.
>>> +# This command attempts to suspend the guest using three 
>>> strategies, in this
>>> +# order:
>>> +#
>>> +# - systemd suspend
>>> +# - pm-utils (via pm-suspend)
>>> +# - manual write into sysfs
>>>   #
>>> -# For the best results it's strongly recommended to have the pm-utils
>>> -# package installed in the guest.
>>> +# If the guest does not have systemd suspend support, the scripts 
>>> in pm-utils
>>> +# package are executed, in case pm-utils is available. Manual write 
>>> in sysfs
>>> +# is a last resort.
>>
>> Likewise.
>>
>>>   #
>>>   # IMPORTANT: guest-suspend-ram requires QEMU to support the 
>>> 'system_wakeup'
>>>   # command.  Thus, it's *required* to query QEMU for the presence 
>>> of the
>>> @@ -592,7 +600,14 @@
>>>   #
>>>   # Save guest state to disk and suspend to ram.
>>>   #
>>> -# This command requires the pm-utils package to be installed in the 
>>> guest.
>>> +# This command attempts to suspend the guest using three 
>>> strategies, in this
>>> +# order:
>>> +#
>>> +# - systemd hybrid-sleep
>>> +# - pm-utils (via pm-suspend-hybrid)
>>> +#
>>> +# If the guest does not have systemd hybrid-sleep support, the 
>>> scripts in
>>> +# pm-utils package are executed, in case pm-utils is available.
>>
>> "using three strategies" but a list of only 2 seems odd.
>>
>
> Copy/paste busted!