Skip to contentSkip to conversation

kvm/arm: Fix pvtime documentation

PATCH Applied Usama Arif 4 participants 8 messages Nov 3, 2022 – Nov 4, 2022

Subsystems (3)
lore
Share & tools
lore

Usama Arif

author
#0 lore raw

PATCH 1/1 kvm/arm: Fix pvtime documentation

This includes table format and using reST labels for cross-referencing to vcpu.rst.

---
 Documentation/virt/kvm/arm/pvtime.rst   | 14 ++++++++------
 Documentation/virt/kvm/devices/vcpu.rst |  2 ++
 2 files changed, 10 insertions(+), 6 deletions(-)
Documentation/virt/kvm/arm/pvtime.rst +8 -6
index 392521af7c90..e88b34e586be 100644
@@ -23,21 +23,23 @@ the PV_TIME_FEATURES hypercall should be probed using the SMCCC 1.1
 ARCH_FEATURES mechanism before calling it.
 
 PV_TIME_FEATURES
-    ============= ========    ==========
+
+    ============= ========    =================================================
     Function ID:  (uint32)    0xC5000020
     PV_call_id:   (uint32)    The function to query for support.
                               Currently only PV_TIME_ST is supported.
     Return value: (int64)     NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant
                               PV-time feature is supported by the hypervisor.
-    ============= ========    ==========
+    ============= ========    =================================================
 
 PV_TIME_ST
-    ============= ========    ==========
+
+    ============= ========    ==============================================
     Function ID:  (uint32)    0xC5000021
     Return value: (int64)     IPA of the stolen time data structure for this
                               VCPU. On failure:
                               NOT_SUPPORTED (-1)
-    ============= ========    ==========
+    ============= ========    ==============================================
 
 The IPA returned by PV_TIME_ST should be mapped by the guest as normal memory
 with inner and outer write back caching attributes, in the inner shareable
@@ -76,5 +78,5 @@ It is advisable that one or more 64k pages are set aside for the purpose of
 these structures and not used for other purposes, this enables the guest to map
 the region using 64k pages and avoids conflicting attributes with other memory.
 
-For the user space interface see Documentation/virt/kvm/devices/vcpu.rst
-section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".
+For the user space interface see
+:ref:`Documentation/virt/kvm/devices/vcpu.rst <kvm_arm_vcpu_pvtime_ctrl>`.
\ No newline at end of file
Documentation/virt/kvm/devices/vcpu.rst +2 -0
index 716aa3edae14..31f14ec4a65b 100644
@@ -171,6 +171,8 @@ configured values on other VCPUs.  Userspace should configure the interrupt
 numbers on at least one VCPU after creating all VCPUs and before running any
 VCPUs.
 
+.. _kvm_arm_vcpu_pvtime_ctrl:
+
 3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL
 ==================================
 
Signature · 6 lines
2.25.1

_______________________________________________
kvmarm mailing list
[email protected]
https://lists.cs.columbia.edu/mailman/listinfo/kvmarm
Reviewed-by on v1 1/1
#1 lore raw
Quoted 5 lines · Usama Arif

This includes table format and using reST labels for cross-referencing to vcpu.rst.

Quoted 59 lines
---
 Documentation/virt/kvm/arm/pvtime.rst   | 14 ++++++++------
 Documentation/virt/kvm/devices/vcpu.rst |  2 ++
 2 files changed, 10 insertions(+), 6 deletions(-)
Documentation/virt/kvm/arm/pvtime.rst +8 -6
index 392521af7c90..e88b34e586be 100644
@@ -23,21 +23,23 @@ the PV_TIME_FEATURES hypercall should be probed using the SMCCC 1.1
 ARCH_FEATURES mechanism before calling it.
 
 PV_TIME_FEATURES
-    ============= ========    ==========
+
+    ============= ========    =================================================
     Function ID:  (uint32)    0xC5000020
     PV_call_id:   (uint32)    The function to query for support.
                               Currently only PV_TIME_ST is supported.
     Return value: (int64)     NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant
                               PV-time feature is supported by the hypervisor.
-    ============= ========    ==========
+    ============= ========    =================================================
 
 PV_TIME_ST
-    ============= ========    ==========
+
+    ============= ========    ==============================================
     Function ID:  (uint32)    0xC5000021
     Return value: (int64)     IPA of the stolen time data structure for this
                               VCPU. On failure:
                               NOT_SUPPORTED (-1)
-    ============= ========    ==========
+    ============= ========    ==============================================
 
 The IPA returned by PV_TIME_ST should be mapped by the guest as normal memory
 with inner and outer write back caching attributes, in the inner shareable
@@ -76,5 +78,5 @@ It is advisable that one or more 64k pages are set aside for the purpose of
 these structures and not used for other purposes, this enables the guest to map
 the region using 64k pages and avoids conflicting attributes with other memory.
 
