Re: [PATCH] kvm/arm: Fix pvtime documentation

[Steven Price]

On 03/11/2022 13:12, Usama Arif wrote:
> This includes table format and using reST labels for
> cross-referencing to vcpu.rst.
> 
> Suggested-by:  Bagas Sanjaya <bagasdotme@xxxxxxxxx>
> Signed-off-by: Usama Arif <usama.arif@xxxxxxxxxxxxx>

Reviewed-by: Steven Price <steven.price@xxxxxxx>

> ---
>  Documentation/virt/kvm/arm/pvtime.rst   | 14 ++++++++------
>  Documentation/virt/kvm/devices/vcpu.rst |  2 ++
>  2 files changed, 10 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/virt/kvm/arm/pvtime.rst b/Documentation/virt/kvm/arm/pvtime.rst
> index 392521af7c90..e88b34e586be 100644
> --- a/Documentation/virt/kvm/arm/pvtime.rst
> +++ b/Documentation/virt/kvm/arm/pvtime.rst
> @@ -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
> diff --git a/Documentation/virt/kvm/devices/vcpu.rst b/Documentation/virt/kvm/devices/vcpu.rst
> index 716aa3edae14..31f14ec4a65b 100644
> --- a/Documentation/virt/kvm/devices/vcpu.rst
> +++ b/Documentation/virt/kvm/devices/vcpu.rst
> @@ -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
>  ==================================
>