[PATCH v1 1/1] Documentation: kvm: Fix a section number

[PATCH v1 1/1] Documentation: kvm: Fix a section number

[Xin Li (Intel)]

The previous section is 7.41, thus this should be 7.42.

Signed-off-by: Xin Li (Intel) <xin@zytor.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 47c7c3f92314..58478b470860 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -8478,7 +8478,7 @@ ENOSYS for the others.
 When enabled, KVM will exit to userspace with KVM_EXIT_SYSTEM_EVENT of
 type KVM_SYSTEM_EVENT_SUSPEND to process the guest suspend request.
 
-7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
+7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
 -------------------------------------
 
 :Architectures: arm64

base-commit: 8ffd015db85fea3e15a77027fda6c02ced4d2444
-- 
2.49.0

Re: [PATCH v1 1/1] Documentation: kvm: Fix a section number

[Jonathan Corbet]

"Xin Li (Intel)" <xin@zytor.com> writes:

> The previous section is 7.41, thus this should be 7.42.
>
> Signed-off-by: Xin Li (Intel) <xin@zytor.com>
> ---
>  Documentation/virt/kvm/api.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 47c7c3f92314..58478b470860 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -8478,7 +8478,7 @@ ENOSYS for the others.
>  When enabled, KVM will exit to userspace with KVM_EXIT_SYSTEM_EVENT of
>  type KVM_SYSTEM_EVENT_SUSPEND to process the guest suspend request.
>  
> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>  -------------------------------------

The fix seems fine but ... I have to ask ... do the section numbers buy
anything here?  We have a documentation system that can do nice
cross-references when needed, so I'm not sure that these numbers add
anything other than a bit of manual maintenance hassle.

Thanks,

jon

Re: [PATCH v1 1/1] Documentation: kvm: Fix a section number

[Xin Li]

On 4/14/2025 10:05 AM, Jonathan Corbet wrote:
>> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>   -------------------------------------
> The fix seems fine but ... I have to ask ... do the section numbers buy
> anything here?  We have a documentation system that can do nice
> cross-references when needed, so I'm not sure that these numbers add
> anything other than a bit of manual maintenance hassle.

So you prefer to get rid of the section numbering?

Looks it makes it simpler to maintain the documentation.  But that would
anyway be another serial patches, right?

Thanks!
     Xin

Re: [PATCH v1 1/1] Documentation: kvm: Fix a section number

[Jonathan Corbet]

Xin Li <xin@zytor.com> writes:

> On 4/14/2025 10:05 AM, Jonathan Corbet wrote:
>>> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>>   -------------------------------------
>> The fix seems fine but ... I have to ask ... do the section numbers buy
>> anything here?  We have a documentation system that can do nice
>> cross-references when needed, so I'm not sure that these numbers add
>> anything other than a bit of manual maintenance hassle.
>
> So you prefer to get rid of the section numbering?
>
> Looks it makes it simpler to maintain the documentation.  But that would
> anyway be another serial patches, right?

*I* would prefer it, but that call is really up to the KVM folks, not
me.  Their preference far outweighs mine on this ... I'm just venting :)

Thanks,

jon

Re: [PATCH v1 1/1] Documentation: kvm: Fix a section number

[Xin Li]

On 4/14/2025 10:48 AM, Jonathan Corbet wrote:
> Xin Li <xin@zytor.com> writes:
> 
>> On 4/14/2025 10:05 AM, Jonathan Corbet wrote:
>>>> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>>> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>>>    -------------------------------------
>>> The fix seems fine but ... I have to ask ... do the section numbers buy
>>> anything here?  We have a documentation system that can do nice
>>> cross-references when needed, so I'm not sure that these numbers add
>>> anything other than a bit of manual maintenance hassle.
>>
>> So you prefer to get rid of the section numbering?
>>
>> Looks it makes it simpler to maintain the documentation.  But that would
>> anyway be another serial patches, right?
> 
> *I* would prefer it, but that call is really up to the KVM folks, not
> me.  Their preference far outweighs mine on this ... I'm just venting :)

/facepalm

Re: [PATCH v1 1/1] Documentation: kvm: Fix a section number

[Xin Li]

On 4/14/2025 9:51 AM, Xin Li (Intel) wrote:
> The previous section is 7.41, thus this should be 7.42.
> 
> Signed-off-by: Xin Li (Intel) <xin@zytor.com>
> ---
>   Documentation/virt/kvm/api.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 47c7c3f92314..58478b470860 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -8478,7 +8478,7 @@ ENOSYS for the others.
>   When enabled, KVM will exit to userspace with KVM_EXIT_SYSTEM_EVENT of
>   type KVM_SYSTEM_EVENT_SUSPEND to process the guest suspend request.
>   
> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>   -------------------------------------
>   
>   :Architectures: arm64
> 
> base-commit: 8ffd015db85fea3e15a77027fda6c02ced4d2444

A gentle ping!