-For the user space interface see Documentation/virt/kvm/devices/vcpu.rst
-section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".
+For the user space interface see
+:ref:`Documentation/virt/kvm/devices/vcpu.rst <kvm_arm_vcpu_pvtime_ctrl>`.
\ No newline at end of file
Documentation/virt/kvm/devices/vcpu.rst +2 -0
index 716aa3edae14..31f14ec4a65b 100644
@@ -171,6 +171,8 @@ configured values on other VCPUs.  Userspace should configure the interrupt
 numbers on at least one VCPU after creating all VCPUs and before running any
 VCPUs.
 
+.. _kvm_arm_vcpu_pvtime_ctrl:
+
 3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL
 ==================================
 
#2 lore raw
In reply to Usama Arif
Quoted 5 lines · Usama Arif

This includes table format and using reST labels for cross-referencing to vcpu.rst.

This is not what people normally do when given suggestion diff like what I sent before [1]. Instead, they just apply and squash the suggestion (while also applying requested changes from reviewers).

Please reroll your series [2] with suggestion applied.

Thanks.

[1]: https://lore.kernel.org/linux-doc/[email protected]/
[2]: https://lore.kernel.org/linux-doc/[email protected]/

Signature · 1 line
An old man doll... just what I always wanted! - Clara
maintainer
#3 lore raw
Quoted 11 lines · Bagas Sanjaya
Quoted 5 lines · Usama Arif

This includes table format and using reST labels for cross-referencing to vcpu.rst.

This is not what people normally do when given suggestion diff like what I sent before [1]. Instead, they just apply and squash the suggestion (while also applying requested changes from reviewers).

No, this is the correct course of action. There isn't any point in having an *unrelated* change in a separate series. This is a standalone change, posted as a standalone patch.

Quoted 1 line

Please reroll your series [2] with suggestion applied.

Or not.

	M.
Signature · 5 lines
Without deviation from the norm, progress is not possible.
_______________________________________________
kvmarm mailing list
[email protected]
https://lists.cs.columbia.edu/mailman/listinfo/kvmarm
#4 lore raw
Quoted 8 lines · Marc Zyngier

No, this is the correct course of action. There isn't any point in having an *unrelated* change in a separate series. This is a standalone change, posted as a standalone patch.

Quoted 1 line

Please reroll your series [2] with suggestion applied.

Or not.

You mean the series before this patch have already been applied, right?

Signature · 6 lines
An old man doll... just what I always wanted! - Clara

_______________________________________________
kvmarm mailing list
[email protected]
https://lists.cs.columbia.edu/mailman/listinfo/kvmarm
maintainer
#5 lore raw
Quoted 6 lines · Bagas Sanjaya
Quoted 4 lines · Marc Zyngier

No, this is the correct course of action. There isn't any point in having an *unrelated* change in a separate series. This is a standalone change, posted as a standalone patch.

Quoted 7 lines
Quoted 4 lines
Quoted 1 line

Please reroll your series [2] with suggestion applied.

Or not.

You mean the series before this patch have already been applied, right?

This change is 100% independent from the series you quoted. Why should there be a dependency between the two?

As for respinning the series at this stage for a documentation formatting issue, this is pretty pointless, and only clutters people's Inbox with redundant versions...

	M.
Signature · 5 lines
Without deviation from the norm, progress is not possible.
_______________________________________________
kvmarm mailing list
[email protected]
https://lists.cs.columbia.edu/mailman/listinfo/kvmarm
#6 lore raw
Quoted 16 lines · Marc Zyngier
Quoted 6 lines · Bagas Sanjaya
Quoted 4 lines · Marc Zyngier

No, this is the correct course of action. There isn't any point in having an *unrelated* change in a separate series. This is a standalone change, posted as a standalone patch.

Quoted 7 lines
Quoted 4 lines
Quoted 1 line

Please reroll your series [2] with suggestion applied.

Or not.

You mean the series before this patch have already been applied, right?

Quoted 9 lines

This change is 100% independent from the series you quoted. Why should there be a dependency between the two?

As for respinning the series at this stage for a documentation formatting issue, this is pretty pointless, and only clutters people's Inbox with redundant versions...

	M.

OK, thanks!

Signature · 6 lines
An old man doll... just what I always wanted! - Clara

_______________________________________________
kvmarm mailing list
[email protected]
https://lists.cs.columbia.edu/mailman/listinfo/kvmarm
maintainer Applied
#7 lore raw
In reply to Usama Arif
Quoted 2 lines · Usama Arif

This includes table format and using reST labels for cross-referencing to vcpu.rst.

Applied to kvm-arm64/misc-6.2, thanks!

[1/1] kvm/arm: Fix pvtime documentation

      commit: e7442ac1da07910f4731cb812c05484e4be2d4de

Cheers,

	M.
Signature · 1 line
Without deviation from the norm, progress is not possible.